feat: generator: hypertable: use EXECUTE for edition support (fixes #12)

sebastian-ederer · sebastian-ederer · commit c7edb5dafc1d · 2025-11-27T20:04:44.000+01:00
Use EXECUTE statements inside DO $$ blocks to fix PL/pgSQL limitations where SELECT statements cannot return data without a destination.

   - Wrap Community-only features in runtime license check
   - Escape single quotes for EXECUTE string literals
   - Move chunk_time_interval into create_hypertable() parameters
   - Update warning message to reference Apache Edition
diff --git a/benchmarks/Eftdb.Benchmarks/WriteRecordsBenchmarkBase.cs b/benchmarks/Eftdb.Benchmarks/WriteRecordsBenchmarkBase.cs
@@ -46,13 +46,13 @@ public async Task GlobalCleanup()
         public void IterationSetup()
         {
             Trades.Clear();
-            var random = new Random();
+            Random random = new();
             string[] tickers = ["AAPL", "GOOGL", "MSFT", "TSLA", "AMZN"];
-            var baseTimestamp = DateTime.UtcNow.AddMinutes(-30);
+            DateTime baseTimestamp = DateTime.UtcNow.AddMinutes(-30);
 
             for (int i = 0; i < NumberOfRecords; i++)
             {
-                var trade = CreateTradeInstance(i, baseTimestamp, tickers[random.Next(tickers.Length)], random);
+                T trade = CreateTradeInstance(i, baseTimestamp, tickers[random.Next(tickers.Length)], random);
                 Trades.Add(trade);
             }
 
diff --git a/src/Eftdb.Design/TimescaleDatabaseModelFactory.cs b/src/Eftdb.Design/TimescaleDatabaseModelFactory.cs
@@ -28,9 +28,7 @@ public override DatabaseModel Create(DbConnection connection, DatabaseModelFacto
             DatabaseModel databaseModel = base.Create(connection, options);
 
             // Extract all TimescaleDB features from the database
-            var allFeatureData = _features
-                .Select(feature => feature.Extractor.Extract(connection))
-                .ToList();
+            List<Dictionary<(string Schema, string TableName), object>> allFeatureData = [.. _features.Select(feature => feature.Extractor.Extract(connection))];
 
             // Apply annotations to tables/views in the model
             foreach (DatabaseTable table in databaseModel.Tables)
@@ -42,7 +40,7 @@ public override DatabaseModel Create(DbConnection connection, DatabaseModelFacto
                 // Apply each feature's annotations if the table has that feature
                 for (int i = 0; i < _features.Count; i++)
                 {
-                    var featureData = allFeatureData[i];
+                    Dictionary<(string Schema, string TableName), object> featureData = allFeatureData[i];
                     if (featureData.TryGetValue(tableKey, out object? featureInfo))
                     {
                         _features[i].Applier.ApplyAnnotations(table, featureInfo);
diff --git a/src/Eftdb/Abstractions/TimescaleCopyConfig.cs b/src/Eftdb/Abstractions/TimescaleCopyConfig.cs
@@ -58,10 +58,10 @@ public TimescaleCopyConfig()
                 if (MapClrTypeToNpgsqlDbType(property.PropertyType, out NpgsqlDbType dbType))
                 {
                     // Auto-discover properties and create compiled getters for them.
-                    var parameter = Expression.Parameter(typeof(T), "x");
-                    var member = Expression.Property(parameter, property);
-                    var conversion = Expression.Convert(member, typeof(object));
-                    var lambda = Expression.Lambda<Func<T, object>>(conversion, parameter);
+                    ParameterExpression parameter = Expression.Parameter(typeof(T), "x");
+                    MemberExpression member = Expression.Property(parameter, property);
+                    UnaryExpression conversion = Expression.Convert(member, typeof(object));
+                    Expression<Func<T, object>> lambda = Expression.Lambda<Func<T, object>>(conversion, parameter);
 
                     ColumnMappings[property.Name] = (lambda.Compile(), dbType);
                 }
@@ -124,7 +124,7 @@ public TimescaleCopyConfig<T> MapColumn(string columnName, Expression<Func<T, ob
         private static bool MapClrTypeToNpgsqlDbType(Type clrType, out NpgsqlDbType dbType)
         {
             // Handle nullable value types by getting the underlying type
-            var underlyingType = Nullable.GetUnderlyingType(clrType) ?? clrType;
+            Type underlyingType = Nullable.GetUnderlyingType(clrType) ?? clrType;
 
             // This map contains the default CLR type to NpgsqlDbType mappings
             // based on the Npgsql "Write Mappings" documentation.
diff --git a/src/Eftdb/Generators/ContinuousAggregateOperationGenerator.cs b/src/Eftdb/Generators/ContinuousAggregateOperationGenerator.cs
@@ -1,4 +1,5 @@
 ﻿using CmdScale.EntityFrameworkCore.TimescaleDB.Operations;
+using System.Text;
 
 namespace CmdScale.EntityFrameworkCore.TimescaleDB.Generators
 {
@@ -114,7 +115,7 @@ public List<string> Generate(CreateContinuousAggregateOperation operation)
             }
 
             // Build the complete CREATE MATERIALIZED VIEW statement as a single string
-            var sqlBuilder = new System.Text.StringBuilder();
+            StringBuilder sqlBuilder = new();
             sqlBuilder.Append($"CREATE MATERIALIZED VIEW {qualifiedIdentifier}");
             sqlBuilder.AppendLine();
             sqlBuilder.Append($"WITH ({string.Join(", ", withOptions)}) AS");
diff --git a/src/Eftdb/Generators/HypertableOperationGenerator.cs b/src/Eftdb/Generators/HypertableOperationGenerator.cs
@@ -28,7 +28,7 @@ public List<string> Generate(CreateHypertableOperation operation)
             List<string> communityStatements = [];
 
             // Build create_hypertable with chunk_time_interval if provided
-            var createHypertableCall = new StringBuilder();
+            StringBuilder createHypertableCall = new();
             createHypertableCall.Append($"SELECT create_hypertable({qualifiedTableName}, '{operation.TimeColumnName}'");
             createHypertableCall.Append(operation.MigrateData ? ", migrate_data => true" : "");
 
@@ -109,7 +109,7 @@ public List<string> Generate(AlterHypertableOperation operation)
             // Check for ChunkTimeInterval change (Available in both editions)
             if (operation.ChunkTimeInterval != operation.OldChunkTimeInterval)
             {
-                var setChunkTimeInterval = new StringBuilder();
+                StringBuilder setChunkTimeInterval = new();
                 setChunkTimeInterval.Append($"SELECT set_chunk_time_interval({qualifiedTableName}, ");
 
                 // Check if the interval is a plain number (e.g., for microseconds).
@@ -209,7 +209,6 @@ public List<string> Generate(AlterHypertableOperation operation)
                 statements.Add($"-- WARNING: TimescaleDB does not support removing dimensions. The following dimensions cannot be removed: {dimensionList}");
             }
 
-
             // Add wrapped community statements if any exist
             if (communityStatements.Count > 0)
             {
@@ -219,11 +218,11 @@ public List<string> Generate(AlterHypertableOperation operation)
         }
 
         /// <summary>
-        /// Wraps multiple SQL statements in a single license check block to ensure they only run on Community Edition
+        /// Wraps multiple SQL statements in a single license check block to ensure they only run on Community Edition.
         /// </summary>
-        private string WrapCommunityFeatures(List<string> sqlStatements)
+        private static string WrapCommunityFeatures(List<string> sqlStatements)
         {
-            var sb = new StringBuilder();
+            StringBuilder sb = new();
             sb.AppendLine("DO $$");
             sb.AppendLine("DECLARE");
             sb.AppendLine("    license TEXT;");
@@ -234,11 +233,13 @@ private string WrapCommunityFeatures(List<string> sqlStatements)
 
             foreach (string sql in sqlStatements)
             {
-                sb.AppendLine($"        {sql}");
+                // Remove trailing semicolon and escape single quotes for EXECUTE
+                string cleanSql = sql.TrimEnd(';').Replace("'", "''");
+                sb.AppendLine($"        EXECUTE '{cleanSql}';");
             }
 
             sb.AppendLine("    ELSE");
-            sb.AppendLine("        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Enterprise Edition';");
+            sb.AppendLine("        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Apache Edition';");
             sb.AppendLine("    END IF;");
             sb.AppendLine("END $$;");
 
diff --git a/src/Eftdb/TimescaleDbCopyExtensions.cs b/src/Eftdb/TimescaleDbCopyExtensions.cs
@@ -55,7 +55,7 @@ public static async Task BulkCopyAsync<T>(
                             await writer.StartRowAsync();
 
                             // Write each configured column in the specified order
-                            foreach (var (Getter, DbType) in config.ColumnMappings.Values)
+                            foreach ((Func<T, object?>? Getter, NpgsqlTypes.NpgsqlDbType DbType) in config.ColumnMappings.Values)
                             {
                                 object? value = Getter(item);
                                 await writer.WriteAsync(value, DbType);
diff --git a/tests/Eftdb.Tests/Generators/HypertableOperationGeneratorComprehensiveTests.cs b/tests/Eftdb.Tests/Generators/HypertableOperationGeneratorComprehensiveTests.cs
@@ -143,11 +143,11 @@ public void DesignTime_Create_CompressionWithoutChunkSkipping_GeneratesCorrectCo
                     license TEXT;
                 BEGIN
                     license := current_setting('timescaledb.license', true);
-                    
+
                     IF license IS NULL OR license != 'apache' THEN
-                        ALTER TABLE """"public"""".""""compressed_data"""" SET (timescaledb.compress = true);
+                        EXECUTE 'ALTER TABLE """"public"""".""""compressed_data"""" SET (timescaledb.compress = true)';
                     ELSE
-                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Enterprise Edition';
+                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Apache Edition';
                     END IF;
                 END $$;
             "")";
@@ -429,11 +429,11 @@ public void DesignTime_Alter_DisablingCompression_GeneratesCorrectCode()
                     license TEXT;
                 BEGIN
                     license := current_setting('timescaledb.license', true);
-                    
+
                     IF license IS NULL OR license != 'apache' THEN
-                        ALTER TABLE """"public"""".""""decompress"""" SET (timescaledb.compress = false);
+                        EXECUTE 'ALTER TABLE """"public"""".""""decompress"""" SET (timescaledb.compress = false)';
                     ELSE
-                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Enterprise Edition';
+                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Apache Edition';
                     END IF;
                 END $$;
             "")";
@@ -463,13 +463,13 @@ public void DesignTime_Alter_AddingChunkSkipColumn_GeneratesCorrectSequence()
                     license TEXT;
                 BEGIN
                     license := current_setting('timescaledb.license', true);
-                    
+
                     IF license IS NULL OR license != 'apache' THEN
-                        SET timescaledb.enable_chunk_skipping = 'ON';
-                        SELECT enable_chunk_skipping('public.""""add_skip""""', 'col2');
-                        SELECT enable_chunk_skipping('public.""""add_skip""""', 'col3');
+                        EXECUTE 'SET timescaledb.enable_chunk_skipping = ''ON''';
+                        EXECUTE 'SELECT enable_chunk_skipping(''public.""""add_skip""""'', ''col2'')';
+                        EXECUTE 'SELECT enable_chunk_skipping(''public.""""add_skip""""'', ''col3'')';
                     ELSE
-                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Enterprise Edition';
+                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Apache Edition';
                     END IF;
                 END $$;
             "")";
@@ -499,11 +499,11 @@ public void DesignTime_Alter_RemovingChunkSkipColumn_GeneratesDisableCommands()
                     license TEXT;
                 BEGIN
                     license := current_setting('timescaledb.license', true);
-                    
+
                     IF license IS NULL OR license != 'apache' THEN
-                        SELECT disable_chunk_skipping('public.""""remove_skip""""', 'remove_this');
+                        EXECUTE 'SELECT disable_chunk_skipping(''public.""""remove_skip""""'', ''remove_this'')';
                     ELSE
-                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Enterprise Edition';
+                        RAISE WARNING 'Skipping Community Edition features (compression, chunk skipping) - not available in Apache Edition';
                     END IF;
                 END $$;
             "")";
@@ -592,8 +592,8 @@ public void Runtime_Alter_ChunkSkipping_RequiresSETCommand()
             string result = GetRuntimeSql(operation);
 
             // Assert - Must SET enable_chunk_skipping = 'ON' before enable_chunk_skipping()
-            Assert.Contains("SET timescaledb.enable_chunk_skipping = 'ON'", result);
-            Assert.Contains("enable_chunk_skipping('public.\"skip_test\"', 'new_col')", result);
+            Assert.Contains("SET timescaledb.enable_chunk_skipping = ''ON''", result);
+            Assert.Contains("enable_chunk_skipping(''public.\"skip_test\"'', ''new_col'')", result);
         }
 
         #endregion
diff --git a/tests/Eftdb.Tests/Generators/HypertableOperationGeneratorTests.cs b/tests/Eftdb.Tests/Generators/HypertableOperationGeneratorTests.cs

Original file line number	Diff line number	Diff line change
`@@ -46,13 +46,13 @@ public async Task GlobalCleanup()`
`46`	`46`	`public void IterationSetup()`
`47`	`47`	`{`
`48`	`48`	`Trades.Clear();`
`49`		`- var random = new Random();`
	`49`	`+ Random random = new();`
`50`	`50`	`string[] tickers = ["AAPL", "GOOGL", "MSFT", "TSLA", "AMZN"];`
`51`		`- var baseTimestamp = DateTime.UtcNow.AddMinutes(-30);`
	`51`	`+ DateTime baseTimestamp = DateTime.UtcNow.AddMinutes(-30);`
`52`	`52`
`53`	`53`	`for (int i = 0; i < NumberOfRecords; i++)`
`54`	`54`	`{`
`55`		`- var trade = CreateTradeInstance(i, baseTimestamp, tickers[random.Next(tickers.Length)], random);`
	`55`	`+ T trade = CreateTradeInstance(i, baseTimestamp, tickers[random.Next(tickers.Length)], random);`
`56`	`56`	`Trades.Add(trade);`
`57`	`57`	`}`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using CmdScale.EntityFrameworkCore.TimescaleDB.Operations;`
	`2`	`+using System.Text;`
`2`	`3`
`3`	`4`	`namespace CmdScale.EntityFrameworkCore.TimescaleDB.Generators`
`4`	`5`	`{`
`@@ -114,7 +115,7 @@ public List<string> Generate(CreateContinuousAggregateOperation operation)`
`114`	`115`	`}`
`115`	`116`
`116`	`117`	`// Build the complete CREATE MATERIALIZED VIEW statement as a single string`
`117`		`- var sqlBuilder = new System.Text.StringBuilder();`
	`118`	`+ StringBuilder sqlBuilder = new();`
`118`	`119`	`sqlBuilder.Append($"CREATE MATERIALIZED VIEW {qualifiedIdentifier}");`
`119`	`120`	`sqlBuilder.AppendLine();`
`120`	`121`	`sqlBuilder.Append($"WITH ({string.Join(", ", withOptions)}) AS");`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public static async Task BulkCopyAsync<T>(`
`55`	`55`	`await writer.StartRowAsync();`
`56`	`56`
`57`	`57`	`// Write each configured column in the specified order`
`58`		`- foreach (var (Getter, DbType) in config.ColumnMappings.Values)`
	`58`	`+ foreach ((Func<T, object?>? Getter, NpgsqlTypes.NpgsqlDbType DbType) in config.ColumnMappings.Values)`
`59`	`59`	`{`
`60`	`60`	`object? value = Getter(item);`
`61`	`61`	`await writer.WriteAsync(value, DbType);`