Show / Hide Table of Contents

Class NpgsqlParameter

This class represents a parameter to a command that will be sent to server

Inheritance
System.Object
System.MarshalByRefObject
System.Data.Common.DbParameter
NpgsqlParameter
NpgsqlParameter<T>
Implements
System.Data.IDbDataParameter
System.Data.IDataParameter
System.ICloneable
Inherited Members
System.Data.Common.DbParameter.System.Data.IDbDataParameter.Precision
System.Data.Common.DbParameter.System.Data.IDbDataParameter.Scale
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.InitializeLifetimeService()
System.MarshalByRefObject.CreateObjRef(System.Type)
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Npgsql
Assembly: Npgsql.dll
Syntax
public class NpgsqlParameter : DbParameter, IDbDataParameter, IDataParameter, ICloneable

Constructors

NpgsqlParameter()

Initializes a new instance of the NpgsqlParameter class.

Declaration
public NpgsqlParameter()

NpgsqlParameter(String, NpgsqlDbType)

Initializes a new instance of the NpgsqlParameter class with the parameter name and the data type.

Declaration
public NpgsqlParameter(string parameterName, NpgsqlDbType parameterType)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

NpgsqlDbType parameterType

One of the NpgsqlDbType values.

NpgsqlParameter(String, NpgsqlDbType, Int32)

Initializes a new instance of the NpgsqlParameter.

Declaration
public NpgsqlParameter(string parameterName, NpgsqlDbType parameterType, int size)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

NpgsqlDbType parameterType

One of the NpgsqlDbType values.

System.Int32 size

The length of the parameter.

NpgsqlParameter(String, NpgsqlDbType, Int32, String)

Initializes a new instance of the NpgsqlParameter

Declaration
public NpgsqlParameter(string parameterName, NpgsqlDbType parameterType, int size, string sourceColumn)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

NpgsqlDbType parameterType

One of the NpgsqlDbType values.

System.Int32 size

The length of the parameter.

System.String sourceColumn

The name of the source column.

NpgsqlParameter(String, NpgsqlDbType, Int32, String, ParameterDirection, Boolean, Byte, Byte, DataRowVersion, Object)

Initializes a new instance of the NpgsqlParameter.

Declaration
public NpgsqlParameter(string parameterName, NpgsqlDbType parameterType, int size, string sourceColumn, ParameterDirection direction, bool isNullable, byte precision, byte scale, DataRowVersion sourceVersion, object value)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

NpgsqlDbType parameterType

One of the NpgsqlDbType values.

System.Int32 size

The length of the parameter.

System.String sourceColumn

The name of the source column.

System.Data.ParameterDirection direction

One of the System.Data.ParameterDirection values.

System.Boolean isNullable

true if the value of the field can be null, otherwise false.

System.Byte precision

The total number of digits to the left and right of the decimal point to which Value is resolved.

System.Byte scale

The total number of decimal places to which Value is resolved.

System.Data.DataRowVersion sourceVersion

One of the System.Data.DataRowVersion values.

System.Object value

An System.Object that is the value of the NpgsqlParameter.

NpgsqlParameter(String, DbType)

Initializes a new instance of the NpgsqlParameter.

Declaration
public NpgsqlParameter(string parameterName, DbType parameterType)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

System.Data.DbType parameterType

One of the System.Data.DbType values.

NpgsqlParameter(String, DbType, Int32)

Initializes a new instance of the NpgsqlParameter.

Declaration
public NpgsqlParameter(string parameterName, DbType parameterType, int size)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

System.Data.DbType parameterType

One of the System.Data.DbType values.

System.Int32 size

The length of the parameter.

NpgsqlParameter(String, DbType, Int32, String)

Initializes a new instance of the NpgsqlParameter.

Declaration
public NpgsqlParameter(string parameterName, DbType parameterType, int size, string sourceColumn)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

System.Data.DbType parameterType

One of the System.Data.DbType values.

System.Int32 size

The length of the parameter.

System.String sourceColumn

The name of the source column.

NpgsqlParameter(String, DbType, Int32, String, ParameterDirection, Boolean, Byte, Byte, DataRowVersion, Object)

Initializes a new instance of the NpgsqlParameter.

Declaration
public NpgsqlParameter(string parameterName, DbType parameterType, int size, string sourceColumn, ParameterDirection direction, bool isNullable, byte precision, byte scale, DataRowVersion sourceVersion, object value)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

System.Data.DbType parameterType

One of the System.Data.DbType values.

System.Int32 size

The length of the parameter.

System.String sourceColumn

The name of the source column.

System.Data.ParameterDirection direction

One of the System.Data.ParameterDirection values.

System.Boolean isNullable

true if the value of the field can be null, otherwise false.

System.Byte precision

The total number of digits to the left and right of the decimal point to which Value is resolved.

System.Byte scale

The total number of decimal places to which Value is resolved.

System.Data.DataRowVersion sourceVersion

One of the System.Data.DataRowVersion values.

System.Object value

An System.Object that is the value of the NpgsqlParameter.

NpgsqlParameter(String, Object)

Initializes a new instance of the NpgsqlParameter class with the parameter name and a value of the new NpgsqlParameter.

Declaration
public NpgsqlParameter(string parameterName, object value)
Parameters
Type Name Description
System.String parameterName

The name of the parameter to map.

System.Object value

An System.Object that is the value of the NpgsqlParameter.

Remarks

When you specify an System.Object in the value parameter, the System.Data.DbType is inferred from the .NET Framework type of the Object.

When using this constructor, you must be aware of a possible misuse of the constructor which takes a DbType parameter. This happens when calling this constructor passing an int 0 and the compiler thinks you are passing a value of DbType. Use

 Convert.ToInt32(value) 
for example to have compiler calling the correct constructor.

Properties

Collection

The collection to which this parameter belongs, if any.

Declaration
public NpgsqlParameterCollection Collection { get; set; }
Property Value
Type Description
NpgsqlParameterCollection

ConvertedValue

Can be used to communicate a value from the validation phase to the writing phase. To be used by type handlers only.

Declaration
public object ConvertedValue { get; set; }
Property Value
Type Description
System.Object

DataTypeName

Used to specify which PostgreSQL type will be sent to the database for this parameter.

Declaration
public string DataTypeName { get; set; }
Property Value
Type Description
System.String

DbType

Gets or sets the System.Data.DbType of the parameter.

Declaration
public override sealed DbType DbType { get; set; }
Property Value
Type Description
System.Data.DbType

One of the System.Data.DbType values. The default is Object.

Overrides
System.Data.Common.DbParameter.DbType

Direction

Declaration
public override sealed ParameterDirection Direction { get; set; }
Property Value
Type Description
System.Data.ParameterDirection
Overrides
System.Data.Common.DbParameter.Direction

IsNullable

Declaration
public override sealed bool IsNullable { get; set; }
Property Value
Type Description
System.Boolean
Overrides
System.Data.Common.DbParameter.IsNullable

NpgsqlDbType

Gets or sets the NpgsqlDbType of the parameter.

Declaration
[DbProviderSpecificTypeProperty(true)]
public NpgsqlDbType NpgsqlDbType { get; set; }
Property Value
Type Description
NpgsqlDbType

One of the NpgsqlDbType values. The default is Unknown.

NpgsqlValue

Gets or sets the value of the parameter.

Declaration
[TypeConverter(typeof(StringConverter))]
public object NpgsqlValue { get; set; }
Property Value
Type Description
System.Object

An System.Object that is the value of the parameter. The default value is null.

ParameterName

Gets or sets The name of the NpgsqlParameter.

Declaration
public override sealed string ParameterName { get; set; }
Property Value
Type Description
System.String

The name of the NpgsqlParameter. The default is an empty string.

Overrides
System.Data.Common.DbParameter.ParameterName

PostgresType

The PostgreSQL data type, such as int4 or text, as discovered from pg_type. This property is automatically set if parameters have been derived via DeriveParameters(NpgsqlCommand) and can be used to acquire additional information about the parameters' data type.

Declaration
public PostgresType PostgresType { get; }
Property Value
Type Description
PostgresType

Precision

Gets or sets the maximum number of digits used to represent the Value property.

Declaration
public byte Precision { get; set; }
Property Value
Type Description
System.Byte

The maximum number of digits used to represent the Value property. The default value is 0, which indicates that the data provider sets the precision for Value.

Scale

Gets or sets the number of decimal places to which Value is resolved.

Declaration
public byte Scale { get; set; }
Property Value
Type Description
System.Byte

The number of decimal places to which Value is resolved. The default is 0.

Size

Declaration
public override sealed int Size { get; set; }
Property Value
Type Description
System.Int32
Overrides
System.Data.Common.DbParameter.Size

SourceColumn

Declaration
public override sealed string SourceColumn { get; set; }
Property Value
Type Description
System.String
Overrides
System.Data.Common.DbParameter.SourceColumn

SourceColumnNullMapping

Declaration
public override sealed bool SourceColumnNullMapping { get; set; }
Property Value
Type Description
System.Boolean
Overrides
System.Data.Common.DbParameter.SourceColumnNullMapping

SourceVersion

Declaration
public override sealed DataRowVersion SourceVersion { get; set; }
Property Value
Type Description
System.Data.DataRowVersion
Overrides
System.Data.Common.DbParameter.SourceVersion

Value

Declaration
[TypeConverter(typeof(StringConverter))]
public override object Value { get; set; }
Property Value
Type Description
System.Object
Overrides
System.Data.Common.DbParameter.Value

Methods

Clone()

Creates a new NpgsqlParameter that is a copy of the current instance.

Declaration
public NpgsqlParameter Clone()
Returns
Type Description
NpgsqlParameter

A new NpgsqlParameter that is a copy of this instance.

ResetDbType()

Declaration
public override void ResetDbType()
Overrides
System.Data.Common.DbParameter.ResetDbType()

Explicit Interface Implementations

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
System.Object

Implements

System.Data.IDbDataParameter
System.Data.IDataParameter
System.ICloneable
In This Article
Back to top Generated by DocFX