sql: add a SHOW TENANTS command

This command prints all available tenants and their status. To get the status for replication (c2c) tenants we need to get the job info. For example: ``` [email protected]:26257/defaultdb> show tenants; id | name | status -----+----------+---------------------------------------------------------------------- 1 | system | ACTIVE 2 | src | ACTIVE 3 | dest | REPLICATION PAUSED 4 | dest2 | REPLICATION UNKNOWN (succeeded) 6 | dest3 | REPLICATION UNKNOWN (job with ID 819888096954253313 does not exist) 11 | dest4 | ACTIVE 12 | dest5 | REPLICATING 13 | dest6 | INITIALIZING REPLICATION (13 rows) Time: 67ms total (execution 67ms / network 0ms) ``` Fixes: #92641 Epic: CRDB-18749 Release note: None
cockroachdb · Jan 7, 2023 · 62c6e2b · 62c6e2b
1 parent 1c7122f
commit 62c6e2b
Show file tree

Hide file tree

Showing 9 changed files with 163 additions and 77 deletions.
diff --git a/docs/generated/sql/bnf/show_tenant_stmt.bnf b/docs/generated/sql/bnf/show_tenant_stmt.bnf
@@ -1,3 +1,4 @@
 show_tenant_stmt ::=
-	'SHOW' 'TENANT' d_expr
+	'SHOW' 'TENANTS'
+	| 'SHOW' 'TENANT' d_expr
 	| 'SHOW' 'TENANT' d_expr 'WITH' 'REPLICATION' 'STATUS'
diff --git a/docs/generated/sql/bnf/stmt_block.bnf b/docs/generated/sql/bnf/stmt_block.bnf
@@ -921,7 +921,8 @@ show_tables_stmt ::=
 	| 'SHOW' 'TABLES' with_comment
 
 show_tenant_stmt ::=
-	'SHOW' 'TENANT' d_expr
+	'SHOW' 'TENANTS'
+	| 'SHOW' 'TENANT' d_expr
 	| 'SHOW' 'TENANT' d_expr 'WITH' 'REPLICATION' 'STATUS'
 
 show_trace_stmt ::=
@@ -1380,6 +1381,7 @@ unreserved_keyword ::=
 	| 'TEMPLATE'
 	| 'TEMPORARY'
 	| 'TENANT'
+	| 'TENANTS'
 	| 'TESTING_RELOCATE'
 	| 'TEXT'
 	| 'TIES'

diff --git a/pkg/ccl/streamingccl/streamingest/alter_replication_job.go b/pkg/ccl/streamingccl/streamingest/alter_replication_job.go
@@ -161,7 +161,7 @@ func alterReplicationJobHook(
 			return err
 		}
 		if tenInfo.TenantReplicationJobID == 0 {
-			return errors.Newf("tenant %q does not have an active replication job", tenantName)
+			return errors.Newf("tenant %q is not a replicated tenant", tenantName)
 		}
 		jobRegistry := p.ExecCfg().JobRegistry
 		if alterTenantStmt.Cutover != nil {

diff --git a/pkg/ccl/streamingccl/streamingest/alter_replication_job_test.go b/pkg/ccl/streamingccl/streamingest/alter_replication_job_test.go
@@ -66,9 +66,9 @@ func TestAlterTenantPauseResume(t *testing.T) {
 
 	t.Run("pause-resume-tenant-with-no-replication", func(t *testing.T) {
 		c.DestSysSQL.Exec(t, `CREATE TENANT noreplication`)
-		c.DestSysSQL.ExpectErr(t, "tenant \"noreplication\" does not have an active replication job",
+		c.DestSysSQL.ExpectErr(t, `tenant "noreplication" is not a replicated tenant`,
 			`ALTER TENANT $1 PAUSE REPLICATION`, "noreplication")
-		c.DestSysSQL.ExpectErr(t, "tenant \"noreplication\" does not have an active replication job",
+		c.DestSysSQL.ExpectErr(t, `tenant "noreplication" is not a replicated tenant`,
 			`ALTER TENANT $1 RESUME REPLICATION`, "noreplication")
 	})
 

diff --git a/pkg/sql/logictest/testdata/logic_test/tenant b/pkg/sql/logictest/testdata/logic_test/tenant
@@ -76,10 +76,10 @@ id  name   status
 statement error tenant "seven" does not exist
 SHOW TENANT seven
 
-statement error tenant "tenant-one" does not have an active replication job
+query error pq: tenant "tenant-one" is not a replicated tenant
 SHOW TENANT "tenant-one" WITH REPLICATION STATUS
 
-statement error tenant "two" does not have an active replication job
+query error pq: tenant "two" is not a replicated tenant
 SHOW TENANT two WITH REPLICATION STATUS
 
 # Test creating a tenant with the same name as an existing tenant, but a unique

diff --git a/pkg/sql/parser/sql.y b/pkg/sql/parser/sql.y
@@ -5537,13 +5537,20 @@ backup_kms:
 
 // %Help: SHOW TENANT - display tenant information
 // %Category: Misc
-// %Text: SHOW TENANT <tenant_name> [WITH REPLICATION STATUS]
+// %Text:
+// SHOW TENANT <tenant_name> [WITH REPLICATION STATUS]
+// SHOW TENANTS
 show_tenant_stmt:
-  SHOW TENANT d_expr
+  SHOW TENANTS
+  {
+   $$.val = &tree.ShowTenant{
+     All: true,
+   }
+  }
+| SHOW TENANT d_expr
   {
    $$.val = &tree.ShowTenant{
      Name: $3.expr(),
-     WithReplication: false,
    }
   }
 | SHOW TENANT d_expr WITH REPLICATION STATUS
@@ -16003,6 +16010,7 @@ unreserved_keyword:
 | TEMPLATE
 | TEMPORARY
 | TENANT
+| TENANTS
 | TESTING_RELOCATE
 | TEXT
 | TIES

diff --git a/pkg/sql/sem/tree/show.go b/pkg/sql/sem/tree/show.go
@@ -864,10 +864,16 @@ func (node *ShowTableStats) Format(ctx *FmtCtx) {
 type ShowTenant struct {
 	Name            Expr
 	WithReplication bool
+	All             bool
 }
 
 // Format implements the NodeFormatter interface.
 func (node *ShowTenant) Format(ctx *FmtCtx) {
+	if node.All {
+		ctx.WriteString("SHOW TENANTS")
+		return
+	}
+
 	ctx.WriteString("SHOW TENANT ")
 	ctx.FormatNode(node.Name)