Class DynamoQuery

The DynamoQuery defines static methods for building DynamoDB query clauses.

Inheritance

System.Object

DynamoQuery

Namespace: LambdaSharp.DynamoDB.Native

Assembly: LambdaSharp.DynamoDB.Native.dll

Syntax

public static class DynamoQuery

Methods

FromIndex(String, String, String)

Build a DynamoDB query clause using the a local/global secondary index.

Declaration

public static IDynamoQueryPartitionKeyConstraint FromIndex(string indexName, string pkName, string skName)

Parameters

Type	Name	Description
System.String	indexName	The name of the index.
System.String	pkName	The partition key (PK) name.
System.String	skName	The sort key (PK) name.

Returns

Type	Description
IDynamoQueryPartitionKeyConstraint

FromMainIndex()

Build a DynamoDB query clause using the main index.

Declaration

public static IDynamoQueryPartitionKeyConstraint FromMainIndex()

Returns

Type	Description
IDynamoQueryPartitionKeyConstraint

SelectPK(String)

Build an untyped DynamoDB query clause by selecting a partition key (PK) on the main index.

Declaration

public static IDynamoQuerySortKeyConstraint SelectPK(string pkValue)

Parameters

Type	Name	Description
System.String	pkValue	Partition key (PK) value.

Returns

Type	Description
IDynamoQuerySortKeyConstraint

SelectPK<TRecord>(String)

Build a DynamoDB query clause by selecting a partition key (PK) on the main index.

Declaration

public static IDynamoQuerySortKeyConstraint<TRecord> SelectPK<TRecord>(string pkValue)
    where TRecord : class

Parameters

Type	Name	Description
System.String	pkValue	The partition key (PK) value.

Returns

Type	Description
IDynamoQuerySortKeyConstraint<TRecord>

Type Parameters

Name	Description
TRecord	The record type.

SelectPKFormat(String, String[])

Build an untyped DynamoDB query clause by selecting a partition key (PK) on the main index.

Declaration

public static IDynamoQuerySortKeyConstraint SelectPKFormat(string pkValueFormat, params string[] values)

Parameters

Type	Name	Description
System.String	pkValueFormat	Format string for the partition key (PK) value.
System.String[]	values	A string array that contains zero or more strings for the partition key format string.

Returns

Type	Description
IDynamoQuerySortKeyConstraint

SelectPKFormat<TRecord>(String, String[])

Build a DynamoDB query clause by selecting a partition key (PK) on the main index.

Declaration

public static IDynamoQuerySortKeyConstraint<TRecord> SelectPKFormat<TRecord>(string pkValueFormat, params string[] values)
    where TRecord : class

Parameters

Type	Name	Description
System.String	pkValueFormat	Format string for the partition key (PK) value.
System.String[]	values	A string array that contains zero or more strings for the partition key format string.

Returns

Type	Description
IDynamoQuerySortKeyConstraint<TRecord>

Type Parameters

Name	Description
TRecord	The record type.