Class CqlParameter
Represents a Cql parameter.
Inheritance
Implements
Inherited Members
Namespace: Dse.Data
Assembly: Dse.dll
Syntax
public class CqlParameter : DbParameter, IDbDataParameter, IDataParameter
Constructors
CqlParameter()
Initializes a new instance of the CqlParameter class.
Declaration
public CqlParameter()
CqlParameter(String)
Initializes a new instance of the CqlParameter class.
Declaration
public CqlParameter(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name. |
CqlParameter(String, Object)
Initializes a new instance of the CqlParameter class. The type of the parameter will be guessed from the value.
Declaration
public CqlParameter(string name, object value)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name. |
System.Object | value | The value. |
Properties
DbType
Gets or sets the System.Data.DbType of the parameter.
Declaration
public override DbType DbType { get; set; }
Property Value
Type | Description |
---|---|
System.Data.DbType |
Overrides
Direction
Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
Declaration
public override ParameterDirection Direction { get; set; }
Property Value
Type | Description |
---|---|
System.Data.ParameterDirection | One of the System.Data.ParameterDirection values. The default is Input. |
Overrides
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Cql only supports input parameters |
IsNullable
Gets a value indicating whether the parameter accepts null values.
Declaration
public override bool IsNullable { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if null values are accepted; otherwise, false. The default is false. |
Overrides
ParameterName
Gets or sets the name of the System.Data.IDataParameter.
Declaration
public override string ParameterName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The name of the System.Data.IDataParameter. The default is an empty string. |
Overrides
Size
The size of the parameter.
Declaration
public override int Size { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | Always returns 0. |
Overrides
SourceColumn
Gets or sets the name of the source column that is mapped to the System.Data.DataSet and used for loading or returning the System.Data.IDataParameter.Value.
Declaration
public override string SourceColumn { get; set; }
Property Value
Type | Description |
---|---|
System.String | The name of the source column that is mapped to the System.Data.DataSet. The default is an empty string. |
Overrides
SourceColumnNullMapping
Sets or gets a value which indicates whether the source column is nullable. This allows System.Data.Common.DbCommandBuilder to correctly generate Update statements for nullable columns.
Declaration
public override bool SourceColumnNullMapping { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the source column is nullable; false if it is not. |
Overrides
SourceVersion
Gets or sets the System.Data.DataRowVersion to use when loading System.Data.IDataParameter.Value.
Declaration
public override DataRowVersion SourceVersion { get; set; }
Property Value
Type | Description |
---|---|
System.Data.DataRowVersion | One of the System.Data.DataRowVersion values. The default is Current. |
Overrides
Value
Gets or sets the value of the parameter. If no type information was provided earlier, the type of the parameter will be guessed from the value's type.
Declaration
public override object Value { get; set; }
Property Value
Type | Description |
---|---|
System.Object | An System.Object that is the value of the parameter. The default value is null. |
Overrides
Methods
ResetDbType()
Resets the DbType property to its original settings.
Declaration
public override void ResetDbType()