Merge branch 'FirebirdSQL:master' into fix-issue-1234

Author: fdcastel

CONTRIBUTING.md

@@ -2,16 +2,16 @@
 
 Thanks for considering contributing. Here are some items to consider before starting (in no particular order).
 
-* Check [tracker](https://github.com/FirebirdSQL/NETProvider/issues) if you want to start on something.
-* Before you start working on something announce your intention on the mailing list (or in comment in tracker).
+* Check [issues](https://github.com/FirebirdSQL/NETProvider/issues) if you want to start on something.
+* Before you start working on something announce your intention on the mailing list (or comment on the issue).
 * Issue only complete PRs (no WIPs).
 * Make sure your PR doesn't contain unneccessary changes (whitespaces, new lines, ...).
-* Consider squashing your commits.
 * Follow existing code formatting/styling (even for new files).
+* Disclose AI usage.
 * Make sure you swept all corners (i.e. all build configurations are fine, works with all Firebird version, etc.).
 * Make sure your changes merge without conflicts.
 * Consider backward compatibility.
 * Don't be afraid to ask (i.e. backward compatibility).
 * Be prepared to do some changes after your PR is reviewed.
 * Consider whether your change is benefit for majority of users (opposite to only a small group).
-* All contributions are licensed under [_Initial Developer's Public License_](license.txt).
+* All contributions are licensed under [_Initial Developer's Public License_](license.txt).

src/FirebirdSql.Data.TestsBase/FbTestsSetup.cs

@@ -111,7 +111,7 @@ private static async Task CreateTables(FbConnection connection, Version serverVe
 		commandText.Append("VARRAY_FIELD	 VARCHAR(30) [1:4],");
 		commandText.Append("BIG_ARRAY		 INTEGER [1:32767],");
 		commandText.Append("EXPR_FIELD		 COMPUTED BY (smallint_field * 1000),");
-		commandText.Append("CS_FIELD		 CHAR(1) CHARACTER SET UNICODE_FSS,");
+		commandText.Append("CS_FIELD		 CHAR(1) CHARACTER SET UNICODE_FSS COLLATE UNICODE_FSS,");
 		commandText.Append("UCCHAR_ARRAY	 CHAR(10) [1:10] CHARACTER SET UNICODE_FSS);");
 
 		await using (var command = new FbCommand(commandText.ToString(), connection))

src/FirebirdSql.EntityFrameworkCore.Firebird.Tests/Scaffolding/ScaffoldingTests.cs

@@ -15,16 +15,28 @@
 
 //$Authors = Jiri Cincura (jiri@cincura.net)
 
+using System;
 using System.Linq;
 using System.Threading.Tasks;
+using FirebirdSql.Data.FirebirdClient;
+using FirebirdSql.EntityFrameworkCore.Firebird.Metadata;
+using FirebirdSql.EntityFrameworkCore.Firebird.Metadata.Internal;
 using FirebirdSql.EntityFrameworkCore.Firebird.Scaffolding.Internal;
 using Microsoft.EntityFrameworkCore.Scaffolding;
+using Microsoft.EntityFrameworkCore.Scaffolding.Metadata;
 using NUnit.Framework;
 
 namespace FirebirdSql.EntityFrameworkCore.Firebird.Tests.Scaffolding;
 #pragma warning disable EF1001
 public class ScaffoldingTests : EntityFrameworkCoreTestsBase
 {
+	public override async Task SetUp()
+	{
+		await base.SetUp();
+
+		await CreateScaffoldingObjectsAsync();
+	}
+
 	[Test]
 	public void JustCanRun()
 	{
@@ -107,6 +119,208 @@ public async Task ReadsCorrectFieldType(string dataType)
 		Assert.That(column.StoreType, Is.EqualTo(dataType));
 	}
 
+	[Test]
+	public void CanScaffoldPrimaryKey()
+	{
+		var modelFactory = GetModelFactory();
+		var databaseModel = modelFactory.Create(Connection, new DatabaseModelFactoryOptions());
+		var testTable = databaseModel.Tables.Where(t => t.Name.Equals("TEST")).First();
+
+		Assert.NotNull(testTable.PrimaryKey);
+		Assert.AreEqual("INT_FIELD", testTable.PrimaryKey.Columns[0].Name);
+	}
+
+	[Test]
+	public void CanScaffoldGeneratedByIdentities()
+	{
+		var modelFactory = GetModelFactory();
+		var databaseModel = modelFactory.Create(Connection, new DatabaseModelFactoryOptions());
+		var testTable = databaseModel.Tables.Where(t => t.Name == "SCAFFOLD_TEST").First();
+		Assert.NotNull(testTable);
+
+		var idDefaultColumn = testTable.Columns.Where(c => c.Name == "ID_DEFAULT").First();
+		Assert.AreEqual(FbIdentityType.GeneratedByDefault, (FbIdentityType)(idDefaultColumn.GetAnnotation(FbAnnotationNames.IdentityType).Value));
+		if (FbTestsSetup.ServerVersionAtLeast(ServerVersion, new Version(4, 0, 0, 0)))
+		{
+			Assert.IsNull(idDefaultColumn.FindAnnotation(FbAnnotationNames.IdentityStart));
+			Assert.IsNull(idDefaultColumn.FindAnnotation(FbAnnotationNames.IdentityIncrement));
+
+			var testTableFirebird4 = databaseModel.Tables.Where(t => t.Name == "SCAFFOLD_NEW_FB4_TYPES").First();
+			Assert.NotNull(testTableFirebird4);
+
+			var idAlwaysColumn = testTableFirebird4.Columns.Where(c => c.Name == "ID_ALWAYS").First();
+			Assert.AreEqual(FbIdentityType.GeneratedAlways, (FbIdentityType)idAlwaysColumn.GetAnnotation(FbAnnotationNames.IdentityType).Value);
+			Assert.AreEqual(2, Convert.ToInt32(idAlwaysColumn.GetAnnotation(FbAnnotationNames.IdentityStart).Value));
+			Assert.AreEqual(3, Convert.ToInt32(idAlwaysColumn.GetAnnotation(FbAnnotationNames.IdentityIncrement).Value));
+		}
+	}
+
+	[Test]
+	public void CanScaffoldColumns()
+	{
+		var modelFactory = GetModelFactory();
+		var databaseModel = modelFactory.Create(Connection, new DatabaseModelFactoryOptions());
+		var testTable = databaseModel.Tables.Where(t => t.Name == "TEST").First();	
+		Assert.NotNull(testTable);
+
+		var intColumn = testTable.Columns.Where(c => c.Name == "INT_FIELD").First();
+		Assert.AreEqual("INTEGER", intColumn.StoreType);
+		Assert.AreEqual("0", intColumn.DefaultValueSql);
+		Assert.IsNull(intColumn.FindAnnotation(FbAnnotationNames.IdentityType));
+
+		var charColumn = testTable.Columns.Where(c => c.Name == "CHAR_FIELD").First();
+		Assert.AreEqual("CHAR(30)", charColumn.StoreType);
+
+		var varcharColumn = testTable.Columns.Where(c => c.Name == "VARCHAR_FIELD").First();
+		Assert.AreEqual("VARCHAR(100)", varcharColumn.StoreType);
+
+		var numericColumn = testTable.Columns.Where(c => c.Name == "NUMERIC_FIELD").First();
+		Assert.AreEqual("NUMERIC(15,2)", numericColumn.StoreType);
+
+		var decimalColumn = testTable.Columns.Where(c => c.Name == "DECIMAL_FIELD").First();
+		Assert.AreEqual("DECIMAL(15,2)", decimalColumn.StoreType);
+
+		var blobColumn = testTable.Columns.Where(c => c.Name == "BLOB_FIELD").First();
+		Assert.AreEqual("BLOB SUB_TYPE BINARY", blobColumn.StoreType);
+		Assert.AreEqual(80, Convert.ToInt32(blobColumn.GetAnnotation(FbAnnotationNames.BlobSegmentSize).Value));
+
+		var clobColumn = testTable.Columns.Where(c => c.Name == "CLOB_FIELD").First();
+		Assert.AreEqual("BLOB SUB_TYPE TEXT", clobColumn.StoreType);
+		Assert.AreEqual(80, Convert.ToInt32(clobColumn.GetAnnotation(FbAnnotationNames.BlobSegmentSize).Value));
+
+		var exprColumn = testTable.Columns.Where(c => c.Name == "EXPR_FIELD").First();
+		Assert.AreEqual("(smallint_field * 1000)", exprColumn.ComputedColumnSql);
+
+		var csColumn = testTable.Columns.Where(c => c.Name == "CS_FIELD").First();
+		Assert.AreEqual("CHAR(1)", csColumn.StoreType);
+		Assert.AreEqual("UNICODE_FSS", csColumn.Collation);
+		Assert.AreEqual("UNICODE_FSS", csColumn.GetAnnotation(FbAnnotationNames.CharacterSet).Value.ToString());
+	}
+
+	[Test]
+	public void CanScaffoldFirebird4DataTypes()
+	{
+		if (!EnsureServerVersionAtLeast(new Version(4, 0, 0, 0)))
+			return;
+
+		var modelFactory = GetModelFactory();
+		var databaseModel = modelFactory.Create(Connection, new DatabaseModelFactoryOptions());
+		var testTable = databaseModel.Tables.Where(t => t.Name == "SCAFFOLD_NEW_FB4_TYPES").First();
+		Assert.NotNull(testTable);
+
+		var int128Column = testTable.Columns.Where(c => c.Name == "INT128_FIELD").First();
+		Assert.AreEqual("INT128", int128Column.StoreType);
+
+		var decFloat16Column = testTable.Columns.Where(c => c.Name == "DECFLOAT_16_FIELD").First();
+		Assert.AreEqual("DECFLOAT(16)", decFloat16Column.StoreType);
+
+		var decFloat34Column = testTable.Columns.Where(c => c.Name == "DECFLOAT_34_FIELD").First();
+		Assert.AreEqual("DECFLOAT(34)", decFloat34Column.StoreType);
+
+		var timeWithTimeZoneColumn = testTable.Columns.Where(c => c.Name == "TWTZ_FIELD").First();
+		Assert.AreEqual("TIME WITH TIME ZONE", timeWithTimeZoneColumn.StoreType);
+
+		var timestampWithTimeZoneColumn = testTable.Columns.Where(c => c.Name == "TSWTZ_FIELD").First();
+		Assert.AreEqual("TIMESTAMP WITH TIME ZONE", timestampWithTimeZoneColumn.StoreType);
+	}
+
+	async Task CreateScaffoldingObjectsAsync()
+	{
+		await ExecuteDdlAsync(Connection, "DROP TABLE SCAFFOLD_NEW_FB4_TYPES", true);
+
+		await ExecuteDdlAsync(Connection, "DROP TABLE SCAFFOLD_TEST", true);
+
+		if (FbTestsSetup.ServerVersionAtLeast(ServerVersion, new Version(4, 0, 0, 0)))
+		{
+			await ExecuteDdlAsync(Connection, """
+				CREATE TABLE SCAFFOLD_TEST (
+					ID_DEFAULT INTEGER GENERATED BY DEFAULT AS IDENTITY (START WITH 1 INCREMENT BY 1)
+				)
+				"""
+			);
+
+			await ExecuteDdlAsync(Connection, """
+				CREATE TABLE SCAFFOLD_NEW_FB4_TYPES (
+					ID_ALWAYS INTEGER GENERATED ALWAYS AS IDENTITY (START WITH 2 INCREMENT BY 3),
+					INT128_FIELD INT128,
+					DECFLOAT_16_FIELD DECFLOAT(16),
+					DECFLOAT_34_FIELD DECFLOAT(34),
+					TWTZ_FIELD TIME WITH TIME ZONE,
+					TSWTZ_FIELD TIMESTAMP WITH TIME ZONE
+				)
+				""");
+		}
+		else
+		{
+			await ExecuteDdlAsync(Connection, """
+				CREATE TABLE SCAFFOLD_TEST (
+					ID_DEFAULT INTEGER GENERATED BY DEFAULT AS IDENTITY
+				)
+				"""
+			);
+		}
+	}
+
+	static async Task ExecuteDdlAsync(FbConnection connection, string ddlScript, bool ignoreErrors = false)
+	{
+		try
+		{
+			await using var command = new FbCommand(ddlScript, connection);
+			await command.ExecuteNonQueryAsync();
+		}
+		catch when (ignoreErrors)
+		{
+		}
+  }
+
+  [Test]
+	public async Task ExpressionIndexDoesNotBreakScaffolding()
+	{
+		var tableName = "TEST_EXPR_IDX";
+
+		using var commandTable = Connection.CreateCommand();
+		commandTable.CommandText = $"recreate table {tableName} (ID INTEGER NOT NULL, DATA VARCHAR(100))";
+		await commandTable.ExecuteNonQueryAsync();
+
+		using var commandIndex = Connection.CreateCommand();
+		commandIndex.CommandText = $"create index IDX_EXPR on {tableName} computed by (upper(DATA))";
+		await commandIndex.ExecuteNonQueryAsync();
+
+		var modelFactory = GetModelFactory();
+		var model = modelFactory.Create(Connection.ConnectionString, new DatabaseModelFactoryOptions(new string[] { tableName }));
+		var table = model.Tables.Single(x => x.Name == tableName);
+
+		Assert.That(table.Indexes, Has.None.Matches<Microsoft.EntityFrameworkCore.Scaffolding.Metadata.DatabaseIndex>(x => x.Name == "IDX_EXPR"));
+	}
+
+	[Test]
+	public async Task RegularIndexScaffoldedAlongsideExpressionIndex()
+	{
+		var tableName = "TEST_MIX_IDX";
+
+		using var commandTable = Connection.CreateCommand();
+		commandTable.CommandText = $"recreate table {tableName} (ID INTEGER NOT NULL, DATA VARCHAR(100))";
+		await commandTable.ExecuteNonQueryAsync();
+
+		using var commandRegularIndex = Connection.CreateCommand();
+		commandRegularIndex.CommandText = $"create index IDX_REGULAR on {tableName} (DATA)";
+		await commandRegularIndex.ExecuteNonQueryAsync();
+
+		using var commandExprIndex = Connection.CreateCommand();
+		commandExprIndex.CommandText = $"create index IDX_EXPR_MIX on {tableName} computed by (upper(DATA))";
+		await commandExprIndex.ExecuteNonQueryAsync();
+
+		var modelFactory = GetModelFactory();
+		var model = modelFactory.Create(Connection.ConnectionString, new DatabaseModelFactoryOptions(new string[] { tableName }));
+		var table = model.Tables.Single(x => x.Name == tableName);
+
+		Assert.Multiple(() =>
+		{
+			Assert.That(table.Indexes, Has.Some.Matches<Microsoft.EntityFrameworkCore.Scaffolding.Metadata.DatabaseIndex>(x => x.Name == "IDX_REGULAR"));
+			Assert.That(table.Indexes, Has.None.Matches<Microsoft.EntityFrameworkCore.Scaffolding.Metadata.DatabaseIndex>(x => x.Name == "IDX_EXPR_MIX"));
+		});
+	}
+
 	static IDatabaseModelFactory GetModelFactory()
 	{
 		return new FbDatabaseModelFactory();

src/FirebirdSql.EntityFrameworkCore.Firebird/Metadata/FbIdentityType.cs

@@ -0,0 +1,24 @@
+/*
+ *    The contents of this file are subject to the Initial
+ *    Developer's Public License Version 1.0 (the "License");
+ *    you may not use this file except in compliance with the
+ *    License. You may obtain a copy of the License at
+ *    https://github.com/FirebirdSQL/NETProvider/raw/master/license.txt.
+ *
+ *    Software distributed under the License is distributed on
+ *    an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
+ *    express or implied. See the License for the specific
+ *    language governing rights and limitations under the License.
+ *
+ *    All Rights Reserved.
+ */
+
+//$Authors = Jiri Cincura (jiri@cincura.net)
+
+namespace FirebirdSql.EntityFrameworkCore.Firebird.Metadata;
+
+public enum FbIdentityType
+{
+	GeneratedAlways = 0,
+	GeneratedByDefault = 1,
+}

src/FirebirdSql.EntityFrameworkCore.Firebird/Metadata/Internal/FbAnnotationNames.cs

@@ -25,5 +25,13 @@ public static class FbAnnotationNames
 	public const string HiLoSequenceSchema = Prefix + nameof(HiLoSequenceSchema);
 	public const string SequenceName = Prefix + nameof(SequenceName);
 	public const string SequenceSchema = Prefix + nameof(SequenceSchema);
-	public const string SequenceNameSuffix = Prefix+ nameof(SequenceNameSuffix);
+	public const string SequenceNameSuffix = Prefix + nameof(SequenceNameSuffix);
+
+	public const string BlobSegmentSize = Prefix + nameof(BlobSegmentSize);
+	public const string CharacterSet = Prefix + nameof(CharacterSet);
+	public const string DomainName = Prefix + nameof(DomainName);
+
+	public const string IdentityType = Prefix + nameof(IdentityType);
+	public const string IdentityStart = Prefix + nameof(IdentityStart);
+	public const string IdentityIncrement = Prefix + nameof(IdentityIncrement);
 }