case class SecondaryCompositeIndex[F[_], P, S](tableName: String, indexName: String, partitionKeyDef: KeyDef[P], sortKeyDef: KeyDef[S], jClient: DynamoDbAsyncClient)(implicit evidence$9: Async[F], evidence$10: Encoder[P], evidence$11: Encoder[S]) extends CompositeIndex[F, P, S] with Product with Serializable
Represent a secondary index (local and global) where the index has composite keys (partition key and sort key).
- F
effect type
- P
partition key type
- S
sort key type
- tableName
table's name
- indexName
index's name
- partitionKeyDef
partition key definition
- sortKeyDef
sort key definition
- jClient
DynamoDB java async client
- Alphabetic
- By Inheritance
- SecondaryCompositeIndex
- Serializable
- Product
- Equals
- CompositeIndex
- CompositeKeysGetOps
- SharedGetOps
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SecondaryCompositeIndex(tableName: String, indexName: String, partitionKeyDef: KeyDef[P], sortKeyDef: KeyDef[S], jClient: DynamoDbAsyncClient)(implicit arg0: Async[F], arg1: Encoder[P], arg2: Encoder[S])
- tableName
table's name
- indexName
index's name
- partitionKeyDef
partition key definition
- sortKeyDef
sort key definition
- jClient
DynamoDB java async client
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val index: CompositeKeysIndex[P, S]
- Definition Classes
- SecondaryCompositeIndex → CompositeIndex
- val indexName: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jClient: DynamoDbAsyncClient
- Definition Classes
- SecondaryCompositeIndex → CompositeIndex
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val partitionKeyDef: KeyDef[P]
- Definition Classes
- SecondaryCompositeIndex → CompositeIndex
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def retrieve[T](partitionKey: P, limit: Int)(implicit arg0: Decoder[T], RT: RaiseThrowable[F]): Stream[F, T]
Retrieve all items with the same partition key as a fs2 Stream.
Retrieve all items with the same partition key as a fs2 Stream. The number of returned items can be limited. 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.
- T
returned item's type
- partitionKey
partition key
- limit
number of items to be returned
- RT
implicit evidence for RaiseThrowable
- returns
a fs2 Stream of items
- def retrieve[T](query: Query[P, S], consistentRead: Boolean, limit: Int)(implicit arg0: 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).
- T
return item's type
- query
a query to filter items by key condition
- consistentRead
toggle to perform consistent read
- limit
limit the number of items to be returned
- RT
implicit evidence for RaiseThrowable
- returns
a fs2 Stream of items
- Definition Classes
- CompositeIndex
- val sortKeyDef: KeyDef[S]
- Definition Classes
- SecondaryCompositeIndex → CompositeIndex
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tableName: String
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated