Google.Cloud.Spanner.Data - Class SpannerParameterCollection (4.1.0)

public sealed class SpannerParameterCollection : DbParameterCollection, IDataParameterCollection, IList, ICollection, IEnumerable<SpannerParameter>, IEnumerable

Reference documentation and code samples for the Google.Cloud.Spanner.Data class SpannerParameterCollection.

Represents a collection of parameters associated with a SpannerCommand and their respective mappings to columns in a DataSet.

Inheritance

Object > MarshalByRefObject > DbParameterCollection > SpannerParameterCollection

Implements

IDataParameterCollection, IList, ICollection, IEnumerable<SpannerParameter>, IEnumerable

Inherited Members

System.Data.Common.DbParameterCollection.System.Collections.IList.get_Item(System.Int32)

System.Data.Common.DbParameterCollection.System.Collections.IList.set_Item(System.Int32, System.Object)

System.Data.Common.DbParameterCollection.System.Data.IDataParameterCollection.get_Item(System.String)

System.Data.Common.DbParameterCollection.System.Data.IDataParameterCollection.set_Item(System.String, System.Object)

DbParameterCollection.Item[Int32]

DbParameterCollection.Item[String]

DbParameterCollection.IList.Item[Int32]

DbParameterCollection.IDataParameterCollection.Item[String]

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(Boolean)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Spanner.Data

Assembly

Google.Cloud.Spanner.Data.dll

Constructors

SpannerParameterCollection(IEnumerable<SpannerParameter>)

public SpannerParameterCollection(IEnumerable<SpannerParameter> initialParameters = null)

Initializes a new SpannerParameterCollection with the given set of optional SpannerParameter objects.

Parameter
Name	Description
`initialParameters`	`IEnumerable<SpannerParameter>` The initial parameters to include in the collection.

Properties

Count

public override int Count { get; }

Property Value
Type	Description
`Int32`

Overrides

DbParameterCollection.Count

IsFixedSize

public override bool IsFixedSize { get; }

Property Value
Type	Description
`Boolean`

Overrides

DbParameterCollection.IsFixedSize

IsReadOnly

public override bool IsReadOnly { get; }

Property Value
Type	Description
`Boolean`

Overrides

DbParameterCollection.IsReadOnly

IsSynchronized

public override bool IsSynchronized { get; }

Property Value
Type	Description
`Boolean`

Overrides

DbParameterCollection.IsSynchronized

SyncRoot

public override object SyncRoot { get; }

Property Value
Type	Description
`Object`

Overrides

DbParameterCollection.SyncRoot

Methods

Add(Object)

public override int Add(object value)

Parameter
Name	Description
`value`	`Object`

Returns
Type	Description
`Int32`

Overrides

DbParameterCollection.Add(Object)

Add(String, SpannerDbType)

public SpannerParameter Add(string parameterName, SpannerDbType dbType)

Adds a new SpannerParameter to the SpannerParameterCollection.

Parameters
Name	Description
`parameterName`	`String` The name of the parameter. For Insert, Update and Delete commands, this name should be the name of a valid Column in a Spanner table. In Select commands, this name should be the name of a parameter used in the SQL Query. Must not be null
`dbType`	`SpannerDbType` One of the SpannerDbType values that indicates the type of the parameter. Must not be null.

Returns
Type	Description
`SpannerParameter`	The parameter which has been added.

Add(String, SpannerDbType, Object)

public SpannerParameter Add(string parameterName, SpannerDbType dbType, object value)

Adds a new SpannerParameter to the SpannerParameterCollection

Parameters
Name	Description
`parameterName`	`String` The name of the parameter. For Insert, Update and Delete commands, this name should be the name of a valid Column in a Spanner table. In Select commands, this name should be the name of a parameter used in the SQL Query. Must not be null.
`dbType`	`SpannerDbType` One of the SpannerDbType values that indicates the type of the parameter. Must not be null.
`value`	`Object` An object that is the value of the SpannerParameter. May be null.

Returns
Type	Description
`SpannerParameter`	The parameter which has been added.

AddRange(Array)

public override void AddRange(Array values)

Parameter
Name	Description
`values`	`Array`

Overrides

DbParameterCollection.AddRange(Array)

Clear()

public override void Clear()

Overrides

DbParameterCollection.Clear()

Clone()

public SpannerParameterCollection Clone()

Clones the collection.

Returns
Type	Description
`SpannerParameterCollection`	A cloned copy of this instance.

Contains(Object)

public override bool Contains(object value)

Parameter
Name	Description
`value`	`Object`

Returns
Type	Description
`Boolean`

Overrides

DbParameterCollection.Contains(Object)

Contains(String)

public override bool Contains(string value)

Parameter
Name	Description
`value`	`String`

Returns
Type	Description
`Boolean`

Overrides

DbParameterCollection.Contains(String)

CopyTo(Array, Int32)

public override void CopyTo(Array array, int index)

Parameters
Name	Description
`array`	`Array`
`index`	`Int32`

Overrides

DbParameterCollection.CopyTo(Array, Int32)

GetEnumerator()

public override IEnumerator GetEnumerator()

Returns
Type	Description
`IEnumerator`

Overrides

DbParameterCollection.GetEnumerator()

GetParameter(Int32)

protected override DbParameter GetParameter(int index)

Parameter
Name	Description
`index`	`Int32`

Returns
Type	Description
`DbParameter`

Overrides

DbParameterCollection.GetParameter(Int32)

GetParameter(String)

protected override DbParameter GetParameter(string parameterName)

Parameter
Name	Description
`parameterName`	`String`

Returns
Type	Description
`DbParameter`

Overrides

DbParameterCollection.GetParameter(String)

IndexOf(Object)

public override int IndexOf(object value)

Parameter
Name	Description
`value`	`Object`

Returns
Type	Description
`Int32`

Overrides

DbParameterCollection.IndexOf(Object)

IndexOf(String)

public override int IndexOf(string parameterName)

Parameter
Name	Description
`parameterName`	`String`

Returns
Type	Description
`Int32`

Overrides

DbParameterCollection.IndexOf(String)

Insert(Int32, Object)

public override void Insert(int index, object value)

Parameters
Name	Description
`index`	`Int32`
`value`	`Object`

Overrides

DbParameterCollection.Insert(Int32, Object)

Remove(Object)

public override void Remove(object value)

Parameter
Name	Description
`value`	`Object`

Overrides

DbParameterCollection.Remove(Object)

RemoveAt(Int32)

public override void RemoveAt(int index)

Parameter
Name	Description
`index`	`Int32`

Overrides

DbParameterCollection.RemoveAt(Int32)

RemoveAt(String)

public override void RemoveAt(string parameterName)

Parameter
Name	Description
`parameterName`	`String`

Overrides

DbParameterCollection.RemoveAt(String)

SetParameter(Int32, DbParameter)

protected override void SetParameter(int index, DbParameter value)

Parameters
Name	Description
`index`	`Int32`
`value`	`DbParameter`

Overrides

DbParameterCollection.SetParameter(Int32, DbParameter)

SetParameter(String, DbParameter)

protected override void SetParameter(string parameterName, DbParameter value)

Parameters
Name	Description
`parameterName`	`String`
`value`	`DbParameter`

Overrides

DbParameterCollection.SetParameter(String, DbParameter)

Explicit Interface Implementations

IEnumerable<SpannerParameter>.GetEnumerator()

IEnumerator<SpannerParameter> IEnumerable<SpannerParameter>.GetEnumerator()

Returns
Type	Description
`IEnumerator<SpannerParameter>`