NH-3158 - Use Dialect.Keywords for auto-quoting

- Dialect encapsulates Keywords
- Use case-insensitive HashSet for keywords
- AbstractDataBaseSchema and SybaseAnywhereColumnMetaData return case insensitive hash set (in fact, they can return an array/IEnumerable<string> instead of ISet<string>)
- SchemaMetadataUpdater just sets IsQuoted for table and column names, so it does not do unnecessary string operations
- Initialize SchemaUpdate once

Author: ngbrown

src/NHibernate.Test/Tools/hbm2ddl/SchemaMetadataUpdaterTest/HeavyEntity.cs

@@ -7,5 +7,6 @@ public class Order
 		public string And { get; set; }
 		public string Column { get; set; }
 		public string Name { get; set; }
+		public string Abracadabra { get; set; }
 	}
 }

src/NHibernate.Test/Tools/hbm2ddl/SchemaMetadataUpdaterTest/HeavyEntity.hbm.xml

@@ -13,6 +13,7 @@
 		<property name="And"/>
 		<property name="Column"/>
 		<property name="Name"/>
+		<property name="Abracadabra"/>
 	</class>
 
 </hibernate-mapping>

src/NHibernate.Test/Tools/hbm2ddl/SchemaMetadataUpdaterTest/SchemaMetadataUpdaterFixture.cs

@@ -1,10 +1,12 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using NHibernate.Cfg;
 using NHibernate.Engine;
 using NHibernate.Mapping;
 using NHibernate.Tool.hbm2ddl;
 using NUnit.Framework;
+using Environment = NHibernate.Cfg.Environment;
 
 namespace NHibernate.Test.Tools.hbm2ddl.SchemaMetadataUpdaterTest
 {
@@ -23,8 +25,8 @@ public void CanRetrieveReservedWords()
 				var metaData = dialect.GetDataBaseSchema(connectionHelper.Connection);
 				var reserved = metaData.GetReservedWords();
 				Assert.That(reserved, Is.Not.Empty);
-				Assert.That(reserved, Has.Member("SELECT"));
-				Assert.That(reserved, Has.Member("FROM"));
+				Assert.That(reserved, Has.Member("SELECT").IgnoreCase);
+				Assert.That(reserved, Has.Member("FROM").IgnoreCase);
 			}
 			finally
 			{
@@ -35,7 +37,7 @@ public void CanRetrieveReservedWords()
 		[Test]
 		public void UpdateReservedWordsInDialect()
 		{
-			var reservedDb = new HashSet<string>();
+			var reservedDb = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 			var configuration = TestConfigurationHelper.GetDefaultConfiguration();
 			var dialect = Dialect.Dialect.GetDialect(configuration.Properties);
 			var connectionHelper = new ManagedProviderConnectionHelper(configuration.Properties);
@@ -55,7 +57,7 @@ public void UpdateReservedWordsInDialect()
 
 			var sf = (ISessionFactoryImplementor) configuration.BuildSessionFactory();
 			SchemaMetadataUpdater.Update(sf);
-			var match = reservedDb.Intersect(sf.Dialect.Keywords);
+			var match = reservedDb.Intersect(sf.Dialect.Keywords, StringComparer.OrdinalIgnoreCase);
 			Assert.That(match, Is.EquivalentTo(reservedDb));
 		}
 
@@ -66,14 +68,19 @@ public void ExplicitAutoQuote()
 			configuration.AddResource("NHibernate.Test.Tools.hbm2ddl.SchemaMetadataUpdaterTest.HeavyEntity.hbm.xml",
 																GetType().Assembly);
 
-			SchemaMetadataUpdater.QuoteTableAndColumns(configuration);
+			var dialect = Dialect.Dialect.GetDialect(configuration.GetDerivedProperties());
+			dialect.Keywords.Add("Abracadabra");
+
+			SchemaMetadataUpdater.Update(configuration, dialect);
+			SchemaMetadataUpdater.QuoteTableAndColumns(configuration, dialect);
 
 			var cm = configuration.GetClassMapping(typeof(Order));
 			Assert.That(cm.Table.IsQuoted);
 			var culs = new List<Column>(cm.Table.ColumnIterator);
 			Assert.That(GetColumnByName(culs, "From").IsQuoted);
 			Assert.That(GetColumnByName(culs, "And").IsQuoted);
 			Assert.That(GetColumnByName(culs, "Select").IsQuoted);
+			Assert.That(GetColumnByName(culs, "Abracadabra").IsQuoted);
 			Assert.That(!GetColumnByName(culs, "Name").IsQuoted);
 		}
 
@@ -97,7 +104,7 @@ public void AutoQuoteTableAndColumnsAtStratup()
 		[Test]
 		public void AutoQuoteTableAndColumnsAtStratupIncludeKeyWordsImport()
 		{
-			var reservedDb = new HashSet<string>();
+			var reservedDb = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 			var configuration = TestConfigurationHelper.GetDefaultConfiguration();
 			var dialect = Dialect.Dialect.GetDialect(configuration.Properties);
 			var connectionHelper = new ManagedProviderConnectionHelper(configuration.Properties);
@@ -119,8 +126,8 @@ public void AutoQuoteTableAndColumnsAtStratupIncludeKeyWordsImport()
 			configuration.AddResource("NHibernate.Test.Tools.hbm2ddl.SchemaMetadataUpdaterTest.HeavyEntity.hbm.xml",
 																GetType().Assembly);
 			var sf = (ISessionFactoryImplementor)configuration.BuildSessionFactory();
-			var match = reservedDb.Intersect(sf.Dialect.Keywords);
-			Assert.That(match, Is.EquivalentTo(reservedDb));
+			var match = reservedDb.Intersect(sf.Dialect.Keywords, StringComparer.OrdinalIgnoreCase);
+			Assert.That(match, Is.EquivalentTo(reservedDb).IgnoreCase);
 		}
 
 		private static Column GetColumnByName(IEnumerable<Column> columns, string colName)
@@ -167,14 +174,19 @@ public void WhenConfiguredOnlyExplicitAutoQuote()
 			configuration.AddResource("NHibernate.Test.Tools.hbm2ddl.SchemaMetadataUpdaterTest.HeavyEntity.hbm.xml",
 																GetType().Assembly);
 
-			SchemaMetadataUpdater.QuoteTableAndColumns(configuration);
+			var dialect = Dialect.Dialect.GetDialect(configuration.GetDerivedProperties());
+			dialect.Keywords.Add("Abracadabra");
+
+			SchemaMetadataUpdater.Update(configuration, dialect);
+			SchemaMetadataUpdater.QuoteTableAndColumns(configuration, dialect);
 
 			var cm = configuration.GetClassMapping(typeof(Order));
 			Assert.That(cm.Table.IsQuoted);
 			var culs = new List<Column>(cm.Table.ColumnIterator);
 			Assert.That(GetColumnByName(culs, "From").IsQuoted);
 			Assert.That(GetColumnByName(culs, "And").IsQuoted);
 			Assert.That(GetColumnByName(culs, "Select").IsQuoted);
+			Assert.That(GetColumnByName(culs, "Abracadabra").IsQuoted);
 			Assert.That(!GetColumnByName(culs, "Name").IsQuoted);
 		}
 	}

src/NHibernate/Dialect/Dialect.cs

@@ -44,7 +44,6 @@ public abstract class Dialect
 		private readonly TypeNames _hibernateTypeNames = new TypeNames();
 		private readonly IDictionary<string, string> _properties = new Dictionary<string, string>();
 		private readonly IDictionary<string, ISQLFunction> _sqlFunctions;
-		private readonly HashSet<string> _sqlKeywords = new HashSet<string>();
 
 		private static readonly IDictionary<string, ISQLFunction> StandardAggregateFunctions = CollectionHelper.CreateCaseInsensitiveHashtable<ISQLFunction>();
 
@@ -81,7 +80,9 @@ protected Dialect()
 			Log.Info("Using dialect: " + this);
 
 			_sqlFunctions = CollectionHelper.CreateCaseInsensitiveHashtable(StandardAggregateFunctions);
-			
+
+			Keywords = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
+
 			// standard sql92 functions (can be overridden by subclasses)
 			RegisterFunction("substring", new AnsiSubstringFunction());
 			RegisterFunction("locate", new StandardSQLFunction("locate", NHibernateUtil.Int32));
@@ -2086,10 +2087,7 @@ public virtual IDictionary<string, ISQLFunction> Functions
 			get { return _sqlFunctions; }
 		}
 
-		public HashSet<string> Keywords
-		{
-			get { return _sqlKeywords; }
-		}
+		public HashSet<string> Keywords { get; }
 
 		/// <summary> 
 		/// Get the command used to select a GUID from the underlying database.
@@ -2246,6 +2244,21 @@ protected void RegisterKeyword(string word)
 			Keywords.Add(word);
 		}
 
+		protected internal void RegisterKeywords(params string[] keywords)
+		{
+			Keywords.UnionWith(keywords);
+		}
+
+		protected internal void RegisterKeywords(IEnumerable<string> keywords)
+		{
+			Keywords.UnionWith(keywords);
+		}
+
+		public bool IsKeyword(string str)
+		{
+			return Keywords.Contains(str);
+		}
+
 		protected void RegisterFunction(string name, ISQLFunction function)
 		{
 			_sqlFunctions[name] = function;
@@ -2281,4 +2294,4 @@ public virtual ISQLExceptionConverter BuildSQLExceptionConverter()
 			return new SQLStateConverter(ViolatedConstraintNameExtracter);
 		}
 	}
-}
+}

src/NHibernate/Dialect/Schema/AbstractDataBaseSchema.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Data;
 using System.Data.Common;
@@ -93,7 +94,7 @@ public virtual DataTable GetForeignKeys(string catalog, string schema, string ta
 
 		public virtual ISet<string> GetReservedWords()
 		{
-			var result = new HashSet<string>();
+			var result = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 			DataTable dtReservedWords = connection.GetSchema(DbMetaDataCollectionNames.ReservedWords);
 			foreach (DataRow row in dtReservedWords.Rows)
 			{
@@ -109,4 +110,4 @@ protected virtual string ForeignKeysSchemaName
 
 		#endregion
 	}
-}
+}

src/NHibernate/Dialect/Schema/SybaseAnywhereMetaData.cs

@@ -18,7 +18,7 @@ public override ITableMetadata GetTableMetadata(DataRow rs, bool extras)
 
 		public override ISet<string> GetReservedWords()
 		{
-			var result = new HashSet<string>();
+			var result = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 			DataTable dtReservedWords = Connection.GetSchema(DbMetaDataCollectionNames.ReservedWords);
 			foreach (DataRow row in dtReservedWords.Rows)
 			{
@@ -143,4 +143,4 @@ public SybaseAnywhereForeignKeyMetaData(DataRow rs) : base(rs)
 			Name = (string) rs["COLUMN_NAME"];
 		}
 	}
-}
+}

src/NHibernate/Impl/SessionFactoryImpl.cs

@@ -201,7 +201,7 @@ public SessionFactoryImpl(Configuration cfg, IMapping mapping, Settings settings
 				}
 				if (settings.IsAutoQuoteEnabled)
 				{
-					SchemaMetadataUpdater.QuoteTableAndColumns(cfg);
+					SchemaMetadataUpdater.QuoteTableAndColumns(cfg, Dialect);
 				}
 			}
 			catch (NotSupportedException)

src/NHibernate/SqlCommand/Template.cs

@@ -308,7 +308,7 @@ private static bool IsFunctionOrKeyword(string lcToken, string nextToken, Dialec
 			return "(".Equals(nextToken) ||
 			       Keywords.Contains(lcToken) ||
 			       functionRegistry.HasFunction(lcToken) ||
-			       dialect.Keywords.Contains(lcToken) ||
+			       dialect.IsKeyword(lcToken) ||
 				   dialect.IsKnownToken(lcToken, nextToken) ||
 			       FunctionKeywords.Contains(lcToken);
 		}
@@ -321,4 +321,4 @@ private static bool IsIdentifier(string token, Dialect.Dialect dialect)
 			                          );
 		}
 	}
-}
+}

src/NHibernate/Tool/hbm2ddl/SchemaExport.cs

@@ -56,14 +56,16 @@ private void Initialize()
 			{
 				return;
 			}
+			dialect = Dialect.Dialect.GetDialect(configProperties);
+
 			string autoKeyWordsImport = PropertiesHelper.GetString(Environment.Hbm2ddlKeyWords, configProperties, "not-defined");
 			autoKeyWordsImport = autoKeyWordsImport.ToLowerInvariant();
 			if (autoKeyWordsImport == Hbm2DDLKeyWords.AutoQuote)
 			{
-				SchemaMetadataUpdater.QuoteTableAndColumns(cfg);
+				SchemaMetadataUpdater.Update(cfg, dialect);
+				SchemaMetadataUpdater.QuoteTableAndColumns(cfg, dialect);
 			}
 
-			dialect = Dialect.Dialect.GetDialect(configProperties);
 			dropSQL = cfg.GenerateDropSchemaScript(dialect);
 			createSQL = cfg.GenerateSchemaCreationScript(dialect);
 			formatter = (PropertiesHelper.GetBoolean(Environment.FormatSql, configProperties, true) ? FormatStyle.Ddl : FormatStyle.None).Formatter;

src/NHibernate/Tool/hbm2ddl/SchemaMetadataUpdater.cs

@@ -1,3 +1,4 @@
+using System;
 using NHibernate.Cfg;
 using NHibernate.Engine;
 using NHibernate.Mapping;
@@ -8,71 +9,73 @@ namespace NHibernate.Tool.hbm2ddl
 	// Candidate to be exstensions of ISessionFactory and Configuration
 	public static class SchemaMetadataUpdater
 	{
-		public static void Update(ISessionFactory sessionFactory)
+		public static void Update(ISessionFactoryImplementor sessionFactory)
 		{
-			var factory = (ISessionFactoryImplementor) sessionFactory;
-			var dialect = factory.Dialect;
-			var connectionHelper = new SuppliedConnectionProviderConnectionHelper(factory.ConnectionProvider);
-			factory.Dialect.Keywords.UnionWith(GetReservedWords(dialect, connectionHelper));
+			UpdateDialectKeywords(
+				sessionFactory.Dialect,
+				new SuppliedConnectionProviderConnectionHelper(sessionFactory.ConnectionProvider));
 		}
 
-		public static void QuoteTableAndColumns(Configuration configuration)
+		public static void Update(Configuration configuration, Dialect.Dialect dialect)
 		{
-			ISet<string> reservedDb = GetReservedWords(configuration.GetDerivedProperties());
-			foreach (var cm in configuration.ClassMappings)
-			{
-				QuoteTable(cm.Table, reservedDb);
-			}
-			foreach (var cm in configuration.CollectionMappings)
-			{
-				QuoteTable(cm.Table, reservedDb);
-			}
+			UpdateDialectKeywords(
+				dialect,
+				new ManagedProviderConnectionHelper(configuration.GetDerivedProperties()));
 		}
 
-		private static ISet<string> GetReservedWords(IDictionary<string, string> cfgProperties)
+		static void UpdateDialectKeywords(Dialect.Dialect dialect, IConnectionHelper connectionHelper)
 		{
-			var dialect = Dialect.Dialect.GetDialect(cfgProperties);
-			var connectionHelper = new ManagedProviderConnectionHelper(cfgProperties);
-			return GetReservedWords(dialect, connectionHelper);
+			dialect.RegisterKeywords(GetReservedWords(dialect, connectionHelper));
 		}
 
-		private static ISet<string> GetReservedWords(Dialect.Dialect dialect, IConnectionHelper connectionHelper)
+		static IEnumerable<string> GetReservedWords(Dialect.Dialect dialect, IConnectionHelper connectionHelper)
 		{
-			ISet<string> reservedDb = new HashSet<string>();
 			connectionHelper.Prepare();
 			try
 			{
 				var metaData = dialect.GetDataBaseSchema(connectionHelper.Connection);
-				foreach (var rw in metaData.GetReservedWords())
-				{
-					reservedDb.Add(rw.ToLowerInvariant());
-				}
+				return metaData.GetReservedWords();
 			}
 			finally
 			{
 				connectionHelper.Release();
 			}
-			return reservedDb;
 		}
 
-		private static void QuoteTable(Table table, ICollection<string> reservedDb)
+		[Obsolete("Use the overload that passes dialect so keywords will be updated and persisted before auto-quoting")]
+		public static void QuoteTableAndColumns(Configuration configuration)
+		{
+			// Instantiates a new instance of the dialect so doesn't benefit from the Update call.
+			var dialect = Dialect.Dialect.GetDialect(configuration.GetDerivedProperties());
+			Update(configuration, dialect);
+			QuoteTableAndColumns(configuration, dialect);
+		}
+
+		public static void QuoteTableAndColumns(Configuration configuration, Dialect.Dialect dialect)
 		{
-			if (!table.IsQuoted && reservedDb.Contains(table.Name.ToLowerInvariant()))
+			foreach (var cm in configuration.ClassMappings)
 			{
-				table.Name = GetNhQuoted(table.Name);
+				QuoteTable(cm.Table, dialect);
 			}
-			foreach (var column in table.ColumnIterator)
+			foreach (var cm in configuration.CollectionMappings)
 			{
-				if (!column.IsQuoted && reservedDb.Contains(column.Name.ToLowerInvariant()))
-				{
-					column.Name = GetNhQuoted(column.Name);
-				}
+				QuoteTable(cm.Table, dialect);
 			}
 		}
 
-		private static string GetNhQuoted(string name)
+		private static void QuoteTable(Table table, Dialect.Dialect dialect)
 		{
-			return "`" + name + "`";
+			if (!table.IsQuoted && dialect.IsKeyword(table.Name))
+			{
+				table.IsQuoted = true;
+			}
+			foreach (var column in table.ColumnIterator)
+			{
+				if (!column.IsQuoted && dialect.IsKeyword(column.Name))
+				{
+					column.IsQuoted = true;
+				}
+			}
 		}
 	}
-}
+}