Google.Cloud.Spanner.Data - Class SpannerParameterCollection (4.3.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(int)

System.Data.Common.DbParameterCollection.System.Collections.IList.set_Item(int, object)

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

System.Data.Common.DbParameterCollection.System.Data.IDataParameterCollection.set_Item(string, object)

DbParameterCollection.this[int]

DbParameterCollection.this[string]

DbParameterCollection.IList.Item[int]

DbParameterCollection.IDataParameterCollection.Item[string]

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google CloudGoogle.Cloud.SpannerData

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`	`IEnumerableSpannerParameter` The initial parameters to include in the collection.

Properties

Count

public override int Count { get; }

Property Value
Type	Description
`int`

Overrides

DbParameterCollection.Count

IsFixedSize

public override bool IsFixedSize { get; }

Property Value
Type	Description
`bool`

Overrides

DbParameterCollection.IsFixedSize

IsReadOnly

public override bool IsReadOnly { get; }

Property Value
Type	Description
`bool`

Overrides

DbParameterCollection.IsReadOnly

IsSynchronized

public override bool IsSynchronized { get; }

Property Value
Type	Description
`bool`

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
`int`

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
`bool`

Overrides

DbParameterCollection.Contains(Object)

Contains(string)

public override bool Contains(string value)

Parameter
Name	Description
`value`	`string`

Returns
Type	Description
`bool`

Overrides

DbParameterCollection.Contains(String)

CopyTo(Array, int)

public override void CopyTo(Array array, int index)

Parameters
Name	Description
`array`	`Array`
`index`	`int`

Overrides

DbParameterCollection.CopyTo(Array, Int32)

GetEnumerator()

public override IEnumerator GetEnumerator()

Returns
Type	Description
`IEnumerator`

Overrides

DbParameterCollection.GetEnumerator()

GetParameter(int)

protected override DbParameter GetParameter(int index)

Parameter
Name	Description
`index`	`int`

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
`int`

Overrides

DbParameterCollection.IndexOf(Object)

IndexOf(string)

public override int IndexOf(string parameterName)

Parameter
Name	Description
`parameterName`	`string`

Returns
Type	Description
`int`

Overrides

DbParameterCollection.IndexOf(String)

Insert(int, object)

public override void Insert(int index, object value)

Parameters
Name	Description
`index`	`int`
`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(int)

public override void RemoveAt(int index)

Parameter
Name	Description
`index`	`int`

Overrides

DbParameterCollection.RemoveAt(Int32)

RemoveAt(string)

public override void RemoveAt(string parameterName)

Parameter
Name	Description
`parameterName`	`string`

Overrides

DbParameterCollection.RemoveAt(String)

SetParameter(int, DbParameter)

protected override void SetParameter(int index, DbParameter value)

Parameters
Name	Description
`index`	`int`
`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
`IEnumeratorSpannerParameter`