SecondaryCompositeIndex
Represent a secondary index (local and global) where the index has composite keys (partition key and sort key).
Type parameters
- F
-
effect type
- P
-
partition key type
- S
-
sort key type
Value parameters
- indexName
-
index's name
- jClient
-
DynamoDB java async client
- partitionKeyDef
-
partition key definition
- sortKeyDef
-
sort key definition
- tableName
-
table's name
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Retrieve all items with the same partition key as a fs2 Stream. A Stream is returned instead of a list because the number of returned items can be very large. This always performs eventually consistent reads as strong consistent is not supported for secondary index.
Retrieve all items with the same partition key as a fs2 Stream. A Stream is returned instead of a list because the number of returned items can be very large. This always performs eventually consistent reads as strong consistent is not supported for secondary index.
Type parameters
- T
-
returned item's type
Value parameters
- RT
-
implicit evidence for RaiseThrowable
- partitionKey
-
partition key
Attributes
- Returns
-
a fs2 Stream of items
Deprecated methods
Retrieve all items with the same partition key as a fs2 Stream. A Stream is returned instead of a list because the number of returned items can be very large. This always performs eventually consistent reads as strong consistent is not supported for secondary index.
Retrieve all items with the same partition key as a fs2 Stream. A Stream is returned instead of a list because the number of returned items can be very large. This always performs eventually consistent reads as strong consistent is not supported for secondary index.
Type parameters
- T
-
returned item's type
Value parameters
- RT
-
implicit evidence for RaiseThrowable
- limit
-
number of items to be returned per API call
- partitionKey
-
partition key
Attributes
- Returns
-
a fs2 Stream of items
- Deprecated
- true
Inherited methods
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Retrieve items from a composite index, can be a secondary index or a table which has composite keys (partition key and sort key).
Retrieve items from a composite index, can be a secondary index or a table which has composite keys (partition key and sort key).
Type parameters
- T
-
return item's type
Value parameters
- RT
-
implicit evidence for RaiseThrowable
- consistentRead
-
toggle to perform consistent read
- query
-
a query to filter items by key condition
Attributes
- Returns
-
a fs2 Stream of items
- Inherited from:
- CompositeIndex (hidden)
Deprecated and Inherited methods
Retrieve items from a composite index, can be a secondary index or a table which has composite keys (partition key and sort key).
Retrieve items from a composite index, can be a secondary index or a table which has composite keys (partition key and sort key).
Type parameters
- T
-
return item's type
Value parameters
- RT
-
implicit evidence for RaiseThrowable
- consistentRead
-
toggle to perform consistent read
- limit
-
limit the number of items to be returned per API call
- query
-
a query to filter items by key condition
Attributes
- Returns
-
a fs2 Stream of items
- Deprecated
- true
- Inherited from:
- CompositeIndex (hidden)