sql: add storage param for region column inference

This commit adds a new storage parameter to the table descriptor
`infer_rbr_region_col_using_constraint`. It will be used by following
commits/PRs to determine a foreign-key constraint that will be used
to look up values for the RBR region column from the FK parent table.

Informs #148243

Release note: None

Author: DrewKimball

pkg/cli/testdata/doctor/test_recreate_zipdir

@@ -14,5 +14,5 @@ SELECT crdb_internal.unsafe_upsert_namespace_entry(100, 0, 'public', 101, true);
 SELECT crdb_internal.unsafe_upsert_descriptor(102, decode('125a0a08706f73746772657310661a300a0b0a0561646d696e100218020a0d0a067075626c696310801018000a0a0a04726f6f74100218021204726f6f741803220028013a0c0a067075626c69631202086740004a005a0210007000', 'hex'), true);
 SELECT crdb_internal.unsafe_upsert_namespace_entry(0, 0, 'postgres', 102, true);
 SELECT crdb_internal.unsafe_upsert_descriptor(103, decode('2249086612067075626c6963186722310a0b0a0561646d696e100218020a0d0a067075626c696310840418000a0a0a04726f6f7410021802120561646d696e18032a00300140004a007000', 'hex'), true);
-SELECT crdb_internal.unsafe_upsert_descriptor(104, decode('0a87030a01741868206428013a0042280a016910011a0e0801104018002a0030005014600020013000680070007800800100880100980100423c0a05726f77696410021a0e0801104018002a0030005014600020002a0e756e697175655f726f77696428293001680070007800800100880100980100480352750a06745f706b6579100118012205726f7769642a0169300240004a10080010001a00200028003000380040005a0070017a0408002000800100880100900104980101a20106080012001800a80100b20100ba0100c00100c801d88aed86ddb7c5e517d00101e00100e9010000000000000000f2010060026a210a0b0a0561646d696e100218020a0a0a04726f6f74100218021204726f6f741803800101880103980100b2011b0a077072696d61727910001a01691a05726f776964200120022801b80101c20100e80100f2010408001200f801008002009202009a0200b20200b80200c00265c80200e00200800300880302a80300b00300d00300d80300e00300f80300880400980400a00400a80400', 'hex'), true);
+SELECT crdb_internal.unsafe_upsert_descriptor(104, decode('0a8a030a01741868206428013a0042280a016910011a0e0801104018002a0030005014600020013000680070007800800100880100980100423c0a05726f77696410021a0e0801104018002a0030005014600020002a0e756e697175655f726f77696428293001680070007800800100880100980100480352750a06745f706b6579100118012205726f7769642a0169300240004a10080010001a00200028003000380040005a0070017a0408002000800100880100900104980101a20106080012001800a80100b20100ba0100c00100c801d88aed86ddb7c5e517d00101e00100e9010000000000000000f2010060026a210a0b0a0561646d696e100218020a0a0a04726f6f74100218021204726f6f741803800101880103980100b2011b0a077072696d61727910001a01691a05726f776964200120022801b80101c20100e80100f2010408001200f801008002009202009a0200b20200b80200c00265c80200e00200800300880302a80300b00300d00300d80300e00300f80300880400980400a00400a80400b00400', 'hex'), true);
 COMMIT;

pkg/cli/testdata/doctor/test_recreate_zipdir-json

@@ -100,6 +100,10 @@ const (
 	// AutoFullStatsEnabledTableSettingName is the name of the automatic
 	// full stats collection enabled table setting.
 	AutoFullStatsEnabledTableSettingName = "sql_stats_automatic_full_collection_enabled"
+
+	// RBRUsingConstraintTableSettingName is the name of the REGIONAL BY ROW region
+	// column inference setting.
+	RBRUsingConstraintTableSettingName = "infer_rbr_region_col_using_constraint"
 )
 
 // AutoStatsCollectionEnabled indicates if automatic statistics collection is

pkg/sql/catalog/bootstrap/testdata/testdata

@@ -1369,7 +1369,12 @@ message TableDescriptor {
   // When forced is set the table's RLS policies are enforced even on the table owner.
   optional bool row_level_security_forced = 69 [(gogoproto.nullable) = false];
 
-  // Next ID: 70
+  // RBRUsingConstraint is the ID of the foreign-key constraint that is used to
+  // look up values for the region column of a REGIONAL BY ROW table.
+  optional uint32 rbr_using_constraint = 70 [(gogoproto.nullable) = false,
+    (gogoproto.customname) = "RBRUsingConstraint", (gogoproto.casttype) = "ConstraintID"];
+
+  // Next ID: 71
 }
 
 // ExternalRowData indicates that the row data for this object is stored outside

pkg/sql/catalog/catpb/catalog.go

@@ -789,6 +789,11 @@ type TableDescriptor interface {
 	// GetRegionalByRowTableRegionColumnName returns the region column name of a
 	// REGIONAL BY ROW table.
 	GetRegionalByRowTableRegionColumnName() (tree.Name, error)
+	// GetRegionalByRowUsingConstraint returns the ID of the foreign-key
+	// constraint that is used to determine the region for each row in a
+	// REGIONAL BY ROW table. It returns the zero value if the table is not RBR or
+	// no such constraint is set.
+	GetRegionalByRowUsingConstraint() descpb.ConstraintID
 	// GetRowLevelTTL returns the row-level TTL config for the table.
 	GetRowLevelTTL() *catpb.RowLevelTTL
 	// HasRowLevelTTL returns where there is a row-level TTL config for the table.
@@ -797,7 +802,7 @@ type TableDescriptor interface {
 	// to be excluded during backup.
 	GetExcludeDataFromBackup() bool
 	// GetStorageParams returns a list of storage parameters for the table.
-	GetStorageParams(spaceBetweenEqual bool) []string
+	GetStorageParams(spaceBetweenEqual bool) ([]string, error)
 	// NoAutoStatsSettingsOverrides is true if no auto stats related settings are
 	// set at the table level for the given table.
 	NoAutoStatsSettingsOverrides() bool

pkg/sql/catalog/descpb/structured.proto

@@ -2461,6 +2461,11 @@ func (desc *wrapper) GetRegionalByRowTableRegionColumnName() (tree.Name, error)
 	return tree.Name(*colName), nil
 }
 
+// GetRegionalByRowUsingConstraint implements the TableDescriptor interface.
+func (desc *wrapper) GetRegionalByRowUsingConstraint() descpb.ConstraintID {
+	return desc.RBRUsingConstraint
+}
+
 // GetRowLevelTTL implements the TableDescriptor interface.
 func (desc *wrapper) GetRowLevelTTL() *catpb.RowLevelTTL {
 	return desc.RowLevelTTL
@@ -2477,7 +2482,7 @@ func (desc *wrapper) GetExcludeDataFromBackup() bool {
 }
 
 // GetStorageParams implements the TableDescriptor interface.
-func (desc *wrapper) GetStorageParams(spaceBetweenEqual bool) []string {
+func (desc *wrapper) GetStorageParams(spaceBetweenEqual bool) ([]string, error) {
 	var storageParams []string
 	var spacing string
 	if spaceBetweenEqual {
@@ -2576,7 +2581,17 @@ func (desc *wrapper) GetStorageParams(spaceBetweenEqual bool) []string {
 	if desc.IsSchemaLocked() {
 		appendStorageParam(`schema_locked`, `true`)
 	}
-	return storageParams
+	if usingFK := desc.GetRegionalByRowUsingConstraint(); usingFK != descpb.ConstraintID(0) {
+		// NOTE: when validating the descriptor, we check that the referenced
+		// constraint exists, so this should never fail.
+		constraint, err := catalog.MustFindConstraintByID(desc, usingFK)
+		if err != nil {
+			return nil, err
+		}
+		appendStorageParam(catpb.RBRUsingConstraintTableSettingName,
+			fmt.Sprintf("%q", tree.Name(constraint.GetName())))
+	}
+	return storageParams, nil
 }
 
 // GetMultiRegionEnumDependency returns true if the given table has an "implicit"

pkg/sql/catalog/descriptor.go

@@ -147,6 +147,8 @@ var validationMap = []struct {
 			"NextPolicyID":            {status: iSolemnlySwearThisFieldIsValidated},
 			"RowLevelSecurityEnabled": {status: thisFieldReferencesNoObjects},
 			"RowLevelSecurityForced":  {status: thisFieldReferencesNoObjects},
+			"RBRUsingConstraint": {status: todoIAmKnowinglyAddingTechDebt,
+				reason: "TODO(drewk): remove this after adding validation in the next commit"},
 		},
 	},
 	{