Skip to content

Fix | Build ReservedWords table in code #4328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edwardneal wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Fix | Build ReservedWords table in code #4328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9904c10
Add skeleton to create the ReservedWords table
edwardneal May 28, 2026
2548f25
Batch 1
edwardneal May 29, 2026
b498de0
Batch 2
edwardneal May 29, 2026
b55abf1
Batch 3
edwardneal May 29, 2026
d52c025
Batch 4
edwardneal May 29, 2026
e0d8c0f
Batch 5
edwardneal May 30, 2026
3245b69
Batch 6
edwardneal May 30, 2026
5dd317d
Batch 7
edwardneal May 30, 2026
0a0b28e
Batch 8
edwardneal May 30, 2026
55ae41c
Batch 9
edwardneal May 30, 2026
ff26091
Batch 10
edwardneal May 30, 2026
38993d6
Batch 11
edwardneal May 30, 2026
52c8a20
Add verification test
edwardneal May 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
177 changes: 177 additions & 0 deletions ...Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlMetaDataFactory.ReservedWords.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Data;
using System.Data.Common;

#nullable enable

namespace Microsoft.Data.SqlClient;

internal sealed partial class SqlMetaDataFactory
{
/// <summary>
/// Adds reserved words to the indicated metadata DataSet.
/// </summary>
/// <param name="metaDataCollectionsDataSet">The metadata DataSet to contain the reserved words.</param>
/// <remarks>
/// These reserved words are defined by the server, and vary depending upon the version
/// and edition.
/// </remarks>
/// <see href="https://learn.microsoft.com/en-us/sql/t-sql/language-elements/reserved-keywords-transact-sql" />
private static void LoadReservedWordsDataTables(DataSet metaDataCollectionsDataSet)
{
DataTable reservedWordsDataTable = CreateReservedWordsDataTable();

reservedWordsDataTable.BeginLoadData();

// @TODO: These have been ported from the existing XML resource file, but they don't perfectly
// align with the referenced link. These need to be reviewed, and if it's correct to add
// the new keywords then they need to indicate which version of SQL Server introduced them.
// @TODO: Azure Synapse Analytics also has an extra reserved keyword. This isn't included at
// the moment, but if we choose to do so then we need a way to identify such. Doing so may
// be non-trivial, depending upon whether we query SERVERPROPERTY('EngineEdition') or use a
// similar approach to ADP.IsAzureSynapseOnDemandEndpoint (i.e. check the data source string.)

// Add reserved keywords used by SQL Server and Azure Synapse Analytics.
AddReservedWords(minVersion: null, maxVersion: null,
"ADD", "ALL", "ALTER", "AND", "ANY", "AS", "ASC", "AUTHORIZATION", "BACKUP",
"BEGIN", "BETWEEN", "BREAK", "BROWSE", "BULK", "BY", "CASCADE", "CASE", "CHECK",
"CHECKPOINT", "CLOSE", "CLUSTERED", "COALESCE", "COLLATE", "COLUMN", "COMMIT", "COMPUTE", "CONSTRAINT",
"CONTAINS", "CONTAINSTABLE", "CONTINUE", "CONVERT", "CREATE", "CROSS", "CURRENT", "CURRENT_DATE", "CURRENT_TIME",
"CURRENT_TIMESTAMP", "CURRENT_USER", "CURSOR", "DATABASE", "DBCC", "DEALLOCATE", "DECLARE", "DEFAULT", "DELETE",
"DENY", "DESC", "DISK", "DISTINCT", "DISTRIBUTED", "DOUBLE", "DROP", "DUMP", "ELSE",
"END", "ERRLVL", "ESCAPE", "EXCEPT", "EXEC", "EXECUTE", "EXISTS", "EXIT", "EXTERNAL",
"FETCH", "FILE", "FILLFACTOR", "FOR", "FOREIGN", "FREETEXT", "FREETEXTTABLE", "FROM", "FULL",
"FUNCTION", "GOTO", "GRANT", "GROUP", "HAVING", "HOLDLOCK", "IDENTITY", "IDENTITY_INSERT", "IDENTITYCOL",
"IF", "IN", "INDEX", "INNER", "INSERT", "INTERSECT", "INTO", "IS", "JOIN",
// @TODO: Missing keyword: MERGE
"KEY", "KILL", "LEFT", "LIKE", "LINENO", "LOAD", /* "MERGE", */ "NATIONAL", "NOCHECK",
"NONCLUSTERED", "NOT", "NULL", "NULLIF", "OF", "OFF", "OFFSETS", "ON", "OPEN",
"OPENDATASOURCE", "OPENQUERY", "OPENROWSET", "OPENXML", "OPTION", "OR", "ORDER", "OUTER", "OVER",
// @TODO: Missing keyword: PIVOT
"PERCENT", /* "PIVOT", */ "PLAN", "PRECISION", "PRIMARY", "PRINT", "PROC", "PROCEDURE", "PUBLIC",
"RAISERROR", "READ", "READTEXT", "RECONFIGURE", "REFERENCES", "REPLICATION", "RESTORE", "RESTRICT", "RETURN",
// @TODO: Missing keyword: REVERT
/* "REVERT", */ "REVOKE", "RIGHT", "ROLLBACK", "ROWCOUNT", "ROWGUIDCOL", "RULE", "SAVE", "SCHEMA",
// @TODO: Missing keywords: SECURITYAUDIT, SEMANTICKEYPHRASETABLE, SEMANTICSIMILARITYDETAILSTABLE
/* "SECURITYAUDIT", */ "SELECT", /* "SEMANTICKEYPHRASETABLE", "SEMANTICSIMILARITYDETAILSTABLE", */
// @TODO: Missing keyword: SEMANTICSIMILARITYTABLE
/* "SEMANTICSIMILARITYTABLE", */ "SESSION_USER", "SET", "SETUSER", "SHUTDOWN",
// @TODO: Missing keyword: TABLESAMPLE
"SOME", "STATISTICS", "SYSTEM_USER", "TABLE", /* "TABLESAMPLE", */ "TEXTSIZE", "THEN", "TO", "TOP",
// @TODO: Missing keywords: TRY_CONVERT, UNPIVOT
"TRAN", "TRANSACTION", "TRIGGER", "TRUNCATE", /* "TRY_CONVERT", */ "TSEQUAL", "UNION", "UNIQUE", /* "UNPIVOT", */
"UPDATE", "UPDATETEXT", "USE", "USER", "VALUES", "VARYING", "VIEW", "WAITFOR", "WHEN",
// @TODO: Missing keyword: WITHIN GROUP
"WHERE", "WHILE", "WITH", /* "WITHIN GROUP", */ "WRITETEXT");

// Add ODBC reserved keywords. Some of these overlap with the previous category, and are not included.
AddReservedWords(minVersion: null, maxVersion: null,
"ABSOLUTE", "ACTION", "ADA", "ALLOCATE", "ARE", "ASSERTION", "AT", "AVG", "BIT",
"BIT_LENGTH", "BOTH", "CASCADED", "CAST", "CATALOG", "CHAR", "CHAR_LENGTH", "CHARACTER", "CHARACTER_LENGTH",
"COLLATION", "CONNECT", "CONNECTION", "CONSTRAINTS", "CORRESPONDING", "COUNT", "DATE", "DAY", "DECIMAL",
"DEFERRABLE", "DEFERRED", "DESCRIBE", "DESCRIPTOR", "DIAGNOSTICS", "DISCONNECT", "DOMAIN", "END-EXEC", "EXCEPTION",
"EXTRACT", "FALSE", "FIRST", "FLOAT", "FORTRAN", "FOUND", "GET", "GLOBAL", "GO",
"HOUR", "IMMEDIATE", "INCLUDE", "INDICATOR", "INITIALLY", "INPUT", "INSENSITIVE", "INT", "INTEGER",
"INTERVAL", "ISOLATION", "LANGUAGE", "LAST", "LEADING", "LEVEL", "LOCAL", "LOWER", "MATCH",
"MAX", "MIN", "MINUTE", "MODULE", "MONTH", "NAMES", "NATURAL", "NCHAR", "NEXT",
"NO", "NONE", "NUMERIC", "OCTET_LENGTH", "ONLY", "OUTPUT", "OVERLAPS", "PAD", "PASCAL",
"POSITION", "PREPARE", "PRESERVE", "PRIOR", "PRIVILEGES", "REAL", "RELATIVE", "ROWS", "SCROLL",
"SECOND", "SECTION", "SESSION", "SIZE", "SMALLINT", "SPACE", "SQL", "SQLCA", "SQLCODE",
"SQLERROR", "SQLSTATE", "SQLWARNING", "SUBSTRING", "SUM", "TEMPORARY", "TIME", "TIMESTAMP", "TIMEZONE_HOUR",
"TIMEZONE_MINUTE", "TRAILING", "TRANSLATE", "TRANSLATION", "TRIM", "TRUE", "UNKNOWN", "UPPER", "USAGE",
"USING", "VALUE", "VARCHAR", "WHENEVER", "WORK", "WRITE", "YEAR", "ZONE");

// Add future reserved keywords.
AddReservedWords(minVersion: null, maxVersion: null,
// @TODO: Missing keywords: ASENSITIVE, ASYMMETRIC, ATOMIC
"ADMIN", "AFTER", "AGGREGATE", "ALIAS", "ARRAY", /* "ASENSITIVE", "ASYMMETRIC", "ATOMIC", */ "BEFORE",
// @TODO: Missing keyword: CALLED, CARDINALITY
"BINARY", "BLOB", "BOOLEAN", "BREADTH", "CALL", /* "CALLED", "CARDINALITY", */ "CLASS", "CLOB",
// @TODO: Missing keywords: COLLECT, CONDITION, CORR, COVAR_POP, COVAR_SAMP, CUME_DIST
/* "COLLECT", */ "COMPLETION", /* "CONDITION", */ "CONSTRUCTOR", /* "CORR", "COVAR_POP", "COVAR_SAMP", */ "CUBE", /* "CUME_DIST", */
// @TODO: Missing keywords: CURRENT_CATALOG, CURRENT_DEFAULT_TRANSFORM_GROUP
/* "CURRENT_CATALOG", "CURRENT_DEFAULT_TRANSFORM_GROUP", */ "CURRENT_PATH", "CURRENT_ROLE",
// @TODO: Missing keywords: CURRENT_SCHEMA, CURRENT_TRANSFORM_GROUP_FOR_TYPE
/* "CURRENT_SCHEMA", "CURRENT_TRANSFORM_GROUP_FOR_TYPE", */ "CYCLE", "DATA", "DEC",
// @TODO: Missing keyword: ELEMENT
"DEPTH", "DEREF", "DESTROY", "DESTRUCTOR", "DETERMINISTIC", "DICTIONARY", "DYNAMIC", "EACH", /* "ELEMENT", */
// @TODO: Missing keywords: FILTER, FULLTEXTTABLE, FUSION, HOLD
"EQUALS", "EVERY", /* "FILTER", */ "FREE", /* "FULLTEXTTABLE", "FUSION", */ "GENERAL", "GROUPING", /* "HOLD", */
// @TODO: Missing keyword: INTERSECTION
"HOST", "IGNORE", "INITIALIZE", "INOUT", /* "INTERSECTION", */ "ITERATE", "LARGE", "LATERAL", "LESS",
// @TODO: Missing keywords: LIKE_REGEX, LN, MEMBER, METHOD
/* "LIKE_REGEX",*/ "LIMIT", /* "LN", */ "LOCALTIME", "LOCALTIMESTAMP", "LOCATOR", "MAP", /* "MEMBER", "METHOD", */
// @TODO: Missing keywords: MOD, MULTISET, NORMALIZE, OCCURRENCES_REGEX
/* "MOD", */ "MODIFIES", "MODIFY", /* "MULTISET", */ "NCLOB", "NEW", /* "NORMALIZE", */ "OBJECT", /* "OCCURRENCES_REGEX", */
// @TODO: Missing keyword: OVERLAY, PARTITION
"OLD", "OPERATION", "ORDINALITY", "OUT", /* "OVERLAY", */ "PARAMETER", "PARAMETERS", "PARTIAL", /* "PARTITION" */
// @TODO: Missing keywords: PERCENT_RANK, PERCENTILE_CONT, PERCENTILE_DISC, POSITION_REGEX, RANGE
"PATH", "POSTFIX", "PREFIX", "PREORDER", /* "PERCENT_RANK", "PERCENTILE_CONT", "PERCENTILE_DISC", "POSITION_REGEX", "RANGE", */
"READS", "RECURSIVE", "REF", "REFERENCING",
// @TODO: Missing keywords: REGR_AVGX, REGR_AVGY, REGR_COUNT, REGR_INTERCEPT, REGR_R2, REGR_SLOPE
/* "REGR_AVGX", "REGR_AVGY", "REGR_COUNT", "REGR_INTERCEPT", "REGR_R2", "REGR_SLOPE", */
// @TODO: Missing keywords: REGR_SXX, REGR_SXY, REGR_SYY, RELEASE
/* "REGR_SXX", "REGR_SXY", "REGR_SYY", "RELEASE", */ "RESULT", "RETURNS", "ROLE", "ROLLUP", "ROUTINE",
// @TODO: Missing keywords: SENSITIVE, SIMILAR
"ROW", "SAVEPOINT", "SCOPE", "SEARCH", /* "SENSITIVE", */ "SEQUENCE", "SETS", /* "SIMILAR", */ "SPECIFIC",
// @TODO: Missing keywords: STDDEV_POP, STDDEV_SAMP
"SPECIFICTYPE", "SQLEXCEPTION", "START", "STATE", "STATEMENT", "STATIC", /* "STDDEV_POP", "STDDEV_SAMP", */ "STRUCTURE",

// @TODO: Missing keywords: SUBMULTISET, SUBSTRING_REGEX, SYMMETRIC, SYSTEM, TRANSLATE_REGEX, UESCAPE
/* "SUBMULTISET", "SUBSTRING_REGEX", "SYMMETRIC", "SYSTEM", */ "TERMINATE", "THAN", /* "TRANSLATE_REGEX", */ "TREAT", /* "UESCAPE", */
// @TODO: Missing keywords: VAR_POP, VAR_SAMP, WIDTH_BUCKET, WINDOW, WITHIN
"UNDER", "UNNEST", /* "VAR_POP", "VAR_SAMP", */ "VARIABLE", /* "WIDTH_BUCKET", */ "WITHOUT" /* , "WINDOW", "WITHIN", */
// @TODO: Missing keywords: XMLAGG, XMLATTRIBUTES, XMLBINARY, XMLCAST, XMLCOMMENT, XMLCONCAT, XMLDOCUMENT, XMLELEMENT, XMLEXISTS
/* "XMLAGG", "XMLATTRIBUTES", "XMLBINARY", "XMLCAST", "XMLCOMMENT", "XMLCONCAT", "XMLDOCUMENT", "XMLELEMENT", "XMLEXISTS", */
// @TODO: Missing keywords: XMLFOREST, XMLITERATE, XMLNAMESPACES, XMLPARSE, XMLPI, XMLQUERY, XMLSERIALIZE, XMLTABLE, XMLTEXT
/* "XMLFOREST", "XMLITERATE", "XMLNAMESPACES", "XMLPARSE", "XMLPI", "XMLQUERY", "XMLSERIALIZE", "XMLTABLE", "XMLTEXT", */
// @TODO: Missing keyword: XMLVALIDATE
/* "XMLVALIDATE" */);

// Keywords which appear in the SQL Server 2000 documentation but not in newer versions.
// Preserved for backwards compatibility purposes.
AddReservedWords(minVersion: null, maxVersion: null, "DUMMY");

reservedWordsDataTable.EndLoadData();
reservedWordsDataTable.AcceptChanges();

metaDataCollectionsDataSet.Tables.Add(reservedWordsDataTable);

void AddReservedWords(string? minVersion, string? maxVersion, params ReadOnlySpan<string> reservedWords)
{
foreach (string reservedWord in reservedWords)
{
DataRow wordRow = reservedWordsDataTable.NewRow();

wordRow[DbMetaDataColumnNames.ReservedWord] = reservedWord;

if (minVersion is not null)
{
wordRow[MinimumVersionKey] = minVersion;
}

if (maxVersion is not null)
{
wordRow[MaximumVersionKey] = maxVersion;
}

reservedWordsDataTable.Rows.Add(wordRow);
}
}
}

private static DataTable CreateReservedWordsDataTable()
=> new(DbMetaDataCollectionNames.ReservedWords)
{
Columns =
{
new DataColumn(DbMetaDataColumnNames.ReservedWord, typeof(string)),
new DataColumn(MinimumVersionKey, typeof(string)),
new DataColumn(MaximumVersionKey, typeof(string))
}
};
}
15 changes: 1 addition & 14 deletions src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlMetaDataFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,6 +715,7 @@ private DataSet LoadDataSetFromXml(Stream XmlStream)
};

LoadDataTypesDataTables(metaDataCollectionsDataSet);
LoadReservedWordsDataTables(metaDataCollectionsDataSet);

XmlReaderSettings settings = new()
{
Expand Down Expand Up @@ -765,9 +766,6 @@ private DataSet LoadDataSetFromXml(Stream XmlStream)
dataTable = CreateDataSourceInformationDataTable();
rowFixup = FixUpDataSourceInformationRow;
break;
case "ReservedWordsTable":
dataTable = CreateReservedWordsDataTable();
break;
default:
Debug.Fail($"Unexpected table element name: {reader.Name}");
break;
Expand Down Expand Up @@ -897,17 +895,6 @@ private static DataTable CreateDataSourceInformationDataTable()
new DataColumn(DbMetaDataColumnNames.SupportedJoinOperators, typeof(SupportedJoinOperators))
}
};

private static DataTable CreateReservedWordsDataTable()
=> new(DbMetaDataCollectionNames.ReservedWords)
{
Columns =
{
new DataColumn(DbMetaDataColumnNames.ReservedWord, typeof(string)),
new DataColumn(MinimumVersionKey, typeof(string)),
new DataColumn(MaximumVersionKey, typeof(string))
}
};
#endregion
}
}
Loading
Loading