Class NpgsqlCommandBuilder

This class creates database commands for automatic insert, update and delete operations.

Inheritance

object

NpgsqlCommandBuilder

Namespace: Npgsql

Assembly: Npgsql.dll

Syntax

public sealed class NpgsqlCommandBuilder : DbCommandBuilder

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
string	The beginning character or characters to use. The default is an empty string.

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
string	The ending character or characters to use. The default is an empty string.

Methods

ApplyParameterInfo(DbParameter, DataRow, StatementType, bool)

Applies the parameter information.

Declaration

protected override void ApplyParameterInfo(DbParameter p, DataRow row, StatementType statementType, bool whereClause)

Parameters

Type	Name	Description
DbParameter	p	The parameter.
DataRow	row	The row.
System.Data.StatementType	statementType	Type of the statement.
bool	whereClause	If set to true [where clause].

DeriveParameters(NpgsqlCommand)

This method is responsible 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(bool)

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
bool	useColumnsForParameterNames	If true, generate parameter names matching column names, if possible. If false, generate @p1, @p2, and so on.

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(bool)

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
bool	useColumnsForParameterNames	If true, generate parameter names matching column names, if possible. If false, generate @p1, @p2, and so on.

Returns

Type	Description
NpgsqlCommand	The automatically generated NpgsqlCommand object required to perform insertions.

GetParameterName(int)

Returns the name of the specified parameter in the format of @p#.

Declaration

protected override string GetParameterName(int parameterOrdinal)

Parameters

Type	Name	Description
int	parameterOrdinal	The number to be included as part of the parameter's name..

Returns

Type	Description
string	The name of the parameter with the specified number appended as part of the parameter name.

GetParameterName(string)

Returns the full parameter name, given the partial parameter name.

Declaration

protected override string GetParameterName(string parameterName)

Parameters

Type	Name	Description
string	parameterName	The partial name of the parameter.

Returns

Type	Description
string	The full parameter name corresponding to the partial parameter name requested.

GetParameterPlaceholder(int)

Returns the placeholder for the parameter in the associated SQL statement.

Declaration

protected override string GetParameterPlaceholder(int parameterOrdinal)

Parameters

Type	Name	Description
int	parameterOrdinal	The number to be included as part of the parameter's name.

Returns

Type	Description
string	The name of the parameter with the specified number appended.

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(bool)

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
bool	useColumnsForParameterNames	If true, generate parameter names matching column names, if possible. If false, generate @p1, @p2, and so on.

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
string	unquotedIdentifier	The original unquoted identifier.

Returns

Type	Description
string	The quoted version of the identifier. Embedded quotes within the identifier are properly escaped.

SetRowUpdatingHandler(DbDataAdapter)

Registers the NpgsqlCommandBuilder to handle the RowUpdating event for a NpgsqlDataAdapter.

Declaration

protected override void SetRowUpdatingHandler(DbDataAdapter adapter)

Parameters

Type	Name	Description
DbDataAdapter	adapter	The to be used for the update.

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
string	quotedIdentifier	The identifier that will have its embedded quotes removed.

Returns

Type	Description
string	The unquoted identifier, with embedded quotes properly un-escaped.