Class DeephavenParameter

Represents a parameter to a DeephavenCommand.

Inheritance

System.Object

DeephavenParameter

Namespace: Deephaven.Connector

Assembly: Deephaven.Connector.dll

Syntax

public class DeephavenParameter : DbParameter

Constructors

DeephavenParameter()

Initializes a new instance of the DeephavenParameter class.

Declaration

public DeephavenParameter()

DeephavenParameter(String, DbType)

Initializes a new instance of the DeephavenParameter class with the given parameter name and DbType.

Declaration

public DeephavenParameter(string parameterName, DbType dbType)

Parameters

Type	Name	Description
System.String	parameterName	The parameter name. Must be prefixed with "@".
DbType	dbType	The parameter DbType.

DeephavenParameter(String, DbType, Object)

Initializes a new instance of the DeephavenParameter class with the given parameter name, DbType and value. The value provided should be consistent with the specified DbType.

Declaration

public DeephavenParameter(string parameterName, DbType dbType, object value)

Parameters

Type	Name	Description
System.String	parameterName	The parameter name. Must be prefixed with "@"
DbType	dbType	The parameter DbType.
System.Object	value	The parameter value.

DeephavenParameter(String, Object)

Initializes a new instance of the DeephavenParameter class with the given parameter name and value. The DbType is inferred from the object type of

value

.

Declaration

public DeephavenParameter(string parameterName, object value)

Parameters

Type	Name	Description
System.String	parameterName	The parameter name. Must be prefixed with "@".
System.Object	value	The parameter value.

Properties

DbType

Gets or sets the DbType of the parameter.

Declaration

public override DbType DbType { get; set; }

Property Value

Type	Description
DbType

Direction

Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter. Only input-only parameters are supported.

Declaration

public override ParameterDirection Direction { get; set; }

Property Value

Type	Description
ParameterDirection

IsNullable

Gets or sets a value that indicates whether the parameter accepts null values. All Deephaven values are nullable, may not be set to false.

Declaration

public override bool IsNullable { get; set; }

Property Value

Type	Description
System.Boolean

ParameterName

Gets or sets the name of the .

Declaration

public override string ParameterName { get; set; }

Property Value

Type	Description
System.String

Size

Gets or sets the maximum size, in bytes, of the data within the column. Deephaven does not support sizes in parameters, this value is ignored.

Declaration

public override int Size { get; set; }

Property Value

Type	Description
System.Int32

SourceColumn

Gets or sets the name of the source column mapped to the and used for loading or returning the Value. Deephaven does not support , this property is ignored.

Declaration

public override string SourceColumn { get; set; }

Property Value

Type	Description
System.String

SourceColumnNullMapping

Sets or gets a value which indicates whether the source column is nullable. This allows to correctly generate Update statements for nullable columns. Deephaven does not support , this property is ignored.

Declaration

public override bool SourceColumnNullMapping { get; set; }

Property Value

Type	Description
System.Boolean

Value

Gets or sets the value of the parameter.

Declaration

public override object Value { get; set; }

Property Value

Type	Description
System.Object

Methods

Clone()

Create a copy of this parameter.

Declaration

public DeephavenParameter Clone()

Returns

Type	Description
DeephavenParameter

ResetDbType()

Resets the DbType property to its original settings. This examines the Value object and infers a DbType from that.

Declaration

public override void ResetDbType()