Packages

c

meteor.api.hi

GlobalSecondarySimpleIndex

case class GlobalSecondarySimpleIndex[F[_], P](tableName: String, indexName: String, partitionKeyDef: KeyDef[P], jClient: DynamoDbAsyncClient)(implicit evidence$6: Async[F], evidence$7: Encoder[P]) extends CompositeIndex[F, P, Nothing] with Product with Serializable

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

F

effect type

P

partition key type

tableName

table's name

indexName

index's name

partitionKeyDef

partition key definition

jClient

DynamoDB java async client

Linear Supertypes
Serializable, Product, Equals, CompositeIndex[F, P, Nothing], CompositeKeysGetOps, SharedGetOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GlobalSecondarySimpleIndex
  2. Serializable
  3. Product
  4. Equals
  5. CompositeIndex
  6. CompositeKeysGetOps
  7. SharedGetOps
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GlobalSecondarySimpleIndex(tableName: String, indexName: String, partitionKeyDef: KeyDef[P], jClient: DynamoDbAsyncClient)(implicit arg0: Async[F], arg1: Encoder[P])

    tableName

    table's name

    indexName

    index's name

    partitionKeyDef

    partition key definition

    jClient

    DynamoDB java async client

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. val index: CompositeKeysIndex[P, Nothing]
    Definition Classes
    GlobalSecondarySimpleIndex → CompositeIndex
  9. val indexName: String
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val jClient: DynamoDbAsyncClient
    Definition Classes
    GlobalSecondarySimpleIndex → CompositeIndex
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. val partitionKeyDef: KeyDef[P]
    Definition Classes
    GlobalSecondarySimpleIndex → CompositeIndex
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. def retrieve[T](partitionKey: P)(implicit arg0: Decoder[T], RT: RaiseThrowable[F]): Stream[F, T]
  18. def retrieve[T](query: Query[P, Nothing], consistentRead: Boolean)(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

    RT

    implicit evidence for RaiseThrowable

    returns

    a fs2 Stream of items

    Definition Classes
    GlobalSecondarySimpleIndex → CompositeIndex
  19. val sortKeyDef: KeyDef[Nothing]
    Definition Classes
    GlobalSecondarySimpleIndex → CompositeIndex
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val tableName: String
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def retrieve[T](partitionKey: P, limit: Int)(implicit arg0: Decoder[T], RT: RaiseThrowable[F]): Stream[F, T]
    Annotations
    @deprecated
    Deprecated

    (Since version 2022-04-24) Use retrieve without limit

  3. def retrieve[T](query: Query[P, Nothing], 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 per API call

    RT

    implicit evidence for RaiseThrowable

    returns

    a fs2 Stream of items

    Definition Classes
    GlobalSecondarySimpleIndex → CompositeIndex
    Annotations
    @deprecated
    Deprecated

    (Since version 2022-04-24) Use retrieve without limit

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CompositeIndex[F, P, Nothing]

Inherited from CompositeKeysGetOps

Inherited from SharedGetOps

Inherited from AnyRef

Inherited from Any

Ungrouped