Merge pull request #112 from PomeloFoundation/dev

Merging  dev to master

Author: ChaosEngine

.travis.yml

@@ -1,7 +1,7 @@
 language: csharp
 mono: none
-dotnet: 7.0.100
-dist: bionic
+dotnet: 8.0.101
+dist: jammy
 addons:
   apt:
     packages:
@@ -10,7 +10,6 @@ addons:
     - libicu-dev
     - libssl-dev
     - libunwind8
-    - zlib1g
 env:
   global:
     - DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true

README.md

@@ -8,10 +8,10 @@ Basing on https://learn.microsoft.com/en-us/aspnet/core/performance/caching/dist
 
 The Distributed MySQL Server Cache implementation (**AddDistributedMySqlCache**) allows the distributed cache to use a MySQL Server database as its backing store. To create a MySQL Server cached item table in a MySQL Server instance, you can use the `dotnet-mysql-cache` tool. The tool creates a table with the name and schema that you specify.
 
-Create a table in MySQL Server by running the `dotnet mysql-cache create` command. Provide the MySQL Server connection string, instance (for example `server=192.169.0.1`), database (for example, `databaseName`), and table name (for example, `NewTableName`):
+Create a table in MySQL Server by running the `dotnet mysql-cache create` command. Provide the MySQL Server connection string, instance (for example `server=192.169.0.1`), table name (for example, `NewTableName`) and optional database (for example, `MyDatabaseName`):
 
 ```dotnetcli
-dotnet mysql-cache create "server=192.169.0.1;user id=userName;password=P4ssword123!;port=3306;database=databaseName;Allow User Variables=True" databaseName "NewTableName"
+dotnet mysql-cache create "server=192.169.0.1;user id=userName;password=P4ssword123!;port=3306;database=MyDatabaseName;Allow User Variables=True" "NewTableName" --databaseName "MyDatabaseName"
 ```
 
 A message is logged to indicate that the tool was successful:
@@ -33,8 +33,8 @@ The example snippet how to implement MySql Server cache in `Program.cs`:
 builder.Services.AddDistributedMySqlCache(options =>
 {
     options.ConnectionString = builder.Configuration.GetConnectionString("DistCache_ConnectionString");
-    options.SchemaName = "databaseName";
-    options.TableName = "NewTableName";
+    options.SchemaName = "MyDatabaseName";  //optional
+    options.TableName = "NewTableName";     //required
 });
 ```
 

src/Pomelo.Extensions.Caching.MySql/MySqlCache.cs

@@ -38,11 +38,11 @@ public MySqlCache(IOptions<MySqlCacheOptions> options)
 					+ $" and {nameof(cacheOptions.ConnectionString)} cannot be empty or null at the same time.");
 			}
 
-			if (string.IsNullOrEmpty(cacheOptions.SchemaName))
-			{
-				throw new ArgumentException(
-					$"{nameof(cacheOptions.SchemaName)} cannot be empty or null.");
-			}
+			//if (string.IsNullOrEmpty(cacheOptions.SchemaName))
+			//{
+			//	throw new ArgumentException(
+			//		$"{nameof(cacheOptions.SchemaName)} cannot be empty or null.");
+			//}
 			if (string.IsNullOrEmpty(cacheOptions.TableName))
 			{
 				throw new ArgumentException(

src/Pomelo.Extensions.Caching.MySql/MySqlCacheOptions.cs

@@ -72,7 +72,7 @@ MySqlCacheOptions IOptions<MySqlCacheOptions>.Value
 		{
 			get
 			{
-				//correct empty conn strings if possible more inteligently
+				//correct empty conn strings if possible more intelligently
 				WriteConnectionString = WriteConnectionString ?? ConnectionString;
 				ReadConnectionString = (ReadConnectionString ?? ConnectionString) ?? WriteConnectionString;
 

src/Pomelo.Extensions.Caching.MySql/MySqlCacheServiceCollectionExtensions.cs

@@ -39,7 +39,6 @@ public static IServiceCollection AddDistributedMySqlCache(this IServiceCollectio
         }
 
 		// to enable unit testing
-		/// TODO: make this internal again
 		internal static void AddMySqlCacheServices(IServiceCollection services)
         {
             services.Add(ServiceDescriptor.Singleton<IDistributedCache, MySqlCache>());

src/Pomelo.Extensions.Caching.MySql/MySqlParameterCollectionExtensions.cs

@@ -6,9 +6,6 @@
 
 namespace Pomelo.Extensions.Caching.MySql
 {
-	/// <summary>
-	/// TODO: make this class internal again
-	/// </summary>
 	internal static class MySqlParameterCollectionExtensions
     {
         // For all values where the length is less than the below value, try setting the size of the

src/Pomelo.Extensions.Caching.MySql/MySqlQueries.cs

@@ -5,29 +5,29 @@ namespace Pomelo.Extensions.Caching.MySql
 {
 	internal class MySqlQueries
 	{
-		private const string TableInfoFormat =
-			"SELECT TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME, TABLE_TYPE " +
-			"FROM INFORMATION_SCHEMA.TABLES " +
-			"WHERE TABLE_SCHEMA = '{0}' " +
-			"AND TABLE_NAME = '{1}'";
+		//private const string TableInfoFormat =
+		//	"SELECT TABLE_CATALOG, TABLE_SCHEMA, TABLE_NAME, TABLE_TYPE " +
+		//	"FROM INFORMATION_SCHEMA.TABLES " +
+		//	"WHERE TABLE_SCHEMA = '{0}' " +
+		//	"AND TABLE_NAME = '{1}'";
 
 		private const string UpdateCacheItemFormat =
 		"UPDATE {0} " +
-		"SET ExpiresAtTime = " +
+		"SET " + Columns.Names.ExpiresAtTime + " = " +
 			"(CASE " +
-				"WHEN TIME_TO_SEC(TIMEDIFF(AbsoluteExpiration, @UtcNow)) <= SlidingExpirationInSeconds " +
-					"THEN AbsoluteExpiration " +
+				"WHEN TIME_TO_SEC(TIMEDIFF(" + Columns.Names.AbsoluteExpiration + ", @UtcNow)) <= " + Columns.Names.SlidingExpirationInSeconds + " " +
+					"THEN " + Columns.Names.AbsoluteExpiration + " " +
 				"ELSE " +
-					"DATE_ADD(@UtcNow, INTERVAL SlidingExpirationInSeconds SECOND) " +
+					"DATE_ADD(@UtcNow, INTERVAL " + Columns.Names.SlidingExpirationInSeconds + " SECOND) " +
 			"END) " +
-		"WHERE Id = @Id " +
-		"AND @UtcNow <= ExpiresAtTime " +
-		"AND SlidingExpirationInSeconds IS NOT NULL " +
-		"AND (AbsoluteExpiration IS NULL OR AbsoluteExpiration <> ExpiresAtTime);";
+		"WHERE " + Columns.Names.CacheItemId + " = @Id " +
+		"AND @UtcNow <= " + Columns.Names.ExpiresAtTime + " " +
+		"AND " + Columns.Names.SlidingExpirationInSeconds + " IS NOT NULL " +
+		"AND (" + Columns.Names.AbsoluteExpiration + " IS NULL OR " + Columns.Names.AbsoluteExpiration + " <> " + Columns.Names.ExpiresAtTime + ");";
 
 		private const string GetCacheItemFormat =
-			"SELECT Id, ExpiresAtTime, SlidingExpirationInSeconds, AbsoluteExpiration, Value " +
-			"FROM {0} WHERE Id = @Id AND @UtcNow <= ExpiresAtTime;";
+			"SELECT Id, " + Columns.Names.ExpiresAtTime + ", " + Columns.Names.SlidingExpirationInSeconds + ", " + Columns.Names.AbsoluteExpiration + ", " + Columns.Names.CacheItemValue + " " +
+			"FROM {0} WHERE " + Columns.Names.CacheItemId + " = @Id AND @UtcNow <= " + Columns.Names.ExpiresAtTime + ";";
 
 		private const string SetCacheItemFormat =
 			"SET @ExpiresAtTime = " +
@@ -37,33 +37,36 @@ internal class MySqlQueries
 					"ELSE " +
 						"DATE_ADD(@UtcNow, INTERVAL @SlidingExpirationInSeconds SECOND) " +
 			"END);" +
-			 "INSERT INTO {0} " +
-			 "(Id, Value, ExpiresAtTime, SlidingExpirationInSeconds, AbsoluteExpiration) " +
+			 "INSERT INTO {0} (" + Columns.Names.CacheItemId + ", " + Columns.Names.CacheItemValue + ", " +
+				Columns.Names.ExpiresAtTime + ", " + Columns.Names.SlidingExpirationInSeconds + ", " +
+				Columns.Names.AbsoluteExpiration + ") " +
 			 "VALUES (@Id, @Value, @ExpiresAtTime, @SlidingExpirationInSeconds, @AbsoluteExpiration)" +
 			" ON DUPLICATE KEY " +
-					  "UPDATE Value = @Value, ExpiresAtTime = @ExpiresAtTime," +
-					  "SlidingExpirationInSeconds = @SlidingExpirationInSeconds, AbsoluteExpiration = @AbsoluteExpiration " +
+					  "UPDATE " + Columns.Names.CacheItemValue + " = @Value, " + Columns.Names.ExpiresAtTime + " = @ExpiresAtTime," +
+					  Columns.Names.SlidingExpirationInSeconds + " = @SlidingExpirationInSeconds, " + Columns.Names.AbsoluteExpiration + " = @AbsoluteExpiration " +
 					  ";";
 
-		private const string DeleteCacheItemFormat = "DELETE FROM {0} WHERE Id = @Id";
+		private const string DeleteCacheItemFormat = "DELETE FROM {0} WHERE " + Columns.Names.CacheItemId + " = @Id";
 
-		public const string DeleteExpiredCacheItemsFormat = "DELETE FROM {0} WHERE @UtcNow > ExpiresAtTime";
+		public const string DeleteExpiredCacheItemsFormat = "DELETE FROM {0} WHERE @UtcNow > " + Columns.Names.ExpiresAtTime;
 
 		public MySqlQueries(string schemaName, string tableName)
 		{
-			var tableNameWithSchema = string.Format(
-				"{0}.{1}", EscapeIdentifier(DelimitIdentifier(schemaName)), EscapeIdentifier(DelimitIdentifier(tableName)));
+			var tableNameWithSchema = string.Format("{0}{1}",
+				(string.IsNullOrEmpty(schemaName) ? "" : EscapeIdentifier(DelimitIdentifier(schemaName)) + '.'),
+				EscapeIdentifier(DelimitIdentifier(tableName))
+			);
 
 			// when retrieving an item, we do an UPDATE first and then a SELECT
 			GetCacheItem = string.Format(UpdateCacheItemFormat + GetCacheItemFormat, tableNameWithSchema);
 			GetCacheItemWithoutValue = string.Format(UpdateCacheItemFormat, tableNameWithSchema);
 			DeleteCacheItem = string.Format(DeleteCacheItemFormat, tableNameWithSchema);
 			DeleteExpiredCacheItems = string.Format(DeleteExpiredCacheItemsFormat, tableNameWithSchema);
 			SetCacheItem = string.Format(SetCacheItemFormat, tableNameWithSchema);
-			TableInfo = string.Format(TableInfoFormat, EscapeLiteral(schemaName), EscapeLiteral(tableName));
+			//TableInfo = string.Format(TableInfoFormat, EscapeLiteral(schemaName), EscapeLiteral(tableName));
 		}
 
-		public string TableInfo { get; }
+		//public string TableInfo { get; }
 
 		public string GetCacheItem { get; }
 

src/Pomelo.Extensions.Caching.MySql/Pomelo.Extensions.Caching.MySql.csproj

@@ -11,21 +11,26 @@
     <GenerateAssemblyConfigurationAttribute>false</GenerateAssemblyConfigurationAttribute>
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
-    <Version>2.1.4</Version>
+    <Version>2.2.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>Pomelo.snk</AssemblyOriginatorKeyFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-  </PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+	</PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <DefineConstants>DEBUG;TRACE</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Options" Version="7.0.1" />
-    <PackageReference Include="MySqlConnector" Version="2.2.5" />
+    <None Include="..\..\README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
+  <ItemGroup>
+		<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="8.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />
+		<PackageReference Include="MySqlConnector" Version="2.3.7" />
   </ItemGroup>
 
 </Project>

src/Pomelo.Extensions.Caching.MySqlConfig.Tools/Pomelo.Extensions.Caching.MySqlConfig.Tools.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <Description>Command line tool to create tables and indexes in a MySql Server database for distributed caching.</Description>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <NoWarn>$(NoWarn);CS1591</NoWarn>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
@@ -18,16 +18,17 @@
     <GenerateAssemblyCopyrightAttribute>false</GenerateAssemblyCopyrightAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
     <RootNamespace>Pomelo.Extensions.Caching.MySqlConfig.Tools</RootNamespace>
-    <Version>2.1.1</Version>
+    <Version>2.2.0</Version>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
-    <AssemblyVersion>2.1.1.0</AssemblyVersion>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
     <IsPackable>true</IsPackable>
     <ToolCommandName>dotnet-mysql-cache</ToolCommandName>
     <PackAsTool>true</PackAsTool>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>Pomelo.snk</AssemblyOriginatorKeyFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
@@ -36,9 +37,13 @@
     <DocumentationFile>obj\Debug\dotnet-mysql-cache.xml</DocumentationFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\..\README.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.CommandLineUtils" Version="1.1.1" />
-    <PackageReference Include="MySqlConnector" Version="2.2.5" />
+    <PackageReference Include="MySqlConnector" Version="2.3.7" />
   </ItemGroup>
 
 </Project>

src/Pomelo.Extensions.Caching.MySqlConfig.Tools/Program.cs

@@ -63,21 +63,21 @@ public int Run(string[] args)
 
 				cliApp.Command("create", command =>
 				{
-					command.Error = Error;//internal command Out/Erro are not yet changed, possible shortcomming
+					command.Error = Error;//internal command Out/Error are not yet changed, possible shortcoming
 					command.Out = Out;
 
 					command.Description = description;
 					var connectionStringArg = command.Argument(
 						"[connectionString]",
 						"The connection string to connect to the database.");
-					var databaseNameArg = command.Argument("[databaseName]", "Name of the database.");
+					//var databaseNameArg = command.Argument("[databaseName]", "Name of the database.");
+					var databaseNameOpt = command.Option("-d|--databaseName", "Name of the database. If not existing or set in connection string.", CommandOptionType.SingleValue);
 					var tableNameArg = command.Argument("[tableName]", "Name of the table to be created.");
 					command.HelpOption("-?|-h|--help");
 
 					command.OnExecute(async () =>
 					{
 						if (string.IsNullOrEmpty(connectionStringArg.Value)
-							|| string.IsNullOrEmpty(databaseNameArg.Value)
 							|| string.IsNullOrEmpty(tableNameArg.Value))
 						{
 							await Error.WriteLineAsync("Invalid input");
@@ -86,7 +86,7 @@ public int Run(string[] args)
 						}
 
 						_connectionString = connectionStringArg.Value;
-						_databaseName = databaseNameArg.Value;
+						_databaseName = databaseNameOpt.Value();
 						_tableName = tableNameArg.Value;
 
 						return await CreateTableAndIndexes();
@@ -95,25 +95,25 @@ public int Run(string[] args)
 
 				cliApp.Command("script", command =>
 				{
-					command.Error = Error;//internal command Out/Erro are not yet changed, possible shortcomming
+					command.Error = Error;//internal command Out/Error are not yet changed, possible shortcoming
 					command.Out = Out;
 
 					command.Description = "Generate creation script";
-					var databaseNameArg = command.Argument("[databaseName]", "Name of the database.");
+					//var databaseNameArg = command.Argument("[databaseName]", "Name of the database.");
+					var databaseNameOpt = command.Option("-d|--databaseName", "Name of the database. If not existing or set in connection string.", CommandOptionType.SingleValue);
 					var tableNameArg = command.Argument("[tableName]", "Name of the table to be created.");
 					command.HelpOption("-?|-h|--help");
 
 					command.OnExecute(async () =>
 					{
-						if (string.IsNullOrEmpty(databaseNameArg.Value)
-							|| string.IsNullOrEmpty(tableNameArg.Value))
+						if (string.IsNullOrEmpty(tableNameArg.Value))
 						{
 							await Error.WriteLineAsync("Invalid input");
 							cliApp.ShowHelp(command.Name);
 							return 2;
 						}
 
-						_databaseName = databaseNameArg.Value;
+						_databaseName = databaseNameOpt.Value();
 						_tableName = tableNameArg.Value;
 
 						return await GenerateScript();
@@ -169,12 +169,6 @@ public int Run(string[] args)
 							await command.ExecuteNonQueryAsync(token);
 						}
 
-						//using (var command = new MySqlCommand(sqlQueries.CreateNonClusteredIndexOnExpirationTime,
-						//	connection, transaction))
-						//{
-						//	await command.ExecuteNonQueryAsync(token);
-						//}
-
 						transaction.Commit();
 
 						await Out.WriteLineAsync("Table and index were created successfully.");