Implement CreateParameter for DbBatchCommand (#5300)

manandre · web-flow · commit 7d5ece2bfb86 · 2023-10-01T21:24:35.000+02:00
Closes #5179
diff --git a/src/Npgsql/NpgsqlBatchCommand.cs b/src/Npgsql/NpgsqlBatchCommand.cs
@@ -38,6 +38,33 @@ public override string CommandText
     /// <inheritdoc cref="DbBatchCommand.Parameters"/>
     public new NpgsqlParameterCollection Parameters { get; } = new();
 
+#pragma warning disable CA1822 // Mark members as static
+
+#if NET8_0_OR_GREATER
+    /// <inheritdoc/>
+    public override NpgsqlParameter CreateParameter()
+#else
+    /// <summary>
+    /// Creates a new instance of a <see cref="NpgsqlParameter"/> object.
+    /// </summary>
+    /// <returns>An <see cref="NpgsqlParameter"/> object.</returns>
+    public NpgsqlParameter CreateParameter()
+#endif
+    => new();
+
+#if NET8_0_OR_GREATER
+    /// <inheritdoc/>
+    public override bool CanCreateParameter
+#else
+    /// <summary>
+    /// Returns whether the <see cref="NpgsqlBatchCommand.CreateParameter"/> method is implemented.
+    /// </summary>
+    public bool CanCreateParameter
+#endif
+    => true;
+
+#pragma warning restore CA1822 // Mark members as static
+
     /// <summary>
     /// Appends an error barrier after this batch command. Defaults to the value of <see cref="NpgsqlBatch.EnableErrorBarriers" /> on the
     /// batch.
diff --git a/src/Npgsql/PublicAPI.Unshipped.txt b/src/Npgsql/PublicAPI.Unshipped.txt
@@ -1,4 +1,4 @@
-﻿#nullable enable
+#nullable enable
 const Npgsql.PostgresErrorCodes.IdleSessionTimeout = "57P05" -> string!
 Npgsql.ChannelBinding
 Npgsql.ChannelBinding.Disable = 0 -> Npgsql.ChannelBinding
@@ -104,6 +104,8 @@ override Npgsql.NpgsqlBatch.Dispose() -> void
 *REMOVED*Npgsql.Replication.PhysicalReplicationConnection.StartReplication(NpgsqlTypes.NpgsqlLogSequenceNumber walLocation, System.Threading.CancellationToken cancellationToken, ulong timeline = 0) -> System.Collections.Generic.IAsyncEnumerable<Npgsql.Replication.XLogDataMessage!>!
 *REMOVED*Npgsql.Replication.PhysicalReplicationSlot.PhysicalReplicationSlot(string! slotName, NpgsqlTypes.NpgsqlLogSequenceNumber? restartLsn = null, ulong? restartTimeline = null) -> void
 *REMOVED*Npgsql.Replication.PhysicalReplicationSlot.RestartTimeline.get -> ulong?
+override Npgsql.NpgsqlBatchCommand.CanCreateParameter.get -> bool
+override Npgsql.NpgsqlBatchCommand.CreateParameter() -> Npgsql.NpgsqlParameter!
 override NpgsqlTypes.NpgsqlCidr.ToString() -> string!
 *REMOVED*static NpgsqlTypes.NpgsqlInet.operator !=(NpgsqlTypes.NpgsqlInet x, NpgsqlTypes.NpgsqlInet y) -> bool
 *REMOVED*static NpgsqlTypes.NpgsqlInet.operator ==(NpgsqlTypes.NpgsqlInet x, NpgsqlTypes.NpgsqlInet y) -> bool
diff --git a/test/Npgsql.Tests/BatchTests.cs b/test/Npgsql.Tests/BatchTests.cs
@@ -288,6 +288,12 @@ public async Task StatementOID()
         Assert.That(batch.BatchCommands[1].OID, Is.EqualTo(0));
     }
 
+    [Test]
+    public void CanCreateParameter() => Assert.True(new NpgsqlBatchCommand().CanCreateParameter);
+
+    [Test]
+    public void CreateParameter() => Assert.NotNull(new NpgsqlBatchCommand().CreateParameter());
+
     #endregion NpgsqlBatchCommand
 
     #region Command behaviors
