GlobalSecondarySimpleIndex

meteor.api.hi.GlobalSecondarySimpleIndex
case class GlobalSecondarySimpleIndex[F[_], P](tableName: String, indexName: String, partitionKeyDef: KeyDef[P], jClient: DynamoDbAsyncClient)(implicit evidence$1: Async[F], evidence$2: Encoder[P])

Represent a global secondary index where the index has only partition key and no sort key.

Type parameters

F

effect type

P

partition key type

Value parameters

indexName

index's name

jClient

DynamoDB java async client

partitionKeyDef

partition key definition

tableName

table's name

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def retrieve[T : Decoder](query: Query[P, Nothing], consistentRead: Boolean)(implicit evidence$1: Decoder[T], RT: RaiseThrowable[F]): Stream[F, T]

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

Definition Classes
CompositeIndex
def retrieve[T : Decoder](partitionKey: P)(implicit evidence$1: Decoder[T], RT: RaiseThrowable[F]): Stream[F, T]

Deprecated methods

override def retrieve[T : Decoder](query: Query[P, Nothing], consistentRead: Boolean, limit: Int)(implicit evidence$1: Decoder[T], RT: RaiseThrowable[F]): Stream[F, T]

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
Definition Classes
CompositeIndex
def retrieve[T : Decoder](partitionKey: P, limit: Int)(implicit evidence$1: Decoder[T], RT: RaiseThrowable[F]): Stream[F, T]

Attributes

Deprecated
true

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

val index: CompositeKeysIndex[P, Nothing]
val sortKeyDef: KeyDef[Nothing]