Interface IDynamoTableQuery

Interface to specify Query operation with mixed record types.

Namespace: LambdaSharp.DynamoDB.Native.Operations

Assembly: LambdaSharp.DynamoDB.Native.dll

Syntax

public interface IDynamoTableQuery

Methods

ExecuteAsync(Boolean, CancellationToken)

Execute Query operation.

Declaration

Task<IEnumerable<object>> ExecuteAsync(bool fetchAllAttributes, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Boolean	fetchAllAttributes	Fetch all attributes from main index when querying a local/global secondary index.
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Object>>	List of all found records.

ExecuteAsync(CancellationToken)

Execute Query operation.

Declaration

virtual Task<IEnumerable<object>> ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Object>>	List of all found records.

ExecuteAsyncEnumerable(Boolean, CancellationToken)

Execute Query operation.

Declaration

IAsyncEnumerable<object> ExecuteAsyncEnumerable(bool fetchAllAttributes, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Boolean	fetchAllAttributes	Fetch all attributes from main index when querying a local/global secondary index.
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Object>	Asynchronous enumerable which returns found records.

ExecuteAsyncEnumerable(CancellationToken)

Execute Query operation.

Declaration

virtual IAsyncEnumerable<object> ExecuteAsyncEnumerable(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Object>	Asynchronous enumerable which returns found records.

ExecuteFetchAllAttributesAsync(CancellationToken)

Execute Query operation and fetch all attributes from main index when querying a local/global secondary index.

Declaration

virtual Task<IEnumerable<object>> ExecuteFetchAllAttributesAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Object>>	List of all found records.

ExecuteFetchAllAttributesAsyncEnumerable(CancellationToken)

Execute Query operation and fetch all attributes from main index when querying a local/global secondary index.

Declaration

virtual IAsyncEnumerable<object> ExecuteFetchAllAttributesAsyncEnumerable(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Collections.Generic.IAsyncEnumerable<System.Object>	Asynchronous enumerable which returns found records.

Get<TRecord, T>(Expression<Func<TRecord, T>>)

Selects a record property to fetch.

Declaration

IDynamoTableQuery Get<TRecord, T>(Expression<Func<TRecord, T>> attribute)
    where TRecord : class

Parameters

Type	Name	Description
System.Linq.Expressions.Expression<System.Func<TRecord, T>>	attribute	A lambda expression that returns the record property.

Returns

Type	Description
IDynamoTableQuery

Type Parameters

Name	Description
TRecord	The property type.
T	The record type.

Where<TRecord>(Expression<Func<TRecord, Boolean>>)

Filter query results.

Declaration

IDynamoTableQuery Where<TRecord>(Expression<Func<TRecord, bool>> filter)
    where TRecord : class

Parameters

Type	Name	Description
System.Linq.Expressions.Expression<System.Func<TRecord, System.Boolean>>	filter	A lambda predicate representing the DynamoDB filter expression.

Returns

Type	Description
IDynamoTableQuery

Type Parameters

Name	Description
TRecord	The record type.