Class NpgsqlCommandBuilder
This class is responsible to create database commands for automatic insert, update and delete operations.
Inheritance
Implements
Inherited Members
Namespace: Npgsql
Assembly: Npgsql.dll
Syntax
public sealed class NpgsqlCommandBuilder : DbCommandBuilder, IComponent, IDisposable
Constructors
NpgsqlCommandBuilder()
Initializes a new instance of the NpgsqlCommandBuilder class.
Declaration
public NpgsqlCommandBuilder()
NpgsqlCommandBuilder(NpgsqlDataAdapter)
Initializes a new instance of the NpgsqlCommandBuilder class.
Declaration
public NpgsqlCommandBuilder(NpgsqlDataAdapter adapter)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlDataAdapter | adapter | The adapter. |
Properties
QuotePrefix
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.
Declaration
public override string QuotePrefix { get; set; }
Property Value
Type | Description |
---|---|
System.String | The beginning character or characters to use. The default is an empty string. |
Overrides
QuoteSuffix
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.
Declaration
public override string QuoteSuffix { get; set; }
Property Value
Type | Description |
---|---|
System.String | The ending character or characters to use. The default is an empty string. |
Overrides
Methods
ApplyParameterInfo(DbParameter, DataRow, StatementType, Boolean)
Applies the parameter information.
Declaration
protected override void ApplyParameterInfo(DbParameter p, DataRow row, StatementType statementType, bool whereClause)
Parameters
Type | Name | Description |
---|---|---|
System.Data.Common.DbParameter | p | The parameter. |
System.Data.DataRow | row | The row. |
System.Data.StatementType | statementType | Type of the statement. |
System.Boolean | whereClause | if set to |
Overrides
DeriveParameters(NpgsqlCommand)
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, ... for CommandType.StoredProcedure and named after the placeholder for CommandType.Text
Declaration
public static void DeriveParameters(NpgsqlCommand command)
Parameters
Type | Name | Description |
---|---|---|
NpgsqlCommand | command | NpgsqlCommand whose function parameters will be obtained. |
GetDeleteCommand()
Gets the automatically generated System.Data.Common.DbCommand object required to perform deletions at the data source.
Declaration
public NpgsqlCommand GetDeleteCommand()
Returns
Type | Description |
---|---|
NpgsqlCommand | The automatically generated System.Data.Common.DbCommand object required to perform deletions. |
GetDeleteCommand(Boolean)
Gets the automatically generated NpgsqlCommand object required to perform deletions at the data source, optionally using columns for parameter names.
Declaration
public NpgsqlCommand GetDeleteCommand(bool useColumnsForParameterNames)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | useColumnsForParameterNames | If |
Returns
Type | Description |
---|---|
NpgsqlCommand | The automatically generated NpgsqlCommand object required to perform deletions. |
GetInsertCommand()
Gets the automatically generated NpgsqlCommand object required to perform insertions at the data source.
Declaration
public NpgsqlCommand GetInsertCommand()
Returns
Type | Description |
---|---|
NpgsqlCommand | The automatically generated NpgsqlCommand object required to perform insertions. |
GetInsertCommand(Boolean)
Gets the automatically generated NpgsqlCommand object required to perform insertions at the data source, optionally using columns for parameter names.
Declaration
public NpgsqlCommand GetInsertCommand(bool useColumnsForParameterNames)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | useColumnsForParameterNames | If |
Returns
Type | Description |
---|---|
NpgsqlCommand | The automatically generated NpgsqlCommand object required to perform insertions. |
GetParameterName(Int32)
Returns the name of the specified parameter in the format of @p#.
Declaration
protected override string GetParameterName(int parameterOrdinal)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | parameterOrdinal | The number to be included as part of the parameter's name.. |
Returns
Type | Description |
---|---|
System.String | The name of the parameter with the specified number appended as part of the parameter name. |
Overrides
GetParameterName(String)
Returns the full parameter name, given the partial parameter name.
Declaration
protected override string GetParameterName(string parameterName)
Parameters
Type | Name | Description |
---|---|---|
System.String | parameterName | The partial name of the parameter. |
Returns
Type | Description |
---|---|
System.String | The full parameter name corresponding to the partial parameter name requested. |
Overrides
GetParameterPlaceholder(Int32)
Returns the placeholder for the parameter in the associated SQL statement.
Declaration
protected override string GetParameterPlaceholder(int parameterOrdinal)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | parameterOrdinal | The number to be included as part of the parameter's name. |
Returns
Type | Description |
---|---|
System.String | The name of the parameter with the specified number appended. |
Overrides
GetUpdateCommand()
Gets the automatically generated System.Data.Common.DbCommand object required to perform updates at the data source.
Declaration
public NpgsqlCommand GetUpdateCommand()
Returns
Type | Description |
---|---|
NpgsqlCommand | The automatically generated System.Data.Common.DbCommand object required to perform updates. |
GetUpdateCommand(Boolean)
Gets the automatically generated NpgsqlCommand object required to perform updates at the data source, optionally using columns for parameter names.
Declaration
public NpgsqlCommand GetUpdateCommand(bool useColumnsForParameterNames)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | useColumnsForParameterNames | If |
Returns
Type | Description |
---|---|
NpgsqlCommand | The automatically generated NpgsqlCommand object required to perform updates. |
QuoteIdentifier(String)
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.
Declaration
public override string QuoteIdentifier(string unquotedIdentifier)
Parameters
Type | Name | Description |
---|---|---|
System.String | unquotedIdentifier | The original unquoted identifier. |
Returns
Type | Description |
---|---|
System.String | The quoted version of the identifier. Embedded quotes within the identifier are properly escaped. |
Overrides
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Unquoted identifier parameter cannot be null |
SetRowUpdatingHandler(DbDataAdapter)
Registers the NpgsqlCommandBuilder to handle the RowUpdating event for a NpgsqlDataAdapter.
Declaration
protected override void SetRowUpdatingHandler(DbDataAdapter adapter)
Parameters
Type | Name | Description |
---|---|---|
System.Data.Common.DbDataAdapter | adapter | The System.Data.Common.DbDataAdapter to be used for the update. |
Overrides
UnquoteIdentifier(String)
Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier.
Declaration
public override string UnquoteIdentifier(string quotedIdentifier)
Parameters
Type | Name | Description |
---|---|---|
System.String | quotedIdentifier | The identifier that will have its embedded quotes removed. |
Returns
Type | Description |
---|---|
System.String | The unquoted identifier, with embedded quotes properly un-escaped. |
Overrides
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Quoted identifier parameter cannot be null |