Allowing using SchemaOnly without setting parameter values (#4673)

roji · web-flow · commit 58e3a4cd0cdd · 2022-09-19T22:38:56.000Z
Fixes #4672
diff --git a/src/Npgsql/NpgsqlCommand.cs b/src/Npgsql/NpgsqlCommand.cs
@@ -634,7 +634,7 @@ Task Prepare(bool async, CancellationToken cancellationToken = default)
         {
             foreach (var batchCommand in InternalBatchCommands)
             {
-                batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validate: false);
+                batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validateValues: false);
                 ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand);
 
                 needToPrepare = batchCommand.ExplicitPrepare(connector) || needToPrepare;
@@ -645,7 +645,7 @@ Task Prepare(bool async, CancellationToken cancellationToken = default)
         }
         else
         {
-            Parameters.ProcessParameters(connector.TypeMapper, validate: false);
+            Parameters.ProcessParameters(connector.TypeMapper, validateValues: false);
             ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand: null);
 
             foreach (var batchCommand in InternalBatchCommands)
@@ -1307,6 +1307,8 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior
 
                 Task? sendTask;
 
+                var validateParameterValues = !behavior.HasFlag(CommandBehavior.SchemaOnly);
+
                 try
                 {
                     switch (IsExplicitlyPrepared)
@@ -1324,9 +1326,9 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior
 
                         if (IsWrappedByBatch)
                             foreach (var batchCommand in InternalBatchCommands)
-                                batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validate: true);
+                                batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);
                         else
-                            Parameters.ProcessParameters(connector.TypeMapper, validate: true);
+                            Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);
 
                         NpgsqlEventSource.Log.CommandStartPrepared();
                         break;
@@ -1340,7 +1342,7 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior
                             {
                                 var batchCommand = InternalBatchCommands[i];
 
-                                batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validate: true);
+                                batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);
                                 ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand);
 
                                 if (connector.Settings.MaxAutoPrepare > 0 && batchCommand.TryAutoPrepare(connector))
@@ -1349,7 +1351,7 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior
                         }
                         else
                         {
-                            Parameters.ProcessParameters(connector.TypeMapper, validate: true);
+                            Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);
                             ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand: null);
 
                             if (connector.Settings.MaxAutoPrepare > 0)
@@ -1441,13 +1443,13 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior
                 {
                     foreach (var batchCommand in InternalBatchCommands)
                     {
-                        batchCommand.Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validate: true);
+                        batchCommand.Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validateValues: true);
                         ProcessRawQuery(null, standardConformingStrings: true, batchCommand);
                     }
                 }
                 else
                 {
-                    Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validate: true);
+                    Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validateValues: true);
                     ProcessRawQuery(null, standardConformingStrings: true, batchCommand: null);
                 }
 
diff --git a/src/Npgsql/NpgsqlParameterCollection.cs b/src/Npgsql/NpgsqlParameterCollection.cs
@@ -679,7 +679,7 @@ internal void CloneTo(NpgsqlParameterCollection other)
         }
     }
 
-    internal void ProcessParameters(ConnectorTypeMapper typeMapper, bool validate)
+    internal void ProcessParameters(ConnectorTypeMapper typeMapper, bool validateValues)
     {
         HasOutputParameters = false;
         PlaceholderType = PlaceholderType.NoParameters;
@@ -736,7 +736,7 @@ internal void ProcessParameters(ConnectorTypeMapper typeMapper, bool validate)
 
             p.Bind(typeMapper);
 
-            if (validate)
+            if (validateValues)
             {
                 p.LengthCache?.Clear();
                 p.ValidateAndGetLength();
diff --git a/test/Npgsql.Tests/PrepareTests.cs b/test/Npgsql.Tests/PrepareTests.cs
@@ -109,7 +109,7 @@ public void Unprepare()
     public Task UnprepareAsync()
         => Unprepare(true);
 
-    private async Task Unprepare(bool async)
+    async Task Unprepare(bool async)
     {
         using var conn = OpenConnectionAndUnprepare();
         AssertNumPreparedStatements(conn, 0);
diff --git a/test/Npgsql.Tests/ReaderNewSchemaTests.cs b/test/Npgsql.Tests/ReaderNewSchemaTests.cs
@@ -723,6 +723,22 @@ public async Task IsAliased()
         Assert.That(columns[2].IsAliased, Is.Null);
     }
 
+    [Test] // #4672
+    public async Task With_parameter_without_value()
+    {
+        await using var conn = await OpenConnectionAsync();
+        await using var _ = await CreateTempTable(conn, "foo INTEGER", out var table);
+
+        using var cmd = new NpgsqlCommand($"SELECT foo FROM {table} WHERE foo > @p", conn)
+        {
+            Parameters = { new() { ParameterName = "p", NpgsqlDbType = NpgsqlTypes.NpgsqlDbType.Integer } }
+        };
+        await using var reader = await cmd.ExecuteReaderAsync(CommandBehavior.SchemaOnly | CommandBehavior.KeyInfo);
+
+        var columns = await GetColumnSchema(reader);
+        Assert.That(columns[0].ColumnName, Is.EqualTo("foo"));
+    }
+
     #region Not supported
 
     [Test]

Original file line number	Diff line number	Diff line change
`@@ -634,7 +634,7 @@ Task Prepare(bool async, CancellationToken cancellationToken = default)`
`634`	`634`	`{`
`635`	`635`	`foreach (var batchCommand in InternalBatchCommands)`
`636`	`636`	`{`
`637`		`- batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validate: false);`
	`637`	`+ batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validateValues: false);`
`638`	`638`	`ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand);`
`639`	`639`
`640`	`640`	`needToPrepare = batchCommand.ExplicitPrepare(connector) \|\| needToPrepare;`
`@@ -645,7 +645,7 @@ Task Prepare(bool async, CancellationToken cancellationToken = default)`
`645`	`645`	`}`
`646`	`646`	`else`
`647`	`647`	`{`
`648`		`- Parameters.ProcessParameters(connector.TypeMapper, validate: false);`
	`648`	`+ Parameters.ProcessParameters(connector.TypeMapper, validateValues: false);`
`649`	`649`	`ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand: null);`
`650`	`650`
`651`	`651`	`foreach (var batchCommand in InternalBatchCommands)`
`@@ -1307,6 +1307,8 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior`
`1307`	`1307`
`1308`	`1308`	`Task? sendTask;`
`1309`	`1309`
	`1310`	`+ var validateParameterValues = !behavior.HasFlag(CommandBehavior.SchemaOnly);`
	`1311`	`+`
`1310`	`1312`	`try`
`1311`	`1313`	`{`
`1312`	`1314`	`switch (IsExplicitlyPrepared)`
`@@ -1324,9 +1326,9 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior`
`1324`	`1326`
`1325`	`1327`	`if (IsWrappedByBatch)`
`1326`	`1328`	`foreach (var batchCommand in InternalBatchCommands)`
`1327`		`- batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validate: true);`
	`1329`	`+ batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);`
`1328`	`1330`	`else`
`1329`		`- Parameters.ProcessParameters(connector.TypeMapper, validate: true);`
	`1331`	`+ Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);`
`1330`	`1332`
`1331`	`1333`	`NpgsqlEventSource.Log.CommandStartPrepared();`
`1332`	`1334`	`break;`
`@@ -1340,7 +1342,7 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior`
`1340`	`1342`	`{`
`1341`	`1343`	`var batchCommand = InternalBatchCommands[i];`
`1342`	`1344`
`1343`		`- batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validate: true);`
	`1345`	`+ batchCommand.Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);`
`1344`	`1346`	`ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand);`
`1345`	`1347`
`1346`	`1348`	`if (connector.Settings.MaxAutoPrepare > 0 && batchCommand.TryAutoPrepare(connector))`
`@@ -1349,7 +1351,7 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior`
`1349`	`1351`	`}`
`1350`	`1352`	`else`
`1351`	`1353`	`{`
`1352`		`- Parameters.ProcessParameters(connector.TypeMapper, validate: true);`
	`1354`	`+ Parameters.ProcessParameters(connector.TypeMapper, validateParameterValues);`
`1353`	`1355`	`ProcessRawQuery(connector.SqlQueryParser, connector.UseConformingStrings, batchCommand: null);`
`1354`	`1356`
`1355`	`1357`	`if (connector.Settings.MaxAutoPrepare > 0)`
`@@ -1441,13 +1443,13 @@ internal virtual async ValueTask<NpgsqlDataReader> ExecuteReader(CommandBehavior`
`1441`	`1443`	`{`
`1442`	`1444`	`foreach (var batchCommand in InternalBatchCommands)`
`1443`	`1445`	`{`
`1444`		`- batchCommand.Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validate: true);`
	`1446`	`+ batchCommand.Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validateValues: true);`
`1445`	`1447`	`ProcessRawQuery(null, standardConformingStrings: true, batchCommand);`
`1446`	`1448`	`}`
`1447`	`1449`	`}`
`1448`	`1450`	`else`
`1449`	`1451`	`{`
`1450`		`- Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validate: true);`
	`1452`	`+ Parameters.ProcessParameters(pool.MultiplexingTypeMapper!, validateValues: true);`
`1451`	`1453`	`ProcessRawQuery(null, standardConformingStrings: true, batchCommand: null);`
`1452`	`1454`	`}`
`1453`	`1455`
Original file line number	Diff line number	Diff line change
`@@ -679,7 +679,7 @@ internal void CloneTo(NpgsqlParameterCollection other)`
`679`	`679`	`}`
`680`	`680`	`}`
`681`	`681`
`682`		`- internal void ProcessParameters(ConnectorTypeMapper typeMapper, bool validate)`
	`682`	`+ internal void ProcessParameters(ConnectorTypeMapper typeMapper, bool validateValues)`
`683`	`683`	`{`
`684`	`684`	`HasOutputParameters = false;`
`685`	`685`	`PlaceholderType = PlaceholderType.NoParameters;`
`@@ -736,7 +736,7 @@ internal void ProcessParameters(ConnectorTypeMapper typeMapper, bool validate)`
`736`	`736`
`737`	`737`	`p.Bind(typeMapper);`
`738`	`738`
`739`		`- if (validate)`
	`739`	`+ if (validateValues)`
`740`	`740`	`{`
`741`	`741`	`p.LengthCache?.Clear();`
`742`	`742`	`p.ValidateAndGetLength();`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ public void Unprepare()`
`109`	`109`	`public Task UnprepareAsync()`
`110`	`110`	`=> Unprepare(true);`
`111`	`111`
`112`		`- private async Task Unprepare(bool async)`
	`112`	`+ async Task Unprepare(bool async)`
`113`	`113`	`{`
`114`	`114`	`using var conn = OpenConnectionAndUnprepare();`
`115`	`115`	`AssertNumPreparedStatements(conn, 0);`