Packages

c

meteor.api.hi

SimpleTable

case class SimpleTable[F[_], P](tableName: String, partitionKeyDef: KeyDef[P], jClient: DynamoDbAsyncClient)(implicit evidence$6: Async[F], evidence$7: Encoder[P]) extends SimpleIndex[F, P] with PutOps with PartitionKeyDeleteOps with PartitionKeyUpdateOps with PartitionKeyBatchGetOps with PartitionKeyBatchWriteOps with Product with Serializable

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

F

effect type

P

partition key's type

tableName

table's name

partitionKeyDef

partition key definition

jClient

DynamoDB java async client

Linear Supertypes
Serializable, Serializable, Product, Equals, PartitionKeyBatchWriteOps, SharedBatchWriteOps, PartitionKeyBatchGetOps, SharedBatchGetOps, DedupOps, PartitionKeyUpdateOps, SharedUpdateOps, PartitionKeyDeleteOps, PutOps, SimpleIndex[F, P], PartitionKeyGetOps, SharedGetOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleTable
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PartitionKeyBatchWriteOps
  7. SharedBatchWriteOps
  8. PartitionKeyBatchGetOps
  9. SharedBatchGetOps
  10. DedupOps
  11. PartitionKeyUpdateOps
  12. SharedUpdateOps
  13. PartitionKeyDeleteOps
  14. PutOps
  15. SimpleIndex
  16. PartitionKeyGetOps
  17. SharedGetOps
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    tableName

    table'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 batchDelete(maxBatchWait: FiniteDuration, parallelism: Int, backoffStrategy: BackoffStrategy): Pipe[F, P, Unit]

    Delete items by partition key in batch.

    Delete items by partition key in batch. Max batch size is preset to 100 (maximum batch size permitted for batch get action), however, it is possible to control the rate of batching with maxBatchWait parameter. This uses fs2 .groupWithin internally. This returns a Pipe in order to cover broader use cases regardless of input can be fitted into memory or not. Duplicated items within a batch will be removed. Left over items within a batch will be reprocessed in the next batch.

    maxBatchWait

    time window to collect items into a batch

    parallelism

    number of connections that can be open at the same time

    backoffStrategy

    backoff strategy in case of failure, default can be found at meteor.Client.BackoffStrategy.default.

    returns

    a fs2 Pipe from composite keys P and S as a tuple to Unit

  6. def batchGet[T](consistentRead: Boolean, projection: Expression, maxBatchWait: FiniteDuration, parallelism: Int, backoffStrategy: BackoffStrategy)(implicit arg0: Decoder[T]): Pipe[F, P, T]

    Get items by partition key in batch.

    Get items by partition key in batch. Max batch size is preset to 100 (maximum batch size permitted for batch get action), however, it is possible to control the rate of batching with maxBatchWait parameter. This uses fs2 .groupWithin internally. This returns a Pipe in order to cover broader use cases regardless of input can be fitted into memory or not. Duplicated items within a batch will be removed. Left over items within a batch will be reprocessed in the next batch.

    T

    returned item's type

    consistentRead

    flag to enable strongly consistent read

    projection

    projection expression

    maxBatchWait

    time window to collect items into a batch

    parallelism

    number of connections that can be open at the same time

    backoffStrategy

    backoff strategy in case of failure, default can be found at meteor.Client.BackoffStrategy.default.

    returns

    a fs2 Pipe from partition key P to T

  7. def batchGetOp[F[_], P, T](table: PartitionKeyTable[P], consistentRead: Boolean, projection: Expression, maxBatchWait: FiniteDuration, parallelism: Int, backoffStrategy: BackoffStrategy)(jClient: DynamoDbAsyncClient)(implicit arg0: Async[F], arg1: RaiseThrowable[F], arg2: Encoder[P], arg3: Decoder[T]): Pipe[F, P, T]
    Definition Classes
    PartitionKeyBatchGetOps
  8. def batchPut[T](maxBatchWait: FiniteDuration, backoffStrategy: BackoffStrategy)(implicit arg0: Encoder[T]): Pipe[F, T, Unit]

    Put items in batch, in ordered.

    Put items in batch, in ordered. Meaning batches are processed in serial to avoid race condition when writing items with the same partition key. If your input doesn't have this constrain, you can use batchPutUnordered. Max batch size is preset to 25 (maximum batch size permitted from batch put actions), however, it is possible to control the rate of batching with maxBatchWait parameter. This uses fs2 .groupWithin internally. This returns a Pipe in order to cover broader use cases regardless of input can be fitted into memory or not. Duplicated items within a batch will be removed. Left over items within a batch will be reprocessed in the next batch.

    T

    returned item's type

    maxBatchWait

    time window to collect items into a batch

    backoffStrategy

    backoff strategy in case of failure, default can be found at meteor.Client.BackoffStrategy.default.

    returns

    a fs2 Pipe from T to Unit

  9. def batchPutUnordered[T](maxBatchWait: FiniteDuration, parallelism: Int, backoffStrategy: BackoffStrategy)(implicit arg0: Encoder[T]): Pipe[F, T, Unit]

    Put items in batch, un-ordered.

    Put items in batch, un-ordered. Meaning batches are processed in parallel, hence, if your input has items with the same partition key, this can cause a race condition, consider using batchPut instead. Max batch size is preset to 25 (maximum batch size permitted from batch put actions), however, it is possible to control the rate of batching with maxBatchWait parameter. This uses fs2 .groupWithin internally. This returns a Pipe in order to cover broader use cases regardless of input can be fitted into memory or not. Duplicated items within a batch will be removed. Left over items within a batch will be reprocessed in the next batch.

    T

    returned item's type

    maxBatchWait

    time window to collect items into a batch

    parallelism

    number of connections that can be open at the same time

    backoffStrategy

    backoff strategy in case of failure, default can be found at meteor.Client.BackoffStrategy.default.

    returns

    a fs2 Pipe from T to Unit

  10. def batchWrite[T](maxBatchWait: FiniteDuration, backoffStrategy: BackoffStrategy)(implicit arg0: Encoder[T]): Pipe[F, Either[P, T], Unit]

    Write items (put or delete) in batch, in ordered.

    Write items (put or delete) in batch, in ordered. Meaning batches are processed in serial to avoid race condition when writing items with the same partition key. Max batch size is preset to 25 (maximum batch size permitted from batch write actions), however, it is possible to control the rate of batching with maxBatchWait parameter. This uses fs2 .groupWithin internally. This returns a Pipe in order to cover broader use cases regardless of input can be fitted into memory or not. Duplicated items within a batch will be removed. Left over items within a batch will be reprocessed in the next batch.

    T

    returned item's type

    maxBatchWait

    time window to collect items into a batch

    backoffStrategy

    backoff strategy in case of failure, default can be found at meteor.Client.BackoffStrategy.default.

    returns

    a fs2 Pipe from Either[P, T], represent deletion (Left) or put (Right) to Unit.

  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. def delete(partitionKey: P): F[Unit]

    Delete an item by partition key.

    Delete an item by partition key.

    partitionKey

    partition key

    returns

    Unit

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def get[T](partitionKey: P, consistentRead: Boolean)(implicit arg0: Decoder[T]): F[Option[T]]

    Get a single item by partition key.

    Get a single item by partition key.

    T

    returned item's type

    partitionKey

    partition key

    consistentRead

    flag to enable strongly consistent read

    returns

    an optional item of type T

  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. val index: PartitionKeyIndex[P]
    Definition Classes
    SimpleTable → SimpleIndex
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val jClient: DynamoDbAsyncClient
    Definition Classes
    SimpleTable → SimpleIndex
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val partitionKeyDef: KeyDef[P]
    Definition Classes
    SimpleTable → SimpleIndex
  23. def put[T, U](t: T, condition: Expression)(implicit arg0: Encoder[T], arg1: Decoder[U]): F[Option[U]]

    Put an item into a table and return previous value.

    Put an item into a table and return previous value.

    T

    item's type

    U

    returned item's type

    t

    item to be put

    condition

    conditional expression

    returns

    an option item of type U

  24. def put[T](t: T, condition: Expression = Expression.empty)(implicit arg0: Encoder[T]): F[Unit]

    Put an item into a table.

    Put an item into a table.

    T

    item's type

    t

    item to be put

    condition

    conditional expression

    returns

    Unit

  25. def retrieve[T](query: Query[P, Nothing], consistentRead: Boolean)(implicit arg0: Decoder[T], RT: RaiseThrowable[F]): F[Option[T]]

    Retrieve items from a partition key index, can be a secondary index or a table which has only partition key and no sort key.

    Retrieve items from a partition key index, can be a secondary index or a table which has only partition key and no 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

    optional item of type T

    Definition Classes
    SimpleIndex
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. val tableName: String
  28. def update[T](partitionKey: P, returnValue: ReturnValue, update: Expression, condition: Expression)(implicit arg0: Decoder[T]): F[Option[T]]

    Update an item by partition key given an update expression when a condition expression is fulfilled.

    Update an item by partition key given an update expression when a condition expression is fulfilled. Return item is customizable via returnValue parameter.

    T

    returned item's type

    partitionKey

    partition key

    returnValue

    flag to define which item to be returned

    update

    update expression

    condition

    conditional expression

    returns

    an optional item of type T

  29. def update(partitionKey: P, update: Expression, condition: Expression = Expression.empty): F[Unit]

    Update an item by partition key given an update expression when a condition expression is fulfilled.

    Update an item by partition key given an update expression when a condition expression is fulfilled. Return Unit.

    partitionKey

    partition key

    update

    update expression

    condition

    conditional expression

    returns

    Unit

  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PartitionKeyBatchWriteOps

Inherited from SharedBatchWriteOps

Inherited from PartitionKeyBatchGetOps

Inherited from SharedBatchGetOps

Inherited from DedupOps

Inherited from PartitionKeyUpdateOps

Inherited from SharedUpdateOps

Inherited from PartitionKeyDeleteOps

Inherited from PutOps

Inherited from SimpleIndex[F, P]

Inherited from PartitionKeyGetOps

Inherited from SharedGetOps

Inherited from AnyRef

Inherited from Any

Ungrouped