sql: internal tables for cross db refs and interleaved indexes/tables

Fixes: #58867

Previously, users had no way of determining which objects in
their database utilized either deprecated features like
interleaved indexes/tables or cross DB references. This was
inadequate since users need to know which object utilize
this functionality. To address this, this patch introduces
the crdb_internal tables: cross_db_references, interleaved,

Release justification: Low risk internal tables for detecting
deprecated features.
Release note (sql change): Added crdb_internal tables cross_db_references
and interleaved for detecting the deprecated features cross db
references and interleaved tables / indexes.

pkg/cli/zip_test.go

@@ -68,9 +68,11 @@ table_name NOT IN (
 	'builtin_functions',
 	'create_statements',
 	'create_type_statements',
+	'cross_db_references',
 	'databases',
 	'forward_dependencies',
 	'index_columns',
+	'interleaved_indexes',
 	'table_columns',
 	'table_indexes',
 	'table_row_statistics',

pkg/sql/catalog/catconstants/constants.go

@@ -79,6 +79,8 @@ const (
 	CrdbInternalZonesTableID
 	CrdbInternalInvalidDescriptorsTableID
 	CrdbInternalClusterDatabasePrivilegesTableID
+	CrdbInternalInterleaved
+	CrdbInternalCrossDbRefrences
 	InformationSchemaID
 	InformationSchemaAdministrableRoleAuthorizationsID
 	InformationSchemaApplicableRolesID

pkg/sql/crdb_internal.go

@@ -132,6 +132,8 @@ var crdbInternal = virtualSchema{
 		catconstants.CrdbInternalZonesTableID:                     crdbInternalZonesTable,
 		catconstants.CrdbInternalInvalidDescriptorsTableID:        crdbInternalInvalidDescriptorsTable,
 		catconstants.CrdbInternalClusterDatabasePrivilegesTableID: crdbInternalClusterDatabasePrivilegesTable,
+		catconstants.CrdbInternalInterleaved:                      crdbInternalInterleaved,
+		catconstants.CrdbInternalCrossDbRefrences:                 crdbInternalCrossDbReferences,
 	},
 	validWithNoDatabaseContext: true,
 }
@@ -4024,3 +4026,234 @@ CREATE TABLE crdb_internal.cluster_database_privileges (
 			})
 	},
 }
+
+var crdbInternalInterleaved = virtualSchemaTable{
+	comment: `virtual table with interleaved table information`,
+	schema: `
+CREATE TABLE crdb_internal.interleaved (
+	database_name
+		STRING NOT NULL,
+	schema_name
+		STRING NOT NULL,
+	table_name
+		STRING NOT NULL,
+	index_name
+		STRING NOT NULL,
+	parent_index
+		STRING NOT NULL
+);`,
+	populate: func(ctx context.Context, p *planner, dbContext *dbdesc.Immutable, addRow func(...tree.Datum) error) error {
+		return forEachTableDescAllWithTableLookup(ctx, p, dbContext, hideVirtual,
+			func(db *dbdesc.Immutable, schemaName string, table catalog.TableDescriptor, lookupFn tableLookupFn) error {
+				if !table.IsInterleaved() {
+					return nil
+				}
+				indexes := table.NonDropIndexes()
+				for _, index := range indexes {
+					if index.NumInterleaveAncestors() == 0 {
+						continue
+					}
+
+					ancestor := index.GetInterleaveAncestor(index.NumInterleaveAncestors() - 1)
+					parentTable, err := lookupFn.getTableByID(ancestor.TableID)
+					if err != nil {
+						return err
+					}
+					parentIndex, err := parentTable.FindIndexWithID(ancestor.IndexID)
+					if err != nil {
+						return err
+					}
+					parentSchemaName := ""
+					if parentTable.GetParentSchemaID() == keys.PublicSchemaID {
+						parentSchemaName = tree.PublicSchema
+					} else {
+						schema, err := lookupFn.getSchemaByID(parentTable.GetParentSchemaID())
+						if err != nil {
+							return err
+						}
+						parentSchemaName = schema.GetName()
+					}
+					database, err := lookupFn.getDatabaseByID(parentTable.GetParentID())
+					if err != nil {
+						return err
+					}
+
+					if err := addRow(tree.NewDString(database.GetName()),
+						tree.NewDString(parentSchemaName),
+						tree.NewDString(table.GetName()),
+						tree.NewDString(index.GetName()),
+						tree.NewDString(parentIndex.GetName())); err != nil {
+						return err
+					}
+				}
+				return nil
+			})
+	},
+}
+
+var crdbInternalCrossDbReferences = virtualSchemaTable{
+	comment: `virtual table with cross db references`,
+	schema: `
+CREATE TABLE crdb_internal.cross_db_references (
+	object_database
+		STRING NOT NULL,
+	object_schema
+		STRING NOT NULL,
+	object_name
+		STRING NOT NULL,
+	referenced_object_database
+		STRING NOT NULL,
+	referenced_object_schema
+		STRING NOT NULL,
+	referenced_object_name
+		STRING NOT NULL,
+	cross_database_reference_description
+		STRING NOT NULL
+);`,
+	populate: func(ctx context.Context, p *planner, dbContext *dbdesc.Immutable, addRow func(...tree.Datum) error) error {
+		return forEachTableDescAllWithTableLookup(ctx, p, dbContext, hideVirtual,
+			func(db *dbdesc.Immutable, schemaName string, table catalog.TableDescriptor, lookupFn tableLookupFn) error {
+				// For tables detect if foreign key references point at a different
+				// database. Additionally, check if any of the columns have sequence
+				// references to a different database.
+				if table.IsTable() {
+					objectDatabaseName := lookupFn.getParentName(table)
+					err := table.ForeachOutboundFK(
+						func(fk *descpb.ForeignKeyConstraint) error {
+							referencedTable, err := lookupFn.getTableByID(fk.ReferencedTableID)
+							if err != nil {
+								return err
+							}
+							if referencedTable.GetParentID() != table.GetParentID() {
+								refSchemaName := ""
+								if referencedTable.GetParentSchemaID() == keys.PublicSchemaID {
+									refSchemaName = tree.PublicSchema
+								} else {
+									schema, err := lookupFn.getSchemaByID(referencedTable.GetParentSchemaID())
+									if err != nil {
+										return err
+									}
+									refSchemaName = schema.GetName()
+								}
+								refDatabaseName := lookupFn.getParentName(referencedTable)
+
+								if err := addRow(tree.NewDString(objectDatabaseName),
+									tree.NewDString(schemaName),
+									tree.NewDString(table.GetName()),
+									tree.NewDString(refDatabaseName),
+									tree.NewDString(refSchemaName),
+									tree.NewDString(referencedTable.GetName()),
+									tree.NewDString("table foreign key reference")); err != nil {
+									return err
+								}
+							}
+							return nil
+						})
+					if err != nil {
+						return err
+					}
+
+					// Check for sequence dependencies
+					for _, col := range table.PublicColumns() {
+						for i := 0; i < col.NumUsesSequences(); i++ {
+							sequenceID := col.GetUsesSequenceID(i)
+							seqDesc, err := lookupFn.getTableByID(sequenceID)
+							if err != nil {
+								return err
+							}
+							if seqDesc.GetParentID() != table.GetParentID() {
+								seqSchemaName := ""
+								if seqDesc.GetParentSchemaID() == keys.PublicSchemaID {
+									seqSchemaName = tree.PublicSchema
+								} else {
+									schema, err := lookupFn.getSchemaByID(seqDesc.GetParentSchemaID())
+									if err != nil {
+										return err
+									}
+									seqSchemaName = schema.GetName()
+								}
+								refDatabaseName := lookupFn.getParentName(seqDesc)
+								if err := addRow(tree.NewDString(objectDatabaseName),
+									tree.NewDString(schemaName),
+									tree.NewDString(table.GetName()),
+									tree.NewDString(refDatabaseName),
+									tree.NewDString(seqSchemaName),
+									tree.NewDString(seqDesc.GetName()),
+									tree.NewDString("table column refers to sequence")); err != nil {
+									return err
+								}
+							}
+						}
+					}
+				} else if table.IsView() {
+					// For views check if we depend on tables in a different database.
+					dependsOn := table.GetDependsOn()
+					for _, dependency := range dependsOn {
+						dependentTable, err := lookupFn.getTableByID(dependency)
+						if err != nil {
+							return err
+						}
+						if dependentTable.GetParentID() != table.GetParentID() {
+							objectDatabaseName := lookupFn.getParentName(table)
+							refSchemaName := ""
+							if dependentTable.GetParentSchemaID() == keys.PublicSchemaID {
+								refSchemaName = tree.PublicSchema
+							} else {
+								schema, err := lookupFn.getSchemaByID(dependentTable.GetParentSchemaID())
+								if err != nil {
+									return err
+								}
+								refSchemaName = schema.GetName()
+							}
+							refDatabaseName := lookupFn.getParentName(dependentTable)
+
+							if err := addRow(tree.NewDString(objectDatabaseName),
+								tree.NewDString(schemaName),
+								tree.NewDString(table.GetName()),
+								tree.NewDString(refDatabaseName),
+								tree.NewDString(refSchemaName),
+								tree.NewDString(dependentTable.GetName()),
+								tree.NewDString("view references table")); err != nil {
+								return err
+							}
+						}
+					}
+				} else if table.IsSequence() {
+					// For sequences check if the sequence is owned by
+					// a different database.
+					sequenceOpts := table.GetSequenceOpts()
+					if sequenceOpts.SequenceOwner.OwnerTableID != descpb.InvalidID {
+						ownerTable, err := lookupFn.getTableByID(sequenceOpts.SequenceOwner.OwnerTableID)
+						if err != nil {
+							return err
+						}
+						if ownerTable.GetParentID() != table.GetParentID() {
+							objectDatabaseName := lookupFn.getParentName(table)
+							refSchemaName := ""
+							if ownerTable.GetParentSchemaID() == keys.PublicSchemaID {
+								refSchemaName = tree.PublicSchema
+							} else {
+								schema, err := lookupFn.getSchemaByID(ownerTable.GetParentSchemaID())
+								if err != nil {
+									return err
+								}
+								refSchemaName = schema.GetName()
+							}
+							refDatabaseName := lookupFn.getParentName(ownerTable)
+
+							if err := addRow(tree.NewDString(objectDatabaseName),
+								tree.NewDString(schemaName),
+								tree.NewDString(table.GetName()),
+								tree.NewDString(refDatabaseName),
+								tree.NewDString(refSchemaName),
+								tree.NewDString(ownerTable.GetName()),
+								tree.NewDString("sequences owning table")); err != nil {
+								return err
+							}
+						}
+					}
+				}
+				return nil
+			})
+	},
+}

pkg/sql/logictest/testdata/logic_test/crdb_internal

@@ -24,6 +24,7 @@ crdb_internal  cluster_settings             table  NULL  NULL  NULL
 crdb_internal  cluster_transactions         table  NULL  NULL  NULL
 crdb_internal  create_statements            table  NULL  NULL  NULL
 crdb_internal  create_type_statements       table  NULL  NULL  NULL
+crdb_internal  cross_db_references          table  NULL  NULL  NULL
 crdb_internal  databases                    table  NULL  NULL  NULL
 crdb_internal  feature_usage                table  NULL  NULL  NULL
 crdb_internal  forward_dependencies         table  NULL  NULL  NULL
@@ -32,6 +33,7 @@ crdb_internal  gossip_liveness              table  NULL  NULL  NULL
 crdb_internal  gossip_network               table  NULL  NULL  NULL
 crdb_internal  gossip_nodes                 table  NULL  NULL  NULL
 crdb_internal  index_columns                table  NULL  NULL  NULL
+crdb_internal  interleaved_indexes          table  NULL  NULL  NULL
 crdb_internal  invalid_objects              table  NULL  NULL  NULL
 crdb_internal  jobs                         table  NULL  NULL  NULL
 crdb_internal  kv_node_status               table  NULL  NULL  NULL

pkg/sql/logictest/testdata/logic_test/crdb_internal_tenant

@@ -36,6 +36,7 @@ crdb_internal  cluster_settings             table  NULL  NULL  NULL
 crdb_internal  cluster_transactions         table  NULL  NULL  NULL
 crdb_internal  create_statements            table  NULL  NULL  NULL
 crdb_internal  create_type_statements       table  NULL  NULL  NULL
+crdb_internal  cross_db_references          table  NULL  NULL  NULL
 crdb_internal  databases                    table  NULL  NULL  NULL
 crdb_internal  feature_usage                table  NULL  NULL  NULL
 crdb_internal  forward_dependencies         table  NULL  NULL  NULL
@@ -44,6 +45,7 @@ crdb_internal  gossip_liveness              table  NULL  NULL  NULL
 crdb_internal  gossip_network               table  NULL  NULL  NULL
 crdb_internal  gossip_nodes                 table  NULL  NULL  NULL
 crdb_internal  index_columns                table  NULL  NULL  NULL
+crdb_internal  interleaved_indexes          table  NULL  NULL  NULL
 crdb_internal  invalid_objects              table  NULL  NULL  NULL
 crdb_internal  jobs                         table  NULL  NULL  NULL
 crdb_internal  kv_node_status               table  NULL  NULL  NULL

pkg/sql/logictest/testdata/logic_test/create_statements

@@ -230,6 +230,23 @@ CREATE TABLE crdb_internal.create_type_statements (
    enum_members STRING[] NULL,
    INDEX create_type_statements_descriptor_id_idx (descriptor_id ASC) STORING (database_id, database_name, schema_name, descriptor_name, create_statement, enum_members)
 )  {}  {}
+CREATE TABLE crdb_internal.cross_db_references (
+   object_database STRING NOT NULL,
+   object_schema STRING NOT NULL,
+   object_name STRING NOT NULL,
+   referenced_object_database STRING NOT NULL,
+   referenced_object_schema STRING NOT NULL,
+   referenced_object_name STRING NOT NULL,
+   cross_database_reference_description STRING NOT NULL
+)  CREATE TABLE crdb_internal.cross_db_references (
+   object_database STRING NOT NULL,
+   object_schema STRING NOT NULL,
+   object_name STRING NOT NULL,
+   referenced_object_database STRING NOT NULL,
+   referenced_object_schema STRING NOT NULL,
+   referenced_object_name STRING NOT NULL,
+   cross_database_reference_description STRING NOT NULL
+)  {}  {}
 CREATE TABLE crdb_internal.databases (
    id INT8 NOT NULL,
    name STRING NOT NULL,
@@ -364,6 +381,19 @@ CREATE TABLE crdb_internal.index_columns (
    column_direction STRING NULL,
    implicit BOOL NULL
 )  {}  {}
+CREATE TABLE crdb_internal.interleaved (
+database_name STRING NOT NULL,
+schema_name STRING NOT NULL,
+table_name STRING NOT NULL,
+index_name STRING NOT NULL,
+parent_index STRING NOT NULL
+)  CREATE TABLE crdb_internal.interleaved (
+database_name STRING NOT NULL,
+schema_name STRING NOT NULL,
+table_name STRING NOT NULL,
+index_name STRING NOT NULL,
+parent_index STRING NOT NULL
+)  {}  {}
 CREATE TABLE crdb_internal.invalid_objects (
    id INT8 NULL,
    database_name STRING NULL,

pkg/sql/logictest/testdata/logic_test/fk

@@ -3633,6 +3633,15 @@ USE db2
 statement ok
 CREATE TABLE child2 (c INT PRIMARY KEY, p INT REFERENCES db1.public.parent(p))
 
+
+# Validate that cross DB foreign keys are detected by internal tables
+query TTTTTTT
+select * from "".crdb_internal.cross_db_references;
+----
+db2  public  child   db1  public  parent  table foreign key reference
+db2  public  child2  db1  public  parent  table foreign key reference
+
+
 # Test that foreign keys cannot reference columns that are indexed by a partial
 # unique index or a partial unique constraint. Partial unique indexes and
 # constraints do not guarantee uniqueness in the entire table.

pkg/sql/logictest/testdata/logic_test/grant_table

@@ -36,6 +36,7 @@ test           crdb_internal       cluster_settings                           pu
 test           crdb_internal       cluster_transactions                       public   SELECT
 test           crdb_internal       create_statements                          public   SELECT
 test           crdb_internal       create_type_statements                     public   SELECT
+test           crdb_internal       cross_db_references                        public   SELECT
 test           crdb_internal       databases                                  public   SELECT
 test           crdb_internal       feature_usage                              public   SELECT
 test           crdb_internal       forward_dependencies                       public   SELECT
@@ -44,6 +45,7 @@ test           crdb_internal       gossip_liveness                            pu
 test           crdb_internal       gossip_network                             public   SELECT
 test           crdb_internal       gossip_nodes                               public   SELECT
 test           crdb_internal       index_columns                              public   SELECT
+test           crdb_internal       interleaved_indexes                        public   SELECT
 test           crdb_internal       invalid_objects                            public   SELECT
 test           crdb_internal       jobs                                       public   SELECT
 test           crdb_internal       kv_node_status                             public   SELECT