Merge #52203

52203: sql: improve SHOW TABLES to show row count r=rohany a=ekalinin

Fixes #48755

This change adds column `estimated_row_count` into result of the "SHOW TABLES"
to show estimated (not real) number of rows.

Besides that the body of the `delegator.delegateShowTables` was a bit
simplified (we do not need two almost similar versions of the query) and
new virtual table `crdb_internal.table_row_statistics` was added (to
show stats for non-root users).

Release note (sql change): This change modifies `SHOW TABLES` to return
estimates number of rows. New column's name is `estimated_row_count`.
Number of rows is taken from `system.table_statistics` table (via
`crdb_internal.table_row_statistics` which shows only tables accessible
for current user).

Co-authored-by: Eugene Kalinin <e.v.kalinin@gmail.com>

pkg/cli/zip_test.go

@@ -74,6 +74,7 @@ table_name NOT IN (
  'index_columns',
  'table_columns',
  'table_indexes',
+ 'table_row_statistics',
  'ranges',
  'ranges_no_leases',
  'predefined_comments',

pkg/server/admin.go

@@ -328,7 +328,7 @@ func (s *adminServer) DatabaseDetails(
  // Marshal table names.
  {
  scanner := makeResultScanner(cols)
- if a, e := len(cols), 3; a != e {
+ if a, e := len(cols), 4; a != e {
  return nil, s.serverErrorf("show tables columns mismatch: %d != expected %d", a, e)
  }
  for _, row := range rows {

pkg/sql/catalog/catconstants/constants.go

@@ -77,6 +77,7 @@ const (
  CrdbInternalTableColumnsTableID
  CrdbInternalTableIndexesTableID
  CrdbInternalTablesTableID
+ CrdbInternalTablesTableLastStatsID
  CrdbInternalTxnStatsTableID
  CrdbInternalZonesTableID
  InformationSchemaID

pkg/sql/crdb_internal.go

@@ -108,6 +108,7 @@ var crdbInternal = virtualSchema{
  catconstants.CrdbInternalStmtStatsTableID: crdbInternalStmtStatsTable,
  catconstants.CrdbInternalTableColumnsTableID: crdbInternalTableColumnsTable,
  catconstants.CrdbInternalTableIndexesTableID: crdbInternalTableIndexesTable,
+ catconstants.CrdbInternalTablesTableLastStatsID: crdbInternalTablesTableLastStats,
  catconstants.CrdbInternalTablesTableID: crdbInternalTablesTable,
  catconstants.CrdbInternalTxnStatsTableID: crdbInternalTxnStatsTable,
  catconstants.CrdbInternalZonesTableID: crdbInternalZonesTable,
@@ -340,6 +341,62 @@ CREATE TABLE crdb_internal.tables (
  },
 }
 
+var crdbInternalTablesTableLastStats = virtualSchemaTable{
+ comment: "the latest stats for all tables accessible by current user in current database (KV scan)",
+ schema: `
+CREATE TABLE crdb_internal.table_row_statistics (
+ table_id INT NOT NULL,
+ table_name STRING NOT NULL,
+ estimated_row_count INT
+)`,
+ populate: func(ctx context.Context, p *planner, db *sqlbase.ImmutableDatabaseDescriptor, addRow func(...tree.Datum) error) error {
+ // Collect the latests statistics for all tables.
+ query := `
+ SELECT s."tableID", max(s."rowCount")
+ FROM system.table_statistics AS s
+ JOIN (
+ SELECT "tableID", max("createdAt") AS last_dt
+ FROM system.table_statistics
+ GROUP BY "tableID"
+ ) AS l ON l."tableID" = s."tableID" AND l.last_dt = s."createdAt"
+ GROUP BY s."tableID"`
+ statRows, err := p.ExtendedEvalContext().ExecCfg.InternalExecutor.QueryEx(
+ ctx, "crdb-internal-statistics-table", p.txn,
+ sqlbase.InternalExecutorSessionDataOverride{User: security.RootUser},
+ query)
+ if err != nil {
+ return err
+ }
+
+ // Convert statistics into map: tableID -> rowCount.
+ statMap := make(map[tree.DInt]tree.Datum)
+ for _, r := range statRows {
+ statMap[tree.MustBeDInt(r[0])] = r[1]
+ }
+
+ // Walk over all available tables and show row count for each of them
+ // using collected statistics.
+ return forEachTableDescAll(ctx, p, db, virtualMany,
+ func(db *sqlbase.ImmutableDatabaseDescriptor, _ string, table *ImmutableTableDescriptor) error {
+ tableID := tree.DInt(table.ID)
+ rowCount := tree.DNull
+ // For Virtual Tables report NULL row count.
+ if !table.IsVirtualTable() {
+ rowCount = tree.NewDInt(0)
+ if cnt, ok := statMap[tableID]; ok {
+ rowCount = cnt
+ }
+ }
+ return addRow(
+ tree.NewDInt(tableID),
+ tree.NewDString(table.Name),
+ rowCount,
+ )
+ },
+ )
+ },
+}
+
 // TODO(tbg): prefix with kv_.
 var crdbInternalSchemaChangesTable = virtualSchemaTable{
  comment: `ongoing schema changes, across all descriptors accessible by current user (KV scan; expensive!)`,

pkg/sql/delegate/show_tables.go

@@ -43,53 +43,34 @@ func (d *delegator) delegateShowTables(n *tree.ShowTables) (tree.Statement, erro
  schemaClause = "AND ns.nspname NOT IN ('information_schema', 'pg_catalog', 'crdb_internal', 'pg_extension')"
  }
 
- var query string
- if n.WithComment {
- const getTablesQuery = `
-SELECT
- ns.nspname AS schema_name,
- pc.relname AS table_name,
- (CASE
- WHEN pc.relkind = 'v' THEN 'view'
- WHEN pc.relkind = 'S' THEN 'sequence'
- ELSE 'table'
- END) AS "type",
- COALESCE(pd.description, '') AS comment
- FROM %[1]s.pg_catalog.pg_class AS pc
- JOIN %[1]s.pg_catalog.pg_namespace AS ns ON (ns.oid = pc.relnamespace)
- LEFT JOIN %[1]s.pg_catalog.pg_description AS pd ON (pc.oid = pd.objoid AND pd.objsubid = 0)
-WHERE pc.relkind IN ('r', 'v', 'S') %[2]s
-ORDER BY schema_name, table_name
-`
-
- query = fmt.Sprintf(
- getTablesQuery,
- &name.CatalogName,
- schemaClause,
- )
-
- } else {
- const getTablesQuery = `
-SELECT
- ns.nspname AS schema_name,
- pc.relname AS table_name,
- (CASE
- WHEN pc.relkind = 'v' THEN 'view'
- WHEN pc.relkind = 'S' THEN 'sequence'
- ELSE 'table'
- END) AS "type"
- FROM %[1]s.pg_catalog.pg_class AS pc
- JOIN %[1]s.pg_catalog.pg_namespace AS ns ON (ns.oid = pc.relnamespace)
-WHERE pc.relkind IN ('r', 'v', 'S') %[2]s
-ORDER BY schema_name, table_name
+ const getTablesQuery = `
+SELECT ns.nspname AS schema_name,
+ pc.relname AS table_name,
+ CASE
+ WHEN pc.relkind = 'v' THEN 'view'
+ WHEN pc.relkind = 'S' THEN 'sequence'
+ ELSE 'table'
+ END AS type,
+ s.estimated_row_count AS estimated_row_count
+ %[3]s
+ FROM %[1]s.pg_catalog.pg_class AS pc
+ JOIN %[1]s.pg_catalog.pg_namespace AS ns ON (ns.oid = pc.relnamespace)
+ LEFT
+ JOIN %[1]s.pg_catalog.pg_description AS pd ON (pc.oid = pd.objoid AND pd.objsubid = 0)
+ LEFT
+ JOIN crdb_internal.table_row_statistics AS s on (s.table_id = pc.oid::INT8)
+ WHERE pc.relkind IN ('r', 'v', 'S') %[2]s
+ ORDER BY schema_name, table_name
 `
-
- query = fmt.Sprintf(
- getTablesQuery,
- &name.CatalogName,
- schemaClause,
- )
+ var comment string
+ if n.WithComment {
+ comment = `, COALESCE(pd.description, '') AS comment`
  }
-
+ query := fmt.Sprintf(
+ getTablesQuery,
+ &name.CatalogName,
+ schemaClause,
+ comment,
+ )
  return parse(query)
 }

pkg/sql/logictest/testdata/logic_test/alter_table_mixed_19.2_20.1

@@ -36,10 +36,10 @@ DROP TABLE t
 statement error schema change cannot be initiated in this version until the version upgrade is finalized
 TRUNCATE TABLE t
 
-query TTT
+query TTTI
 SHOW TABLES
 ----
-public t table
+public t table 0
 
 subtest columns
 
@@ -143,10 +143,10 @@ CREATE TABLE db.t (a INT)
 statement error schema change cannot be initiated in this version until the version upgrade is finalized
 DROP DATABASE db
 
-query TTT
+query TTTI
 SHOW TABLES FROM db
 ----
-public t table
+public t table NULL
 
 subtest non_backfill_schema_changes
 

pkg/sql/logictest/testdata/logic_test/crdb_internal

@@ -8,48 +8,49 @@ CREATE TABLE crdb_internal.t (x INT)
 query error database "crdb_internal" does not exist
 DROP DATABASE crdb_internal
 
-query TTT
+query TTTI
 SHOW TABLES FROM crdb_internal
 ----
-crdb_internal backward_dependencies table
-crdb_internal builtin_functions table
-crdb_internal cluster_queries table
-crdb_internal cluster_sessions table
-crdb_internal cluster_settings table
-crdb_internal cluster_transactions table
-crdb_internal create_statements table
-crdb_internal create_type_statements table
-crdb_internal databases table
-crdb_internal feature_usage table
-crdb_internal forward_dependencies table
-crdb_internal gossip_alerts table
-crdb_internal gossip_liveness table
-crdb_internal gossip_network table
-crdb_internal gossip_nodes table
-crdb_internal index_columns table
-crdb_internal jobs table
-crdb_internal kv_node_status table
-crdb_internal kv_store_status table
-crdb_internal leases table
-crdb_internal node_build_info table
-crdb_internal node_metrics table
-crdb_internal node_queries table
-crdb_internal node_runtime_info table
-crdb_internal node_sessions table
-crdb_internal node_statement_statistics table
-crdb_internal node_transactions table
-crdb_internal node_txn_stats table
-crdb_internal partitions table
-crdb_internal predefined_comments table
-crdb_internal ranges view
-crdb_internal ranges_no_leases table
-crdb_internal schema_changes table
-crdb_internal session_trace table
-crdb_internal session_variables table
-crdb_internal table_columns table
-crdb_internal table_indexes table
-crdb_internal tables table
-crdb_internal zones table
+crdb_internal backward_dependencies table NULL
+crdb_internal builtin_functions table NULL
+crdb_internal cluster_queries table NULL
+crdb_internal cluster_sessions table NULL
+crdb_internal cluster_settings table NULL
+crdb_internal cluster_transactions table NULL
+crdb_internal create_statements table NULL
+crdb_internal create_type_statements table NULL
+crdb_internal databases table NULL
+crdb_internal feature_usage table NULL
+crdb_internal forward_dependencies table NULL
+crdb_internal gossip_alerts table NULL
+crdb_internal gossip_liveness table NULL
+crdb_internal gossip_network table NULL
+crdb_internal gossip_nodes table NULL
+crdb_internal index_columns table NULL
+crdb_internal jobs table NULL
+crdb_internal kv_node_status table NULL
+crdb_internal kv_store_status table NULL
+crdb_internal leases table NULL
+crdb_internal node_build_info table NULL
+crdb_internal node_metrics table NULL
+crdb_internal node_queries table NULL
+crdb_internal node_runtime_info table NULL
+crdb_internal node_sessions table NULL
+crdb_internal node_statement_statistics table NULL
+crdb_internal node_transactions table NULL
+crdb_internal node_txn_stats table NULL
+crdb_internal partitions table NULL
+crdb_internal predefined_comments table NULL
+crdb_internal ranges view NULL
+crdb_internal ranges_no_leases table NULL
+crdb_internal schema_changes table NULL
+crdb_internal session_trace table NULL
+crdb_internal session_variables table NULL
+crdb_internal table_columns table NULL
+crdb_internal table_indexes table NULL
+crdb_internal table_row_statistics table NULL
+crdb_internal tables table NULL
+crdb_internal zones table NULL
 
 statement ok
 CREATE DATABASE testdb; CREATE TABLE testdb.foo(x INT)

pkg/sql/logictest/testdata/logic_test/drop_index

@@ -170,12 +170,12 @@ users foo true 2 id ASC false
 statement ok
 CREATE VIEW v2 AS SELECT name FROM v
 
-query TTT
+query TTTI
 SHOW TABLES
 ----
-public users table
-public v view
-public v2 view
+public users table 0
+public v view 0
+public v2 view 0 
 
 statement ok
 GRANT ALL ON users to testuser
@@ -199,10 +199,10 @@ SHOW INDEXES FROM users
 table_name index_name non_unique seq_in_index column_name direction storing implicit
 users primary false 1 id ASC false false
 
-query TTT
+query TTTI
 SHOW TABLES
 ----
-public users table
+public users table 0
 
 # Test the syntax without a '@'
 

pkg/sql/logictest/testdata/logic_test/drop_table

@@ -6,11 +6,11 @@ CREATE TABLE a (id INT PRIMARY KEY)
 statement ok
 CREATE TABLE b (id INT PRIMARY KEY)
 
-query TTT
+query TTTI
 SHOW TABLES FROM test
 ----
-public a table
-public b table
+public a table 0
+public b table 0
 
 statement ok
 INSERT INTO a VALUES (3),(7),(2)
@@ -35,10 +35,10 @@ SELECT job_type, status FROM [SHOW JOBS] WHERE job_type = 'SCHEMA CHANGE GC' OR
 SCHEMA CHANGE succeeded
 SCHEMA CHANGE GC running
 
-query TTT
+query TTTI
 SHOW TABLES FROM test
 ----
-public b table
+public b table 0
 
 statement error pgcode 42P01 relation "a" does not exist
 SELECT * FROM a