{{ message }}
Repository navigation
Expand file tree
/
Copy pathNpgsqlBatchCommand.cs
More file actions
393 lines (337 loc) · 14.2 KB
/
Copy pathNpgsqlBatchCommand.cs
File metadata and controls
393 lines (337 loc) · 14.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
using System;
using System.Buffers;
using System.Collections.Generic;
using System.Data;
using System.Data.Common;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.CompilerServices;
using Microsoft.Extensions.Logging;
using Npgsql.BackendMessages;
using Npgsql.Internal;
namespace Npgsql;
/// <inheritdoc/>
public sealed class NpgsqlBatchCommand : DbBatchCommand
{
internal static readonly List<NpgsqlParameter> EmptyParameters = [];
string _commandText;
/// <inheritdoc/>
[AllowNull]
public override string CommandText
{
get => _commandText;
set
{
_commandText = value ?? string.Empty;
ResetPreparation();
// TODO: Technically should do this also if the parameter list (or type) changes
}
}
/// <inheritdoc/>
public override CommandType CommandType { get; set; } = CommandType.Text;
/// <inheritdoc/>
protected override DbParameterCollection DbParameterCollection => Parameters;
internal NpgsqlParameterCollection? _parameters;
/// <inheritdoc cref="DbBatchCommand.Parameters"/>
public new NpgsqlParameterCollection Parameters => _parameters ??= [];
internal bool HasOutputParameters => _parameters?.HasOutputParameters == true;
/// <inheritdoc/>
public override NpgsqlParameter CreateParameter() => new();
/// <inheritdoc/>
public override bool CanCreateParameter => true;
/// <summary>
/// Appends an error barrier after this batch command. Defaults to the value of <see cref="NpgsqlBatch.EnableErrorBarriers" /> on the
/// batch.
/// </summary>
/// <remarks>
/// <para>
/// By default, any exception in a command causes later commands in the batch to be skipped, and earlier commands to be rolled back.
/// Appending an error barrier ensures that errors from this command (or previous ones) won't cause later commands to be skipped,
/// and that errors from later commands won't cause this command (or previous ones) to be rolled back).
/// </para>
/// <para>
/// Note that if the batch is executed within an explicit transaction, the first error places the transaction in a failed state,
/// causing all later commands to fail in any case. As a result, this option is useful mainly when there is no explicit transaction.
/// </para>
/// <para>
/// At the PostgreSQL wire protocol level, this corresponds to inserting a Sync message after this command, rather than grouping
/// all the batch's commands behind a single terminating Sync.
/// </para>
/// <para>
/// Controlling error barriers on a command-by-command basis is an advanced feature, consider enabling error barriers for the entire
/// batch via <see cref="NpgsqlBatch.EnableErrorBarriers" />.
/// </para>
/// </remarks>
public bool? AppendErrorBarrier { get; set; }
/// <summary>
/// The number of rows affected or retrieved.
/// </summary>
/// <remarks>
/// See the command tag in the CommandComplete message for the meaning of this value for each <see cref="StatementType"/>,
/// https://www.postgresql.org/docs/current/static/protocol-message-formats.html
/// </remarks>
public ulong Rows { get; internal set; }
/// <inheritdoc/>
public override int RecordsAffected
{
get
{
switch (StatementType)
{
case StatementType.Update:
case StatementType.Insert:
case StatementType.Delete:
case StatementType.Copy:
case StatementType.Move:
case StatementType.Merge:
return Rows > int.MaxValue
? throw new OverflowException($"The number of records affected exceeds int.MaxValue. Use {nameof(Rows)}.")
: (int)Rows;
default:
return -1;
}
}
}
/// <summary>
/// Specifies the type of query, e.g. SELECT.
/// </summary>
public StatementType StatementType { get; internal set; }
/// <summary>
/// For an INSERT, the object ID of the inserted row if <see cref="RecordsAffected"/> is 1 and
/// the target table has OIDs; otherwise 0.
/// </summary>
public uint OID { get; internal set; }
/// <summary>
/// The SQL as it will be sent to PostgreSQL, after any rewriting performed by Npgsql (e.g. named to positional parameter
/// placeholders).
/// </summary>
internal string? FinalCommandText { get; set; }
/// <summary>
/// The list of parameters, ordered positionally, as it will be sent to PostgreSQL.
/// </summary>
/// <remarks>
/// If the user provided positional parameters, this references the <see cref="Parameters"/> (in batching mode) or the list
/// backing <see cref="NpgsqlCommand.Parameters" /> (in non-batching) mode. If the user provided named parameters, this is a
/// separate list containing the re-ordered parameters.
/// </remarks>
internal List<NpgsqlParameter> PositionalParameters
{
get => _inputParameters ??= _ownedInputParameters ??= [];
set => _inputParameters = value;
}
internal bool HasParameters => _inputParameters?.Count > 0 || _ownedInputParameters?.Count > 0;
internal List<NpgsqlParameter> CurrentParametersReadOnly => HasParameters ? PositionalParameters : EmptyParameters;
List<NpgsqlParameter>? _ownedInputParameters;
List<NpgsqlParameter>? _inputParameters;
/// <summary>
/// The RowDescription message for this query. If null, the query does not return rows (e.g. INSERT)
/// </summary>
internal RowDescriptionMessage? Description
{
get => PreparedStatement == null ? _description : PreparedStatement.Description;
set
{
if (PreparedStatement == null)
_description = value;
else
PreparedStatement.Description = value;
}
}
RowDescriptionMessage? _description;
/// <summary>
/// If this statement has been automatically prepared, references the <see cref="PreparedStatement"/>.
/// Null otherwise.
/// </summary>
internal PreparedStatement? PreparedStatement
{
get => _preparedStatement is { State: PreparedState.Unprepared }
? _preparedStatement = null
: _preparedStatement;
private set => _preparedStatement = value;
}
PreparedStatement? _preparedStatement;
internal NpgsqlConnector? ConnectorPreparedOn { get; set; }
internal bool IsPreparing;
/// <summary>
/// Holds the server-side (prepared) ASCII statement name. Empty string for non-prepared statements.
/// </summary>
internal byte[] StatementName => PreparedStatement?.Name ?? [];
/// <summary>
/// Whether this statement has already been prepared (including automatic preparation).
/// </summary>
internal bool IsPrepared => PreparedStatement?.IsPrepared == true;
/// <summary>
/// Returns a prepared statement for this statement (including automatic preparation).
/// </summary>
internal bool TryGetPrepared([NotNullWhen(true)] out PreparedStatement? preparedStatement)
{
preparedStatement = PreparedStatement;
return preparedStatement?.IsPrepared == true;
}
/// <summary>
/// Initializes a new <see cref="NpgsqlBatchCommand"/>.
/// </summary>
public NpgsqlBatchCommand() : this(string.Empty) {}
/// <summary>
/// Initializes a new <see cref="NpgsqlBatchCommand"/>.
/// </summary>
/// <param name="commandText">The text of the <see cref="NpgsqlBatchCommand"/>.</param>
public NpgsqlBatchCommand(string commandText)
=> _commandText = commandText;
internal bool ExplicitPrepare(NpgsqlConnector connector)
{
if (!IsPrepared)
{
PreparedStatement = connector.PreparedStatementManager.GetOrAddExplicit(this);
if (PreparedStatement?.State == PreparedState.NotPrepared)
{
PreparedStatement.State = PreparedState.BeingPrepared;
IsPreparing = true;
return true;
}
}
return false;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
internal bool TryAutoPrepare(NpgsqlConnector connector)
{
// If this statement isn't prepared, see if it gets implicitly prepared.
// Note that this may return null (not enough usages for automatic preparation).
if (!TryGetPrepared(out var preparedStatement))
preparedStatement = PreparedStatement = connector.PreparedStatementManager.TryGetAutoPrepared(this);
if (preparedStatement is not null)
{
if (preparedStatement.State == PreparedState.NotPrepared)
{
preparedStatement.State = PreparedState.BeingPrepared;
IsPreparing = true;
}
return true;
}
return false;
}
internal void Reset()
{
CommandText = string.Empty;
StatementType = StatementType.Select;
_description = null;
Rows = 0;
OID = 0;
PreparedStatement = null;
if (ReferenceEquals(_inputParameters, _ownedInputParameters))
PositionalParameters.Clear();
else if (_inputParameters is not null)
_inputParameters = null; // We're pointing at a user's NpgsqlParameterCollection
Debug.Assert(_inputParameters is null || _inputParameters.Count == 0);
Debug.Assert(_ownedInputParameters is null || _ownedInputParameters.Count == 0);
}
internal void ApplyCommandComplete(CommandCompleteMessage msg)
{
StatementType = msg.StatementType;
Rows = msg.Rows;
OID = msg.OID;
}
internal void ResetPreparation()
{
ConnectorPreparedOn = null;
PreparedStatement = null;
}
internal void PopulateOutputParameters(NpgsqlDataReader reader, ILogger logger)
{
Debug.Assert(_parameters is not null);
var parameters = _parameters;
var fieldCount = reader.FieldCount;
switch (parameters.PlaceholderType)
{
case PlaceholderType.Mixed:
case PlaceholderType.Named:
{
// In the case of named and mixed parameters we first try to populate all parameters with a named column match.
// For backwards compat we allow populating named parameters as long as they haven't been filled yet.
// So for every column that we couldn't match by name we fill the first output direction parameter that wasn't filled previously.
// This means a row like {"a" => 1, "some_field" => 2} will populate the following output db params {"a" => 1, "b" => 2}.
// And a row like {"some_field" => 1, "a" => 2} will populate them as follows {"a" => 2, "b" => 1}.
var parameterIndices = new ArraySegment<int>(ArrayPool<int>.Shared.Rent(fieldCount), 0, fieldCount);
var secondPassOrdinal = -1;
for (var ordinal = 0; ordinal < fieldCount; ordinal++)
{
var name = reader.GetName(ordinal);
var i = parameters.IndexOf(name);
if (i is not -1 && parameters[i] is { IsOutputDirection: true } parameter)
{
SetValue(reader, logger, parameter, ordinal, i);
parameterIndices[ordinal] = i;
}
else
{
parameterIndices[ordinal] = -1;
if (secondPassOrdinal is -1)
secondPassOrdinal = ordinal;
}
}
if (secondPassOrdinal is -1)
{
ArrayPool<int>.Shared.Return(parameterIndices.Array!);
break;
}
// This set will also contain -1, but that's not a valid index so we can ignore it is included.
var matchedParameters = new HashSet<int>(parameterIndices);
var parameterList = parameters.InternalList;
for (var i = 0; i < parameterList.Count; i++)
{
// Find an output parameter that wasn't matched by name.
if (parameterList[i] is not { IsOutputDirection: true } parameter || matchedParameters.Contains(i))
continue;
SetValue(reader, logger, parameter, secondPassOrdinal, i);
// And find the next unhandled ordinal.
secondPassOrdinal = NextSecondPassOrdinal(parameterIndices, secondPassOrdinal);
if (secondPassOrdinal is -1)
break;
}
ArrayPool<int>.Shared.Return(parameterIndices.Array!);
break;
static int NextSecondPassOrdinal(ArraySegment<int> indices, int offset)
{
for (var i = offset + 1; i < indices.Count; i++)
{
if (indices[i] is -1)
return i;
}
return -1;
}
}
case PlaceholderType.Positional:
{
var parameterList = parameters.InternalList;
var ordinal = 0;
for (var i = 0; i < parameterList.Count; i++)
{
if (parameterList[i] is not { IsOutputDirection: true } parameter)
continue;
SetValue(reader, logger, parameter, ordinal, i);
ordinal++;
if (ordinal == fieldCount)
break;
}
break;
}
}
static void SetValue(NpgsqlDataReader reader, ILogger logger, NpgsqlParameter p, int ordinal, int index)
{
try
{
p.SetOutputValue(reader, ordinal);
}
catch (Exception ex)
{
logger.LogDebug(ex, "Failed to set value on output parameter instance '{ParameterNameOrIndex}' for output parameter {OutputName}",
p.ParameterName is NpgsqlParameter.PositionalName ? index : p.ParameterName, reader.GetName(ordinal));
throw;
}
}
}
/// <summary>
/// Returns the <see cref="CommandText"/>.
/// </summary>
public override string ToString() => CommandText;
}
You can’t perform that action at this time.