sql: add SHOW TRANSACTIONS

Release note (sql change): add the SHOW TRANSACTIONS statement, similar
to SHOW SESSIONS and variants. It shows the currently active
transactions in the node or cluster, and some information about them.

docs/generated/http/full.md

@@ -786,12 +786,11 @@ The underlying response type is something we're looking to get rid of.
 | application_name | [string](#cockroach.server.serverpb.ListSessionsResponse-string) |  | Application name specified by the client. |
 | active_queries | [ActiveQuery](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.ActiveQuery) | repeated | Queries in progress on this session. |
 | start | [google.protobuf.Timestamp](#cockroach.server.serverpb.ListSessionsResponse-google.protobuf.Timestamp) |  | Timestamp of session's start. |
-| kv_txn_id | [bytes](#cockroach.server.serverpb.ListSessionsResponse-bytes) |  | ID of the current KV transaction for this session. Nil if the session doesn't currently have a transaction. |
-| active_txn | [TxnInfo](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.TxnInfo) |  | Information about the txn in progress on this session. Nil if the session doesn't currently have a transaction. |
 | last_active_query | [string](#cockroach.server.serverpb.ListSessionsResponse-string) |  | SQL string of the last query executed on this session. |
 | id | [bytes](#cockroach.server.serverpb.ListSessionsResponse-bytes) |  | ID of the session (uint128 represented as raw bytes). |
 | alloc_bytes | [int64](#cockroach.server.serverpb.ListSessionsResponse-int64) |  | Number of currently allocated bytes in the session memory monitor. |
 | max_alloc_bytes | [int64](#cockroach.server.serverpb.ListSessionsResponse-int64) |  | High water mark of allocated bytes in the session memory monitor. |
+| active_txn | [TxnInfo](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.TxnInfo) |  | Information about the txn in progress on this session. Nil if the session doesn't currently have a transaction. |
 
 
 
@@ -822,6 +821,10 @@ The underlying response type is something we're looking to get rid of.
 | id | [bytes](#cockroach.server.serverpb.ListSessionsResponse-bytes) |  |  |
 | start | [google.protobuf.Timestamp](#cockroach.server.serverpb.ListSessionsResponse-google.protobuf.Timestamp) |  | The start timestamp of the transaction. |
 | txn_description | [string](#cockroach.server.serverpb.ListSessionsResponse-string) |  | txn_description is a text description of the underlying kv.Txn, intended for troubleshooting purposes. |
+| num_statements_executed | [int32](#cockroach.server.serverpb.ListSessionsResponse-int32) |  | num_statements_executed is the number of statements that were executed so far on this transaction. |
+| num_retries | [int32](#cockroach.server.serverpb.ListSessionsResponse-int32) |  | num_retries is the number of times that this transaction was retried. |
+| num_auto_retries | [int32](#cockroach.server.serverpb.ListSessionsResponse-int32) |  | num_retries is the number of times that this transaction was automatically retried by the SQL executor. |
+| deadline | [google.protobuf.Timestamp](#cockroach.server.serverpb.ListSessionsResponse-google.protobuf.Timestamp) |  | The deadline by which the transaction must be committed. |
 
 
 
@@ -887,12 +890,11 @@ The underlying response type is something we're looking to get rid of.
 | application_name | [string](#cockroach.server.serverpb.ListSessionsResponse-string) |  | Application name specified by the client. |
 | active_queries | [ActiveQuery](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.ActiveQuery) | repeated | Queries in progress on this session. |
 | start | [google.protobuf.Timestamp](#cockroach.server.serverpb.ListSessionsResponse-google.protobuf.Timestamp) |  | Timestamp of session's start. |
-| kv_txn_id | [bytes](#cockroach.server.serverpb.ListSessionsResponse-bytes) |  | ID of the current KV transaction for this session. Nil if the session doesn't currently have a transaction. |
-| active_txn | [TxnInfo](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.TxnInfo) |  | Information about the txn in progress on this session. Nil if the session doesn't currently have a transaction. |
 | last_active_query | [string](#cockroach.server.serverpb.ListSessionsResponse-string) |  | SQL string of the last query executed on this session. |
 | id | [bytes](#cockroach.server.serverpb.ListSessionsResponse-bytes) |  | ID of the session (uint128 represented as raw bytes). |
 | alloc_bytes | [int64](#cockroach.server.serverpb.ListSessionsResponse-int64) |  | Number of currently allocated bytes in the session memory monitor. |
 | max_alloc_bytes | [int64](#cockroach.server.serverpb.ListSessionsResponse-int64) |  | High water mark of allocated bytes in the session memory monitor. |
+| active_txn | [TxnInfo](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.TxnInfo) |  | Information about the txn in progress on this session. Nil if the session doesn't currently have a transaction. |
 
 
 
@@ -923,6 +925,10 @@ The underlying response type is something we're looking to get rid of.
 | id | [bytes](#cockroach.server.serverpb.ListSessionsResponse-bytes) |  |  |
 | start | [google.protobuf.Timestamp](#cockroach.server.serverpb.ListSessionsResponse-google.protobuf.Timestamp) |  | The start timestamp of the transaction. |
 | txn_description | [string](#cockroach.server.serverpb.ListSessionsResponse-string) |  | txn_description is a text description of the underlying kv.Txn, intended for troubleshooting purposes. |
+| num_statements_executed | [int32](#cockroach.server.serverpb.ListSessionsResponse-int32) |  | num_statements_executed is the number of statements that were executed so far on this transaction. |
+| num_retries | [int32](#cockroach.server.serverpb.ListSessionsResponse-int32) |  | num_retries is the number of times that this transaction was retried. |
+| num_auto_retries | [int32](#cockroach.server.serverpb.ListSessionsResponse-int32) |  | num_retries is the number of times that this transaction was automatically retried by the SQL executor. |
+| deadline | [google.protobuf.Timestamp](#cockroach.server.serverpb.ListSessionsResponse-google.protobuf.Timestamp) |  | The deadline by which the transaction must be committed. |
 
 
 

docs/generated/sql/bnf/show_var.bnf

@@ -23,5 +23,6 @@ show_stmt ::=
 	| show_stats_stmt
 	| show_tables_stmt
 	| show_trace_stmt
+	| show_transactions_stmt
 	| show_users_stmt
 	| show_zone_stmt

docs/generated/sql/bnf/stmt_block.bnf

@@ -205,6 +205,7 @@ show_stmt ::=
 	| show_stats_stmt
 	| show_tables_stmt
 	| show_trace_stmt
+	| show_transactions_stmt
 	| show_users_stmt
 	| show_zone_stmt
 
@@ -627,6 +628,10 @@ show_trace_stmt ::=
 	'SHOW' opt_compact 'TRACE' 'FOR' 'SESSION'
 	| 'SHOW' opt_compact 'KV' 'TRACE' 'FOR' 'SESSION'
 
+show_transactions_stmt ::=
+	'SHOW' opt_cluster 'TRANSACTIONS'
+	| 'SHOW' 'ALL' opt_cluster 'TRANSACTIONS'
+
 show_users_stmt ::=
 	'SHOW' 'USERS'
 
@@ -941,6 +946,7 @@ unreserved_keyword ::=
 	| 'TIES'
 	| 'TRACE'
 	| 'TRANSACTION'
+	| 'TRANSACTIONS'
 	| 'TRIGGER'
 	| 'TRUNCATE'
 	| 'TRUSTED'

pkg/sql/delegate/delegate.go

@@ -100,6 +100,9 @@ func TryDelegate(
 	case *tree.ShowTables:
 		return d.delegateShowTables(t)
 
+	case *tree.ShowTransactions:
+		return d.delegateShowTransactions(t)
+
 	case *tree.ShowUsers:
 		return d.delegateShowRoles()
 

pkg/sql/delegate/show_transactions.go

@@ -0,0 +1,41 @@
+// Copyright 2020 The Cockroach Authors.
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package delegate
+
+import (
+	"github.com/cockroachdb/cockroach/pkg/sql/catalog/catconstants"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
+)
+
+const _ = `
+  id UUID,                 -- the unique ID of the transaction
+  node_id INT,             -- the ID of the node running the transaction
+  session_id STRING,       -- the ID of the session
+  start TIMESTAMP,         -- the start time of the transaction
+  txn_string STRING,       -- the string representation of the transcation
+  application_name STRING, -- the name of the application as per SET application_name
+  num_stmts INT,           -- the number of statements executed so far
+  num_retries INT,         -- the number of times the transaction was restarted
+  num_auto_retries INT     -- the number of times the transaction was automatically restarted
+`
+
+func (d *delegator) delegateShowTransactions(n *tree.ShowTransactions) (tree.Statement, error) {
+	const query = `SELECT node_id, id, application_name, num_stmts, num_retries, num_auto_retries FROM `
+	table := `"".crdb_internal.node_transactions`
+	if n.Cluster {
+		table = `"".crdb_internal.cluster_transactions`
+	}
+	var filter string
+	if !n.All {
+		filter = " WHERE application_name NOT LIKE '" + catconstants.InternalAppNamePrefix + "%'"
+	}
+	return parse(query + table + filter)
+}

pkg/sql/parser/help_test.go

@@ -270,6 +270,9 @@ func TestContextualHelp(t *testing.T) {
 		{`SHOW SESSIONS ??`, `SHOW SESSIONS`},
 		{`SHOW LOCAL SESSIONS ??`, `SHOW SESSIONS`},
 
+		{`SHOW TRANSACTIONS ??`, `SHOW TRANSACTIONS`},
+		{`SHOW LOCAL TRANSACTIONS ??`, `SHOW TRANSACTIONS`},
+
 		{`SHOW STATISTICS ??`, `SHOW STATISTICS`},
 		{`SHOW STATISTICS FOR TABLE ??`, `SHOW STATISTICS`},
 

pkg/sql/parser/parse_test.go

@@ -2123,6 +2123,8 @@ $function$`,
 
 		{`SHOW SESSIONS`, `SHOW CLUSTER SESSIONS`},
 		{`SHOW ALL SESSIONS`, `SHOW ALL CLUSTER SESSIONS`},
+		{`SHOW TRANSACTIONS`, `SHOW CLUSTER TRANSACTIONS`},
+		{`SHOW ALL TRANSACTIONS`, `SHOW ALL CLUSTER TRANSACTIONS`},
 		{`SHOW QUERIES`, `SHOW CLUSTER QUERIES`},
 		{`SHOW ALL QUERIES`, `SHOW ALL CLUSTER QUERIES`},
 

pkg/sql/parser/sql.y

@@ -645,7 +645,8 @@ func (u *sqlSymUnion) executorType() tree.ScheduledJobExecutorType {
 %token <str> SYMMETRIC SYNTAX SYSTEM SQRT SUBSCRIPTION
 
 %token <str> TABLE TABLES TEMP TEMPLATE TEMPORARY TENANT TESTING_RELOCATE EXPERIMENTAL_RELOCATE TEXT THEN
-%token <str> TIES TIME TIMETZ TIMESTAMP TIMESTAMPTZ TO THROTTLING TRAILING TRACE TRANSACTION TREAT TRIGGER TRIM TRUE
+%token <str> TIES TIME TIMETZ TIMESTAMP TIMESTAMPTZ TO THROTTLING TRAILING TRACE
+%token <str> TRANSACTION TRANSACTIONS TREAT TRIGGER TRIM TRUE
 %token <str> TRUNCATE TRUSTED TYPE
 %token <str> TRACING
 
@@ -852,6 +853,7 @@ func (u *sqlSymUnion) executorType() tree.ScheduledJobExecutorType {
 %type <tree.Statement> show_tables_stmt
 %type <tree.Statement> show_trace_stmt
 %type <tree.Statement> show_transaction_stmt
+%type <tree.Statement> show_transactions_stmt
 %type <tree.Statement> show_users_stmt
 %type <tree.Statement> show_zone_stmt
 %type <tree.Statement> show_schedules_stmt
@@ -4078,6 +4080,7 @@ show_stmt:
 | show_tables_stmt          // EXTEND WITH HELP: SHOW TABLES
 | show_trace_stmt           // EXTEND WITH HELP: SHOW TRACE
 | show_transaction_stmt     // EXTEND WITH HELP: SHOW TRANSACTION
+| show_transactions_stmt    // EXTEND WITH HELP: SHOW TRANSACTIONS
 | show_users_stmt           // EXTEND WITH HELP: SHOW USERS
 | show_zone_stmt
 | SHOW error                // SHOW HELP: SHOW
@@ -4577,6 +4580,21 @@ show_tables_stmt:
   }
 | SHOW TABLES error // SHOW HELP: SHOW TABLES
 
+// %Help: SHOW TRANSACTIONS - list open client transactions
+// %Category: Misc
+// %Text: SHOW [ALL] [CLUSTER | LOCAL] TRANSACTIONS
+show_transactions_stmt:
+  SHOW opt_cluster TRANSACTIONS
+  {
+    $$.val = &tree.ShowTransactions{Cluster: $2.bool()}
+  }
+| SHOW opt_cluster TRANSACTIONS error // SHOW HELP: SHOW TRANSACTIONS
+| SHOW ALL opt_cluster TRANSACTIONS
+  {
+    $$.val = &tree.ShowTransactions{All: true, Cluster: $3.bool()}
+  }
+| SHOW ALL opt_cluster TRANSACTIONS error // SHOW HELP: SHOW TRANSACTIONS
+
 with_comment:
   WITH COMMENT { $$.val = true }
 | /* EMPTY */  { $$.val = false }
@@ -11235,6 +11253,7 @@ unreserved_keyword:
 | TIES
 | TRACE
 | TRANSACTION
+| TRANSACTIONS
 | TRIGGER
 | TRUNCATE
 | TRUSTED

pkg/sql/sem/tree/show.go

@@ -326,6 +326,25 @@ func (node *ShowTables) Format(ctx *FmtCtx) {
 	}
 }
 
+// ShowTransactions represents a SHOW TRANSACTIONS statement
+type ShowTransactions struct {
+	All     bool
+	Cluster bool
+}
+
+// Format implements the NodeFormatter interface.
+func (node *ShowTransactions) Format(ctx *FmtCtx) {
+	ctx.WriteString("SHOW ")
+	if node.All {
+		ctx.WriteString("ALL ")
+	}
+	if node.Cluster {
+		ctx.WriteString("CLUSTER TRANSACTIONS")
+	} else {
+		ctx.WriteString("LOCAL TRANSACTIONS")
+	}
+}
+
 // ShowConstraints represents a SHOW CONSTRAINTS statement.
 type ShowConstraints struct {
 	Table *UnresolvedObjectName

pkg/sql/sem/tree/stmt.go

@@ -919,6 +919,12 @@ func (*ShowTables) StatementType() StatementType { return Rows }
 // StatementTag returns a short string identifying the type of statement.
 func (*ShowTables) StatementTag() string { return "SHOW TABLES" }
 
+// StatementType implements the Statement interface
+func (*ShowTransactions) StatementType() StatementType { return Rows }
+
+// StatementTag returns a short string identifying the type of statement.
+func (*ShowTransactions) StatementTag() string { return "SHOW TRANSACTIONS" }
+
 // StatementType implements the Statement interface.
 func (*ShowSchemas) StatementType() StatementType { return Rows }
 
@@ -1084,6 +1090,7 @@ func (n *ShowTableStats) String() string                 { return AsString(n) }
 func (n *ShowTables) String() string                     { return AsString(n) }
 func (n *ShowTraceForSession) String() string            { return AsString(n) }
 func (n *ShowTransactionStatus) String() string          { return AsString(n) }
+func (n *ShowTransactions) String() string               { return AsString(n) }
 func (n *ShowLastQueryStatistics) String() string        { return AsString(n) }
 func (n *ShowUsers) String() string                      { return AsString(n) }
 func (n *ShowVar) String() string                        { return AsString(n) }