forked from danbarua/Npgsql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsqlCommandBuilder.cs
More file actions
516 lines (469 loc) · 22.7 KB
/
NpgsqlCommandBuilder.cs
File metadata and controls
516 lines (469 loc) · 22.7 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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
// NpgsqlCommandBuilder.cs
//
// Author:
// Pedro Martínez Juliá (yoros@wanadoo.es)
//
// Copyright (C) 2003 Pedro Martínez Juliá
//
//
// Permission to use, copy, modify, and distribute this software and its
// documentation for any purpose, without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph and the following two paragraphs appear in all copies.
//
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
using System;
using System.Data;
using System.Data.Common;
using System.Globalization;
using System.Linq;
using System.Reflection;
using System.Resources;
using Npgsql.Localization;
using NpgsqlTypes;
namespace Npgsql
{
///<summary>
/// This class is responsible to create database commands for automatic insert, update and delete operations.
///</summary>
[System.ComponentModel.DesignerCategory("")]
public sealed class NpgsqlCommandBuilder : DbCommandBuilder
{
// Commented out because SetRowUpdatingHandler() is commented, and causes an "is never used" warning
// private NpgsqlRowUpdatingEventHandler rowUpdatingHandler;
/// <summary>
/// Initializes a new instance of the <see cref="NpgsqlCommandBuilder"/> class.
/// </summary>
public NpgsqlCommandBuilder()
: this(null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="NpgsqlCommandBuilder"/> class.
/// </summary>
/// <param name="adapter">The adapter.</param>
public NpgsqlCommandBuilder(NpgsqlDataAdapter adapter)
: base()
{
DataAdapter = adapter;
this.QuotePrefix = "\"";
this.QuoteSuffix = "\"";
}
/// <summary>
/// Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.
/// </summary>
/// <returns>
/// The beginning character or characters to use. The default is an empty string.
/// </returns>
/// <PermissionSet>
/// <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
/// </PermissionSet>
public override string QuotePrefix
{
get { return base.QuotePrefix; }
set
{
if (String.IsNullOrEmpty(value))
{
base.QuotePrefix = value;
}
else
{
base.QuotePrefix = "\"";
}
}
}
/// <summary>
/// Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.
/// </summary>
/// <returns>
/// The ending character or characters to use. The default is an empty string.
/// </returns>
/// <PermissionSet>
/// <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
/// </PermissionSet>
public override string QuoteSuffix
{
get { return base.QuoteSuffix; }
set
{
if (String.IsNullOrEmpty(value))
{
base.QuoteSuffix = value;
}
else
{
base.QuoteSuffix = "\"";
}
}
}
///<summary>
///
/// This method is reponsible to derive the command parameter list with values obtained from function definition.
/// It clears the Parameters collection of command. Also, if there is any parameter type which is not supported by Npgsql, an InvalidOperationException will be thrown.
/// Parameters name will be parameter1, parameter2, ...
///</summary>
/// <param name="command">NpgsqlCommand whose function parameters will be obtained.</param>
public static void DeriveParameters(NpgsqlCommand command)
{
try
{
DoDeriveParameters(command);
}
catch
{
command.Parameters.Clear();
throw;
}
}
private static void DoDeriveParameters(NpgsqlCommand command)
{
// See http://www.postgresql.org/docs/9.3/static/catalog-pg-proc.html
command.Parameters.Clear();
// Updated after 0.99.3 to support the optional existence of a name qualifying schema and case insensitivity when the schema ror procedure name do not contain a quote.
// This fixed an incompatibility with NpgsqlCommand.CheckFunctionReturn(String ReturnType)
var serverVersion = command.Connector.ServerVersion;
String query = null;
string procedureName = null;
string schemaName = null;
string[] fullName = command.CommandText.Split('.');
if (fullName.Length > 1 && fullName[0].Length > 0)
{
// proargsmodes is supported for Postgresql 8.1 and above
if (serverVersion >= new Version(8, 1, 0))
query = "select proargnames, proargtypes, proallargtypes, proargmodes from pg_proc p left join pg_namespace n on p.pronamespace = n.oid where proname=:proname and n.nspname=:nspname";
else
query = "select proargnames, proargtypes from pg_proc p left join pg_namespace n on p.pronamespace = n.oid where proname=:proname and n.nspname=:nspname";
schemaName = (fullName[0].IndexOf("\"") != -1) ? fullName[0] : fullName[0].ToLower();
procedureName = (fullName[1].IndexOf("\"") != -1) ? fullName[1] : fullName[1].ToLower();
}
else
{
// proargsmodes is supported for Postgresql 8.1 and above
if (serverVersion >= new Version(8, 1, 0))
query = "select proargnames, proargtypes, proallargtypes, proargmodes from pg_proc where proname = :proname";
else
query = "select proargnames, proargtypes from pg_proc where proname = :proname";
procedureName = (fullName[0].IndexOf("\"") != -1) ? fullName[0] : fullName[0].ToLower();
}
using (NpgsqlCommand c = new NpgsqlCommand(query, command.Connection))
{
c.Parameters.Add(new NpgsqlParameter("proname", NpgsqlDbType.Text));
c.Parameters[0].Value = procedureName.Replace("\"", "").Trim();
if (fullName.Length > 1 && !String.IsNullOrEmpty(schemaName))
{
NpgsqlParameter prm = c.Parameters.Add(new NpgsqlParameter("nspname", NpgsqlDbType.Text));
prm.Value = schemaName.Replace("\"", "").Trim();
}
string[] names = null;
int[] types = null;
char[] modes = null;
using (NpgsqlDataReader rdr = c.ExecuteReader(CommandBehavior.SingleRow | CommandBehavior.SingleResult))
{
if (rdr.Read())
{
if (!rdr.IsDBNull(0))
names = rdr.GetValue(0) as String[];
if (serverVersion >= new Version("8.1.0"))
{
if (!rdr.IsDBNull(2))
types = rdr.GetValue(2) as int[];
if (!rdr.IsDBNull(3))
modes = rdr.GetValue(3) as char[];
}
if (types == null)
{
if (rdr.IsDBNull(1) || rdr.GetString(1) == "")
return; // Parameterless function
types = rdr.GetString(1).Split().Select(int.Parse).ToArray();
}
}
else
throw new InvalidOperationException(String.Format(L10N.InvalidFunctionName, command.CommandText));
}
command.Parameters.Clear();
for (var i = 0; i < types.Length; i++)
{
var param = new NpgsqlParameter();
NpgsqlBackendTypeInfo typeInfo = null;
if (!c.Connector.OidToNameMapping.TryGetValue(types[i], out typeInfo))
throw new InvalidOperationException(String.Format("Invalid parameter type: {0}", types[i]));
param.NpgsqlDbType = typeInfo.NpgsqlDbType;
if (names != null && i < names.Length)
param.ParameterName = ":" + names[i];
else
param.ParameterName = "parameter" + (i + 1);
if (modes == null) // All params are IN, or server < 8.1.0 (and only IN is supported)
param.Direction = ParameterDirection.Input;
else
{
switch (modes[i])
{
case 'i':
param.Direction = ParameterDirection.Input;
break;
case 'o':
param.Direction = ParameterDirection.Output;
break;
case 'b':
param.Direction = ParameterDirection.InputOutput;
break;
case 'v':
throw new NotImplementedException("Cannot derive function parameter of type VARIADIC");
case 't':
throw new NotImplementedException("Cannot derive function parameter of type TABLE");
default:
throw new ArgumentOutOfRangeException("proargmode", modes[i],
"Unknown code in proargmodes while deriving: " + modes[i]);
}
}
command.Parameters.Add(param);
}
}
}
/// <summary>
/// Gets the automatically generated <see cref="NpgsqlCommand"/> object required
/// to perform insertions at the data source.
/// </summary>
/// <returns>
/// The automatically generated <see cref="NpgsqlCommand"/> object required to perform insertions.
/// </returns>
public new NpgsqlCommand GetInsertCommand()
{
return GetInsertCommand(false);
}
/// <summary>
/// Gets the automatically generated <see cref="NpgsqlCommand"/> object required to perform insertions
/// at the data source, optionally using columns for parameter names.
/// </summary>
/// <param name="useColumnsForParameterNames">
/// If <c>true</c>, generate parameter names matching column names, if possible.
/// If <c>false</c>, generate @p1, @p2, and so on.
/// </param>
/// <returns>
/// The automatically generated <see cref="NpgsqlCommand"/> object required to perform insertions.
/// </returns>
public new NpgsqlCommand GetInsertCommand(bool useColumnsForParameterNames)
{
NpgsqlCommand cmd = (NpgsqlCommand) base.GetInsertCommand(useColumnsForParameterNames);
cmd.UpdatedRowSource = UpdateRowSource.None;
return cmd;
}
/// <summary>
/// Gets the automatically generated System.Data.Common.DbCommand object required
/// to perform updates at the data source.
/// </summary>
/// <returns>
/// The automatically generated System.Data.Common.DbCommand object required to perform updates.
/// </returns>
public new NpgsqlCommand GetUpdateCommand()
{
return GetUpdateCommand(false);
}
/// <summary>
/// Gets the automatically generated <see cref="NpgsqlCommand"/> object required to perform updates
/// at the data source, optionally using columns for parameter names.
/// </summary>
/// <param name="useColumnsForParameterNames">
/// If <c>true</c>, generate parameter names matching column names, if possible.
/// If <c>false</c>, generate @p1, @p2, and so on.
/// </param>
/// <returns>
/// The automatically generated <see cref="NpgsqlCommand"/> object required to perform updates.
/// </returns>
public new NpgsqlCommand GetUpdateCommand(bool useColumnsForParameterNames)
{
NpgsqlCommand cmd = (NpgsqlCommand)base.GetUpdateCommand(useColumnsForParameterNames);
cmd.UpdatedRowSource = UpdateRowSource.None;
return cmd;
}
/// <summary>
/// Gets the automatically generated System.Data.Common.DbCommand object required
/// to perform deletions at the data source.
/// </summary>
/// <returns>
/// The automatically generated System.Data.Common.DbCommand object required to perform deletions.
/// </returns>
public new NpgsqlCommand GetDeleteCommand()
{
return GetDeleteCommand(false);
}
/// <summary>
/// Gets the automatically generated <see cref="NpgsqlCommand"/> object required to perform deletions
/// at the data source, optionally using columns for parameter names.
/// </summary>
/// <param name="useColumnsForParameterNames">
/// If <c>true</c>, generate parameter names matching column names, if possible.
/// If <c>false</c>, generate @p1, @p2, and so on.
/// </param>
/// <returns>
/// The automatically generated <see cref="NpgsqlCommand"/> object required to perform deletions.
/// </returns>
public new NpgsqlCommand GetDeleteCommand(bool useColumnsForParameterNames)
{
NpgsqlCommand cmd = (NpgsqlCommand) base.GetDeleteCommand(useColumnsForParameterNames);
cmd.UpdatedRowSource = UpdateRowSource.None;
return cmd;
}
//never used
//private string QualifiedTableName(string schema, string tableName)
//{
// if (schema == null || schema.Length == 0)
// {
// return tableName;
// }
// else
// {
// return schema + "." + tableName;
// }
//}
/*
private static void SetParameterValuesFromRow(NpgsqlCommand command, DataRow row)
{
foreach (NpgsqlParameter parameter in command.Parameters)
{
parameter.Value = row[parameter.SourceColumn, parameter.SourceVersion];
}
}
*/
/// <summary>
/// Applies the parameter information.
/// </summary>
/// <param name="p">The parameter.</param>
/// <param name="row">The row.</param>
/// <param name="statementType">Type of the statement.</param>
/// <param name="whereClause">if set to <c>true</c> [where clause].</param>
protected override void ApplyParameterInfo(DbParameter p, DataRow row, StatementType statementType, bool whereClause)
{
NpgsqlParameter parameter = (NpgsqlParameter) p;
/* TODO: Check if this is the right thing to do.
* ADO.Net seems to set this property to true when creating the parameter for the following query:
* ((@IsNull_FieldName = 1 AND FieldName IS NULL) OR
(FieldName = @Original_FieldName))
* This parameter: @IsNull_FieldName was having its sourcecolumn set to the same name of FieldName.
* This was causing ADO.Net to try to set a value of different type of Int32.
* See bug 1010973 for more info.
*/
if (parameter.SourceColumnNullMapping)
{
parameter.SourceColumn = "";
}
else
parameter.NpgsqlDbType = NpgsqlTypesHelper.GetNativeTypeInfo((Type)row[SchemaTableColumn.DataType]).NpgsqlDbType;
}
/// <summary>
/// Returns the name of the specified parameter in the format of @p#.
/// </summary>
/// <param name="parameterOrdinal">The number to be included as part of the parameter's name..</param>
/// <returns>
/// The name of the parameter with the specified number appended as part of the parameter name.
/// </returns>
protected override string GetParameterName(int parameterOrdinal)
{
return String.Format(CultureInfo.InvariantCulture, "@p{0}", parameterOrdinal);
}
/// <summary>
/// Returns the full parameter name, given the partial parameter name.
/// </summary>
/// <param name="parameterName">The partial name of the parameter.</param>
/// <returns>
/// The full parameter name corresponding to the partial parameter name requested.
/// </returns>
protected override string GetParameterName(string parameterName)
{
return String.Format(CultureInfo.InvariantCulture, "@{0}", parameterName);
}
/// <summary>
/// Returns the placeholder for the parameter in the associated SQL statement.
/// </summary>
/// <param name="parameterOrdinal">The number to be included as part of the parameter's name.</param>
/// <returns>
/// The name of the parameter with the specified number appended.
/// </returns>
protected override string GetParameterPlaceholder(int parameterOrdinal)
{
return GetParameterName(parameterOrdinal);
}
/// <summary>
/// Registers the <see cref="T:NpgsqlCommandBuilder" /> to handle the <see cref="E:NpgsqlDataAdapter.RowUpdating"/> event for a <see cref="T:NpgsqlDataAdapter" />.
/// </summary>
/// <param name="adapter">The <see cref="T:System.Data.Common.DbDataAdapter" /> to be used for the update.</param>
protected override void SetRowUpdatingHandler(DbDataAdapter adapter)
{
var npgsqlAdapter = adapter as NpgsqlDataAdapter;
if (npgsqlAdapter == null)
throw new ArgumentException("adapter needs to be a NpgsqlDataAdapter", "adapter");
// Being called twice for the same adapter means unregister
if (adapter == DataAdapter)
npgsqlAdapter.RowUpdating -= RowUpdatingHandler;
else
npgsqlAdapter.RowUpdating += RowUpdatingHandler;
}
/// <summary>
/// Adds an event handler for the <see cref="NpgsqlDataAdapter.RowUpdating"/> event.
/// </summary>
/// <param name="sender">The sender</param>
/// <param name="e">A <see cref="NpgsqlRowUpdatingEventArgs"/> instance containing information about the event.</param>
private void RowUpdatingHandler(object sender, NpgsqlRowUpdatingEventArgs e)
{
base.RowUpdatingHandler(e);
}
/// <summary>
/// Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier, including properly escaping any embedded quotes in the identifier.
/// </summary>
/// <param name="unquotedIdentifier">The original unquoted identifier.</param>
/// <returns>
/// The quoted version of the identifier. Embedded quotes within the identifier are properly escaped.
/// </returns>
/// <PermissionSet>
/// <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
/// </PermissionSet>
/// <exception cref="System.ArgumentNullException">Unquoted identifier parameter cannot be null</exception>
public override string QuoteIdentifier(string unquotedIdentifier)
{
if (unquotedIdentifier == null)
{
throw new ArgumentNullException("unquotedIdentifier", "Unquoted identifier parameter cannot be null");
}
return String.Format("{0}{1}{2}", this.QuotePrefix, unquotedIdentifier, this.QuoteSuffix);
}
/// <summary>
/// Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier.
/// </summary>
/// <param name="quotedIdentifier">The identifier that will have its embedded quotes removed.</param>
/// <returns>
/// The unquoted identifier, with embedded quotes properly un-escaped.
/// </returns>
/// <PermissionSet>
/// <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*" />
/// </PermissionSet>
/// <exception cref="System.ArgumentNullException">Quoted identifier parameter cannot be null</exception>
public override string UnquoteIdentifier(string quotedIdentifier)
{
if (quotedIdentifier == null)
{
throw new ArgumentNullException("quotedIdentifier", "Quoted identifier parameter cannot be null");
}
string unquotedIdentifier = quotedIdentifier.Trim();
if (unquotedIdentifier.StartsWith(this.QuotePrefix))
{
unquotedIdentifier = unquotedIdentifier.Remove(0, 1);
}
if (unquotedIdentifier.EndsWith(this.QuoteSuffix))
{
unquotedIdentifier = unquotedIdentifier.Remove(unquotedIdentifier.Length - 1, 1);
}
return unquotedIdentifier;
}
}
}