Interface IDynamoQuerySortKeyConstraint<TRecord>

Interface for specifying the sort key (PK) constraint for a DynamoDB query.

Namespace: LambdaSharp.DynamoDB.Native.Query

Assembly: LambdaSharp.DynamoDB.Native.dll

Syntax

public interface IDynamoQuerySortKeyConstraint<TRecord>
    where TRecord : class

Type Parameters

Name	Description
TRecord

Methods

WhereSKBeginsWith(String)

Add sort key (SK) must begins with constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKBeginsWith(string skValuePrefix)

Parameters

Type	Name	Description
System.String	skValuePrefix	Prefix for sort key (SK).

Returns

Type	Description
IDynamoQueryClause<TRecord>

WhereSKEquals(String)

Add sort key (SK) 'equals' constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKEquals(string skValue)

Parameters

Type	Name	Description
System.String	skValue	Value to compare sort key (SK) to.

Returns

Type	Description
IDynamoQueryClause<TRecord>

WhereSKIsBetween(String, String)

Add sort key (SK) must be 'between two values' constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKIsBetween(string skLowerBound, string skUpperBound)

Parameters

Type	Name	Description
System.String	skLowerBound	Lower bound value for sort key (SK).
System.String	skUpperBound	Upper bound value for sort key (SK).

Returns

Type	Description
IDynamoQueryClause<TRecord>

WhereSKIsGreaterThan(String)

Add sort key (SK) 'greater than' constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKIsGreaterThan(string skValue)

Parameters

Type	Name	Description
System.String	skValue	Value to compare sort key (SK) to.

Returns

Type	Description
IDynamoQueryClause<TRecord>

WhereSKIsGreaterThanOrEquals(String)

Add sort key (SK) 'greater than or equal' constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKIsGreaterThanOrEquals(string skValue)

Parameters

Type	Name	Description
System.String	skValue	Value to compare sort key (SK) to.

Returns

Type	Description
IDynamoQueryClause<TRecord>

WhereSKIsLessThan(String)

Add sort key (SK) 'less then' constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKIsLessThan(string skValue)

Parameters

Type	Name	Description
System.String	skValue	Value to compare sort key (SK) to.

Returns

Type	Description
IDynamoQueryClause<TRecord>

WhereSKIsLessThanOrEquals(String)

Add sort key (SK) 'less than or equal' constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKIsLessThanOrEquals(string skValue)

Parameters

Type	Name	Description
System.String	skValue	Value to compare sort key (SK) to.

Returns

Type	Description
IDynamoQueryClause<TRecord>

WhereSKMatchesAny()

Skip adding sort key (SK) constraint.

Declaration

IDynamoQueryClause<TRecord> WhereSKMatchesAny()

Returns

Type	Description
IDynamoQueryClause<TRecord>