Class IgniteDbParameterCollection

Namespace

Apache.Ignite.Sql

Assembly

Apache.Ignite.dll

Ignite database parameter collection.

public sealed class IgniteDbParameterCollection : DbParameterCollection, IDataParameterCollection, IList, ICollection, IReadOnlyList<IgniteDbParameter>, IReadOnlyCollection<IgniteDbParameter>, IList<IgniteDbParameter>, ICollection<IgniteDbParameter>, IEnumerable<IgniteDbParameter>, IEnumerable

Inheritance

object

MarshalByRefObject

DbParameterCollection

IgniteDbParameterCollection

Implements

IDataParameterCollection

IList

ICollection

IReadOnlyList<IgniteDbParameter>

IReadOnlyCollection<IgniteDbParameter>

IList<IgniteDbParameter>

ICollection<IgniteDbParameter>

IEnumerable<IgniteDbParameter>

IEnumerable

Inherited Members

DbParameterCollection.this[string]

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Count

Gets the number of parameters in the collection.

public override int Count { get; }

Property Value

int

this[int]

Gets or sets the element at the specified index.

public IgniteDbParameter this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

IgniteDbParameter

The element at the specified index.

SyncRoot

Specifies the object to be used to synchronize access to the collection.

public override object SyncRoot { get; }

Property Value

object

A object to be used to synchronize access to the DbParameterCollection.

Methods

Add(IgniteDbParameter)

Adds an item to the ICollection<T>.

public void Add(IgniteDbParameter item)

Parameters

item IgniteDbParameter

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Add(object)

Adds the specified DbParameter object to the DbParameterCollection.

public override int Add(object value)

Parameters

value object

The Value of the DbParameter to add to the collection.

Returns

int

The index of the DbParameter object in the collection.

AddRange(Array)

Adds an array of items with the specified values to the DbParameterCollection.

public override void AddRange(Array values)

Parameters

values Array

An array of values of type DbParameter to add to the collection.

Clear()

Removes all parameters from the collection.

public override void Clear()

Contains(IgniteDbParameter)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(IgniteDbParameter item)

Parameters

item IgniteDbParameter

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

Contains(object)

Indicates whether a DbParameter with the specified Value is contained in the collection.

public override bool Contains(object value)

Parameters

value object

The Value of the DbParameter to look for in the collection.

Returns

bool

true if the DbParameter is in the collection; otherwise false.

Contains(string)

Indicates whether a DbParameter with the specified name exists in the collection.

public override bool Contains(string value)

Parameters

value string

The name of the DbParameter to look for in the collection.

Returns

bool

true if the DbParameter is in the collection; otherwise false.

CopyTo(IgniteDbParameter[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(IgniteDbParameter[] array, int arrayIndex)

Parameters

array IgniteDbParameter[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

CopyTo(Array, int)

Copies an array of items to the collection starting at the specified index.

public override void CopyTo(Array array, int index)

Parameters

array Array

The array of items to copy to the collection.

index int

The index in the collection to copy the items.

GetEnumerator()

Exposes the GetEnumerator() method, which supports a simple iteration over a collection by a .NET data provider.

public override IEnumerator GetEnumerator()

Returns

IEnumerator

An IEnumerator that can be used to iterate through the collection.

GetParameter(int)

Returns the DbParameter object at the specified index in the collection.

protected override DbParameter GetParameter(int index)

Parameters

index int

The index of the DbParameter in the collection.

Returns

DbParameter

The DbParameter object at the specified index in the collection.

GetParameter(string)

Returns DbParameter the object with the specified name.

protected override DbParameter GetParameter(string parameterName)

Parameters

parameterName string

The name of the DbParameter in the collection.

Returns

DbParameter

The DbParameter the object with the specified name.

IndexOf(IgniteDbParameter)

Determines the index of a specific item in the IList<T>.

public int IndexOf(IgniteDbParameter item)

Parameters

item IgniteDbParameter

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

IndexOf(object)

Returns the index of the specified DbParameter object.

public override int IndexOf(object value)

Parameters

value object

The DbParameter object in the collection.

Returns

int

The index of the specified DbParameter object.

IndexOf(string)

Returns the index of the DbParameter object with the specified name.

public override int IndexOf(string parameterName)

Parameters

parameterName string

The name of the DbParameter object in the collection.

Returns

int

The index of the DbParameter object with the specified name.

Insert(int, IgniteDbParameter)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, IgniteDbParameter value)

Parameters

index int

The zero-based index at which item should be inserted.

value IgniteDbParameter

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Insert(int, object)

Inserts the specified index of the DbParameter object with the specified name into the collection at the specified index.

public override void Insert(int index, object value)

Parameters

index int

The index at which to insert the DbParameter object.

value object

The DbParameter object to insert into the collection.

Remove(IgniteDbParameter)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(IgniteDbParameter value)

Parameters

value IgniteDbParameter

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Remove(object)

Removes the specified DbParameter object from the collection.

public override void Remove(object value)

Parameters

value object

The DbParameter object to remove.

RemoveAt(int)

Removes the item at the specified index.

public override void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

RemoveAt(string)

Removes the DbParameter object with the specified name from the collection.

public override void RemoveAt(string parameterName)

Parameters

parameterName string

The name of the DbParameter object to remove.

SetParameter(int, DbParameter)

Sets the DbParameter object at the specified index to a new value.

protected override void SetParameter(int index, DbParameter value)

Parameters

index int

The index where the DbParameter object is located.

value DbParameter

The new DbParameter value.

SetParameter(string, DbParameter)

Sets the DbParameter object with the specified name to a new value.

protected override void SetParameter(string parameterName, DbParameter value)

Parameters

parameterName string

The name of the DbParameter object in the collection.

value DbParameter

The new DbParameter value.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.