Class ShardSetsBase<TShard, TConfiguration>.ShardDataConnection

This class represents an actual connection to the database. There may be two connections per shard.

Inheritance

System.Object

ShardSetsBase<TShard, TConfiguration>.ShardDataConnection

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ArgentSea

Assembly: ArgentSea.dll

Syntax

public class ShardDataConnection

Properties

ConnectionString

Declaration

public string ConnectionString { get; }

Property Value

Type	Description
System.String

Methods

ListAsync<TRecord>(Query, Char, String, DbParameterCollection, String, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardKey<TShard, TRecord>>> ListAsync<TRecord>(Query query, char origin, string recordColumnName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardKey<TShard, TRecord>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord

ListAsync<TRecord>(Query, Char, String, DbParameterCollection, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardKey<TShard, TRecord>>> ListAsync<TRecord>(Query query, char origin, string recordColumnName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardKey<TShard, TRecord>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord

ListAsync<TRecord>(Query, Char, String, String, DbParameterCollection, String, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardKey<TShard, TRecord>>> ListAsync<TRecord>(Query query, char origin, string shardColumnName, string recordColumnName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	shardColumnName	This should match the name of a column containing the ShardID component of the ShardKey.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardKey<TShard, TRecord>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord

ListAsync<TRecord>(Query, Char, String, String, DbParameterCollection, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardKey<TShard, TRecord>>> ListAsync<TRecord>(Query query, char origin, string shardColumnName, string recordColumnName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	shardColumnName	This should match the name of a column containing the ShardID component of the ShardKey.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardKey<TShard, TRecord>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord

ListAsync<TValue>(Query, DbParameterCollection, String, String, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<TValue>> ListAsync<TValue>(Query query, DbParameterCollection parameters, string columnName, string shardParameterName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	columnName	This should match the name of a column containing the values.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TValue>>	A list containing an object for each data row.

Type Parameters

Name	Description
TValue	The type of the return value, typically: Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int16, Int32, Int64, or String.

ListAsync<TValue>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<TValue>> ListAsync<TValue>(Query query, DbParameterCollection parameters, string columnName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	columnName	This should match the name of a column containing the values.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TValue>>	A list containing an object for each data row.

Type Parameters

Name	Description
TValue	The type of the return value, typically: Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int16, Int32, Int64, or String.

ListAsync<TRecord, TChild>(Query, Char, String, String, DbParameterCollection, String, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardChild<TShard, TRecord, TChild>>> ListAsync<TRecord, TChild>(Query query, char origin, string recordColumnName, string childColumnName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardChild.
System.String	childColumnName
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardChild<TShard, TRecord, TChild>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord
TChild

ListAsync<TRecord, TChild>(Query, Char, String, String, DbParameterCollection, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardChild<TShard, TRecord, TChild>>> ListAsync<TRecord, TChild>(Query query, char origin, string recordColumnName, string childColumnName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardChild.
System.String	childColumnName
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardChild<TShard, TRecord, TChild>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord
TChild

ListAsync<TRecord, TChild>(Query, Char, String, String, String, DbParameterCollection, String, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardChild<TShard, TRecord, TChild>>> ListAsync<TRecord, TChild>(Query query, char origin, string shardColumnName, string recordColumnName, string childColumnName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	shardColumnName	This should match the name of a column containing the ShardID component of the ShardChild.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardChild.
System.String	childColumnName
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardChild<TShard, TRecord, TChild>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord
TChild

ListAsync<TRecord, TChild>(Query, Char, String, String, String, DbParameterCollection, CancellationToken)

Connect to the database and return a list of column values.

Declaration

public Task<List<ShardChild<TShard, TRecord, TChild>>> ListAsync<TRecord, TChild>(Query query, char origin, string shardColumnName, string recordColumnName, string childColumnName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	shardColumnName	This should match the name of a column containing the ShardID component of the ShardChild.
System.String	recordColumnName	This should match the name of a column containing the RecordID component of the ShardChild.
System.String	childColumnName
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<ShardChild<TShard, TRecord, TChild>>>	A list containing an object for each data row.

Type Parameters

Name	Description
TRecord
TChild

MapListAsync<TModel>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return the values as a list of objects.

Declaration

public Task<List<TModel>> MapListAsync<TModel>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TModel>>	A list containing an object for each data row.

Type Parameters

Name	Description
TModel	The type of object to be listed.

MapListAsync<TModel>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return the values as a list of objects.

Declaration

public Task<List<TModel>> MapListAsync<TModel>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TModel>>	A list containing an object for each data row.

Type Parameters

Name	Description
TModel	The type of object to be listed.

MapOutputAsync<TModel>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query.

MapOutputAsync<TModel>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query.

MapOutputAsync<TModel, TReaderResult>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult	The first result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult	The first result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. This it will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. This it will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. This it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. This it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()
    where TReaderResult7 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. This it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult7	The eighth result set from data reader. This will be mapped to any property with a List of this type.

MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results and output parameters.

Declaration

public Task<TModel> MapOutputAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()
    where TReaderResult7 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query and should map to the output parameters.
TReaderResult0	The first result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. This it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. This will be mapped to any property with a List of this type.
TReaderResult7	The eighth result set from data reader. This will be mapped to any property with a List of this type.

MapReaderAsync<TModel>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results parameters.

Declaration

public Task<TModel> MapReaderAsync<TModel>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query.

MapReaderAsync<TModel>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results parameters.

Declaration

public Task<TModel> MapReaderAsync<TModel>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query, DbParameterCollection, String, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()
    where TReaderResult7 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to -1.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult7	The eighth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query, DbParameterCollection, CancellationToken)

Connect to the database and return an object of the specified type built from the corresponding data reader results.

Declaration

public Task<TModel> MapReaderAsync<TModel, TReaderResult0, TReaderResult1, TReaderResult2, TReaderResult3, TReaderResult4, TReaderResult5, TReaderResult6, TReaderResult7>(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TModel : class, new()
    where TReaderResult0 : class, new()
    where TReaderResult1 : class, new()
    where TReaderResult2 : class, new()
    where TReaderResult3 : class, new()
    where TReaderResult4 : class, new()
    where TReaderResult5 : class, new()
    where TReaderResult6 : class, new()
    where TReaderResult7 : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>

Type Parameters

Name	Description
TModel	This is the expected return type of the query. It must also be the same type as one of the TReaderResult values.
TReaderResult0	The first result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult1	The second result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult2	The third result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult3	The forth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult4	The fifth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult5	The sixth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult6	The seventh result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.
TReaderResult7	The eighth result set from data reader. If the same type as TModel, it must return exactly one record. Otherwise, it will be mapped to any property with a List of this type.

QueryAsync<TModel>(Query, DbParameterCollection, QueryResultModelHandler<TShard, Object, TModel>, Boolean, CancellationToken)

Connect to the database and return the TModel object returned by the delegate.

Declaration

public Task<TModel> QueryAsync<TModel>(Query query, DbParameterCollection parameters, QueryResultModelHandler<TShard, object, TModel> resultHandler, bool isTopOne, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
QueryResultModelHandler<TShard, System.Object, TModel>	resultHandler	A method with a signature that corresponds to the QueryResultModelHandler delegate, which converts the provided DataReader and output parameters and returns an object of type TModel.
System.Boolean	isTopOne	If the procedure or function is expected to return only one record, setting this to True provides a minor optimization.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>	An object of type TModel, as created and populated by the provided delegate.

Type Parameters

Name	Description
TModel	The type of the object to be returned.

QueryAsync<TModel>(Query, DbParameterCollection, String, QueryResultModelHandler<TShard, Object, TModel>, Boolean, CancellationToken)

Connect to the database and return the TModel object returned by the delegate.

Declaration

public Task<TModel> QueryAsync<TModel>(Query query, DbParameterCollection parameters, string shardParameterName, QueryResultModelHandler<TShard, object, TModel> resultHandler, bool isTopOne, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
QueryResultModelHandler<TShard, System.Object, TModel>	resultHandler	A method with a signature that corresponds to the QueryResultModelHandler delegate, which converts the provided DataReader and output parameters and returns an object of type TModel.
System.Boolean	isTopOne	If the procedure or function is expected to return only one record, setting this to True provides a minor optimization.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>	An object of type TModel, as created and populated by the provided delegate.

Type Parameters

Name	Description
TModel	The type of the object to be returned.

QueryAsync<TArg, TModel>(Query, DbParameterCollection, QueryResultModelHandler<TShard, TArg, TModel>, Boolean, TArg, CancellationToken)

Connect to the database and return the TModel object returned by the delegate.

Declaration

public Task<TModel> QueryAsync<TArg, TModel>(Query query, DbParameterCollection parameters, QueryResultModelHandler<TShard, TArg, TModel> resultHandler, bool isTopOne, TArg optionalArgument, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
QueryResultModelHandler<TShard, TArg, TModel>	resultHandler	A method with a signature that corresponds to the QueryResultModelHandler delegate, which converts the provided DataReader and output parameters and returns an object of type TModel.
System.Boolean	isTopOne	If the procedure or function is expected to return only one record, setting this to True provides a minor optimization.
TArg	optionalArgument	An object of type TArg which can be used to pass non-datatabase data to the result-generating delegate.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>	An object of type TModel, as created and populated by the provided delegate.

Type Parameters

Name	Description
TArg
TModel	The type of the object to be returned.

QueryAsync<TArg, TModel>(Query, DbParameterCollection, String, QueryResultModelHandler<TShard, TArg, TModel>, Boolean, TArg, CancellationToken)

Connect to the database and return the TModel object returned by the delegate.

Declaration

public Task<TModel> QueryAsync<TArg, TModel>(Query query, DbParameterCollection parameters, string shardParameterName, QueryResultModelHandler<TShard, TArg, TModel> resultHandler, bool isTopOne, TArg optionalArgument, CancellationToken cancellationToken)
    where TModel : class, new()

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
QueryResultModelHandler<TShard, TArg, TModel>	resultHandler	A method with a signature that corresponds to the QueryResultModelHandler delegate, which converts the provided DataReader and output parameters and returns an object of type TModel.
System.Boolean	isTopOne	If the procedure or function is expected to return only one record, setting this to True provides a minor optimization.
TArg	optionalArgument	An object of type TArg which can be used to pass non-datatabase data to the result-generating delegate.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TModel>	An object of type TModel, as created and populated by the provided delegate.

Type Parameters

Name	Description
TArg
TModel	The type of the object to be returned.

ReturnValueAsync(Query, DbParameterCollection, String, CancellationToken)

Invokes the query and returns the integer result.

Declaration

public Task<int> ReturnValueAsync(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If this does not include a return parameter, one will be added.
System.String	shardParameterName
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

ReturnValueAsync(Query, DbParameterCollection, CancellationToken)

Declaration

public Task<int> ReturnValueAsync(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If this does not include a return parameter, one will be added.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

ReturnValueAsync(Query, CancellationToken)

Declaration

public Task<int> ReturnValueAsync(Query query, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

ReturnValueAsync<TRecord>(Query, Char, String, DbParameterCollection, String, CancellationToken)

Invokes the query and returns a ShardKey whose ShardId is the current shard and RecordId is obtained from the output parameter or first-row column value whose name matches the “recordDataName”.

Declaration

public Task<ShardKey<TShard, TRecord>> ReturnValueAsync<TRecord>(Query query, char origin, string recordDataName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardKey type.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “recordDataName” argument matches an output parameter name, that value will be used for the ShardKey.
System.String	shardParameterName	The name of the parameter who value should be set to the shard Id.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardKey<TShard, TRecord>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardKey

ReturnValueAsync<TRecord>(Query, Char, String, DbParameterCollection, CancellationToken)

Invokes the query and returns a ShardKey whose ShardId is the current shard and RecordId is obtained from the output parameter or first-row column value whose name matches the “recordDataName”.

Declaration

public Task<ShardKey<TShard, TRecord>> ReturnValueAsync<TRecord>(Query query, char origin, string recordDataName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardKey type.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “recordDataName” argument matches an output parameter name, that value will be used for the ShardKey.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardKey<TShard, TRecord>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardKey

ReturnValueAsync<TRecord>(Query, Char, String, String, DbParameterCollection, String, CancellationToken)

Invokes the query and returns a ShardKey whose ShardId and RecordId are obtained from the output parameters or first-row column values whose name matches “shardDataName” and “recordDataName” respectively.

Declaration

public Task<ShardKey<TShard, TRecord>> ReturnValueAsync<TRecord>(Query query, char origin, string shardDataName, string recordDataName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardKey type.
System.String	shardDataName	A value that should match an output parameter name or column name. This value will be used for the ShardId of the ShardKey.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “shardDataName” and/or “recordDataName” argument matches an output parameter name, those values will be used for the ShardKey.
System.String	shardParameterName	The name of the parameter whose value should be set to the shard Id.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardKey<TShard, TRecord>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardKey.

ReturnValueAsync<TRecord>(Query, Char, String, String, DbParameterCollection, CancellationToken)

Invokes the query and returns a ShardKey whose ShardId and RecordId are obtained from the output parameters or first-row column values whose name matches “shardDataName” and “recordDataName” respectively.

Declaration

public Task<ShardKey<TShard, TRecord>> ReturnValueAsync<TRecord>(Query query, char origin, string shardDataName, string recordDataName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardKey type.
System.String	shardDataName	A value that should match an output parameter name or column name. This value will be used for the ShardId of the ShardKey.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardKey.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “shardDataName” and/or “recordDataName” argument matches an output parameter name, those values will be used for the ShardKey.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardKey<TShard, TRecord>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardKey.

ReturnValueAsync<TValue>(Query, String, DbParameterCollection, String, CancellationToken)

Invokes the query and returns the value of the output parameter or first-row column value whose name matches the “dataName”.

Declaration

public Task<TValue> ReturnValueAsync<TValue>(Query query, string dataName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.String	dataName	A value that should match an output parameter name or column name. This value will be used for the result.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “dataName” argument matches an output parameter name, this will be the value returned.
System.String	shardParameterName	The name of the parameter who value should be set to the shard Id.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TValue>

Type Parameters

Name	Description
TValue	The type of the return value, typically: Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int16, Int32, Int64, or String.

ReturnValueAsync<TValue>(Query, String, DbParameterCollection, CancellationToken)

Invokes the query and returns the value of the output parameter or first-row column value whose name matches the “dataName”.

Declaration

public Task<TValue> ReturnValueAsync<TValue>(Query query, string dataName, DbParameterCollection parameters, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.String	dataName	A value that should match an output parameter name or column name. This value will be used for the result.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “dataName” argument matches an output parameter name, this will be the value returned.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TValue>

Type Parameters

Name	Description
TValue	The type of the return value, typically: Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int16, Int32, Int64, or String.

ReturnValueAsync<TRecord, TChild>(Query, Char, String, String, DbParameterCollection, String, CancellationToken)

Invokes the query and returns a ShardChild whose ShardId is the current shard and RecordId and ChildId is obtained from the output parameter or first-row column value whose name matches the “recordDataName” and “childDataName”.

Declaration

public Task<ShardChild<TShard, TRecord, TChild>> ReturnValueAsync<TRecord, TChild>(Query query, char origin, string recordDataName, string childDataName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardChild.
System.String	childDataName
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “recordDataName” and/or “childDataName” argument matches an output parameter name, those values will be used for the ShardChild.
System.String	shardParameterName	The name of the parameter whose value should be set to the shard Id.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardChild<TShard, TRecord, TChild>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardChild.
TChild

ReturnValueAsync<TRecord, TChild>(Query, Char, String, String, DbParameterCollection, CancellationToken)

Invokes the query and returns a ShardChild whose ShardId is the current shard and RecordId and ChildId is obtained from the output parameter or first-row column value whose name matches the “recordDataName” and “childDataName”.

Declaration

public Task<ShardChild<TShard, TRecord, TChild>> ReturnValueAsync<TRecord, TChild>(Query query, char origin, string recordDataName, string childDataName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardChild.
System.String	childDataName
System.Data.Common.DbParameterCollection	parameters	The query parameters. If “recordDataName” and/or “childDataName” argument matches an output parameter name, those values will be used for the ShardChild.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardChild<TShard, TRecord, TChild>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardChild.
TChild

ReturnValueAsync<TRecord, TChild>(Query, Char, String, String, String, DbParameterCollection, String, CancellationToken)

Invokes the query and returns a ShardChild whose ShardId, RecordId, and ChildId are obtained from the output parameters or first-row column values whose name matches “shardDataName”, “recordDataName”, and “childDataName” respectively.

Declaration

public Task<ShardChild<TShard, TRecord, TChild>> ReturnValueAsync<TRecord, TChild>(Query query, char origin, string shardDataName, string recordDataName, string childDataName, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	shardDataName	A value that should match an output parameter name or column name. This value will be used for the ShardId of the ShardChild.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardChild.
System.String	childDataName	A value that should match an output parameter name or column name. This value will be used for the ChildId of the ShardChild.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If data name arguments match an output parameter name, those values will be used for the ShardChild.
System.String	shardParameterName	The name of the parameter whose value should be set to the shard Id.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardChild<TShard, TRecord, TChild>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardChild.
TChild

ReturnValueAsync<TRecord, TChild>(Query, Char, String, String, String, DbParameterCollection, CancellationToken)

Invokes the query and returns a ShardChild whose ShardId, RecordId, and ChildId are obtained from the output parameters or first-row column values whose name matches “shardDataName”, “recordDataName”, and “childDataName” respectively.

Declaration

public Task<ShardChild<TShard, TRecord, TChild>> ReturnValueAsync<TRecord, TChild>(Query query, char origin, string shardDataName, string recordDataName, string childDataName, DbParameterCollection parameters, CancellationToken cancellationToken)
    where TRecord : IComparable where TChild : IComparable

Parameters

Type	Name	Description
Query	query	The SQL procedure or statement to invoke to fetch the data.
System.Char	origin	Origin value to indicate the ShardChild type.
System.String	shardDataName	A value that should match an output parameter name or column name. This value will be used for the ShardId of the ShardChild.
System.String	recordDataName	A value that should match an output parameter name or column name. This value will be used for the RecordId of the ShardChild.
System.String	childDataName	A value that should match an output parameter name or column name. This value will be used for the ChildId of the ShardChild.
System.Data.Common.DbParameterCollection	parameters	The query parameters. If data name arguments match an output parameter name, those values will be used for the ShardChild.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<ShardChild<TShard, TRecord, TChild>>

Type Parameters

Name	Description
TRecord	The type of the recordId in the ShardChild.
TChild

RunAsync(Query, DbParameterCollection, String, CancellationToken)

Executes a database procedure or function that does not return a data result.

Declaration

public Task RunAsync(Query query, DbParameterCollection parameters, string shardParameterName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query
System.Data.Common.DbParameterCollection	parameters	The query parameters with values set.
System.String	shardParameterName	The ordinal position of a parameter that should be automatically set to the current shard number value. If there is no such parameter, set to null or empty.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task	Throws an error if not successful.

RunAsync(Query, DbParameterCollection, CancellationToken)

Executes a database procedure or function that does not return a data result.

Declaration

public Task RunAsync(Query query, DbParameterCollection parameters, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Query	query
System.Data.Common.DbParameterCollection	parameters	The query parameters with values set.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task	Throws an error if not successful.

RunAsync<TResult>(ShardBatch<TShard, TResult>, CancellationToken)

Execute a set of commands within a single transaction.

Declaration

public Task<TResult> RunAsync<TResult>(ShardBatch<TShard, TResult> batch, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ShardBatch<TShard, TResult>	batch	The QueryBatch object.
System.Threading.CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
System.Threading.Tasks.Task<TResult>	The last valid TResult type returned by the collection of commands.

Type Parameters

Name	Description
TResult	The optional return type specified in the batch.