Generate Restrictions schema.

Signed-off-by: Bradley Grainger <[email protected]>

Author: bgrainger

docs/content/overview/schema-collections.md

@@ -35,6 +35,7 @@ weight: 80
 * `ReferentialConstraints`
 * `ReservedWords`—[information about reserved words in the server's SQL syntax](../schema/reservedwords/)
 * `ResourceGroups`
+* `Restrictions`—[information about the restrictions supported when retrieving schemas](../schema/restrictions/)
 * `SchemaPrivileges`
 * `Tables`
 * `TableConstraints`

docs/content/overview/schema/restrictions.md

@@ -0,0 +1,17 @@
+---
+date: 2022-07-10
+lastmod: 2022-07-11
+title: Restrictions Schema
+---
+
+# Restrictions Schema
+
+The `Restrictions` schema provides information about the restrictions supported when retrieving schemas.
+
+Column Name | Data Type
+--- | ---
+CollectionName | string
+RestrictionName | string
+RestrictionDefault | string
+RestrictionNumber | int
+

src/MySqlConnector/Core/SchemaProvider.g.cs

@@ -53,6 +53,8 @@ public async ValueTask<DataTable> GetSchemaAsync(IOBehavior ioBehavior, string c
 			await FillReservedWordsAsync(ioBehavior, dataTable, restrictionValues, cancellationToken).ConfigureAwait(false);
 		else if (string.Equals(collectionName, "ResourceGroups", StringComparison.OrdinalIgnoreCase))
 			await FillResourceGroupsAsync(ioBehavior, dataTable, restrictionValues, cancellationToken).ConfigureAwait(false);
+		else if (string.Equals(collectionName, "Restrictions", StringComparison.OrdinalIgnoreCase))
+			await FillRestrictionsAsync(ioBehavior, dataTable, restrictionValues, cancellationToken).ConfigureAwait(false);
 		else if (string.Equals(collectionName, "SchemaPrivileges", StringComparison.OrdinalIgnoreCase))
 			await FillSchemaPrivilegesAsync(ioBehavior, dataTable, restrictionValues, cancellationToken).ConfigureAwait(false);
 		else if (string.Equals(collectionName, "Tables", StringComparison.OrdinalIgnoreCase))
@@ -107,6 +109,7 @@ private Task FillMetaDataCollectionsAsync(IOBehavior ioBehavior, DataTable dataT
 		dataTable.Rows.Add("ReferentialConstraints", 0, 0);
 		dataTable.Rows.Add("ReservedWords", 0, 0);
 		dataTable.Rows.Add("ResourceGroups", 0, 0);
+		dataTable.Rows.Add("Restrictions", 0, 0);
 		dataTable.Rows.Add("SchemaPrivileges", 0, 0);
 		dataTable.Rows.Add("Tables", 0, 0);
 		dataTable.Rows.Add("TableConstraints", 0, 0);
@@ -579,6 +582,27 @@ private async Task FillResourceGroupsAsync(IOBehavior ioBehavior, DataTable data
 		await FillDataTableAsync(ioBehavior, dataTable, "RESOURCE_GROUPS", null, cancellationToken).ConfigureAwait(false);
 	}
 
+	private Task FillRestrictionsAsync(IOBehavior ioBehavior, DataTable dataTable, string?[]? restrictionValues, CancellationToken cancellationToken)
+	{
+		if (restrictionValues is not null)
+			throw new ArgumentException("restrictionValues is not supported for schema 'Restrictions'.", nameof(restrictionValues));
+
+		dataTable.Columns.AddRange(new DataColumn[]
+		{
+			new("CollectionName", typeof(string)),
+			new("RestrictionName", typeof(string)),
+			new("RestrictionDefault", typeof(string)),
+			new("RestrictionNumber", typeof(int)),
+		});
+
+		dataTable.Rows.Add("Columns", "Catalog", "TABLE_CATALOG", 1);
+		dataTable.Rows.Add("Columns", "Schema", "TABLE_SCHEMA", 2);
+		dataTable.Rows.Add("Columns", "Table", "TABLE_NAME", 3);
+		dataTable.Rows.Add("Columns", "Column", "COLUMN_NAME", 4);
+
+		return Utility.CompletedTask;
+	}
+
 	private async Task FillSchemaPrivilegesAsync(IOBehavior ioBehavior, DataTable dataTable, string?[]? restrictionValues, CancellationToken cancellationToken)
 	{
 		if (restrictionValues is not null)

tests/SideBySide/SchemaProviderTests.cs

@@ -84,6 +84,25 @@ public void ColumnsRestriction()
 		Assert.Equal("Bit32", table.Rows[0]["COLUMN_NAME"]);
 	}
 
+	[Fact]
+	public void SchemaRestrictionCount()
+	{
+		var metadata = m_database.Connection.GetSchema("MetaDataCollections");
+		var restrictions = m_database.Connection.GetSchema("Restrictions");
+		foreach (DataRow row in metadata.Rows)
+		{
+			var schema = (string) row["CollectionName"];
+#if BASELINE
+			if (schema is "Views" or "ViewColumns" or "Triggers")
+				continue;
+#endif
+
+			var restrictionCount = (int) row["NumberOfRestrictions"];
+			var actualCount = restrictions.Rows.Cast<DataRow>().Count(x => (string) x["CollectionName"] == schema);
+			Assert.Equal(restrictionCount, actualCount);
+		}
+	}
+
 #if !BASELINE
 	[Fact]
 	public void ExcessColumnsRestriction() =>

tools/SchemaCollectionGenerator/SchemaCollectionGenerator.cs

@@ -108,6 +108,20 @@ public async ValueTask<DataTable> GetSchemaAsync(IOBehavior ioBehavior, string c
 ");
 		}
 	}
+	else if (schema.Name == "Restrictions")
+	{
+		foreach (var schemaCollection in schemaCollections)
+		{
+			if (schemaCollection.Restrictions is { Count: > 0 })
+			{
+				for (var i = 0; i < schemaCollection.Restrictions.Count; i++)
+				{
+					var restriction = schemaCollection.Restrictions[i];
+					codeWriter.WriteLine($@"		dataTable.Rows.Add(""{schemaCollection.Name}"", ""{restriction.Name}"", ""{restriction.Default}"", {i + 1});");
+				}
+			}
+		}
+	}
 	else
 	{
 		codeWriter.Write(@$"		{schema.Custom}(dataTable);

tools/SchemaCollectionGenerator/SchemaCollections.yaml

@@ -525,6 +525,18 @@
   - name: THREAD_PRIORITY
     type: int
 
+- name: Restrictions
+  description: information about the restrictions supported when retrieving schemas
+  columns:
+  - name: CollectionName
+    type: string
+  - name: RestrictionName
+    type: string
+  - name: RestrictionDefault
+    type: string
+  - name: RestrictionNumber
+    type: int
+
 - name: SchemaPrivileges
   table: SCHEMA_PRIVILEGES
   columns: