c

org.scanamo

SecondaryIndex

sealed abstract class SecondaryIndex[V] extends AnyRef

Represents a secondary index on a DynamoDB table.

Can be constructed via the index method on Table

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SecondaryIndex
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def descending: SecondaryIndex[V]
  2. abstract def filter[C](condition: C)(implicit arg0: ConditionExpression[C]): SecondaryIndex[V]

    Filter the results of scan or query within DynamoDB

    Filter the results of scan or query within DynamoDB

    Note that rows filtered out still count towards your consumed capacity

  3. abstract def from(exclusiveStartKey: DynamoObject): SecondaryIndex[V]

    Primes a search request with a key to start from:

    Primes a search request with a key to start from:

    exclusiveStartKey

    A DynamoObject containing attributes that match the partition key and sort key of the secondary index as well as the partition key of the table itself

    returns

    A new SecondaryIndex which when queried will return items after the provided exclusive start key

    Example: 

    1. import org.scanamo._
import org.scanamo.syntax._

val table: Table[_] = ???
val secondaryIndex: SecondaryIndex[_] = table.index("myIndex")
val exclusiveStartKey = DynamoObject(
  Map(
    "myIndexPartitionKeyName" -> myIndexPartitionKeyValue.asDynamoValue,
    "myIndexSortKeyName" -> myIndexSortKeyValue.asDynamoValue,
    "myTablePartitionKeyName" -> myTablePartitionKeyValue.asDynamoValue
  )
)
val indexStartingFromExclusiveStartKey: SecondaryIndex[_] = secondaryIndex.from(exclusiveStartKey)
  4. abstract def from[K](key: UniqueKey[K])(implicit arg0: UniqueKeyCondition[K]): SecondaryIndex[V]
  5. abstract def limit(n: Int): SecondaryIndex[V]

    Query or scan an index, limiting the number of items evaluated by Dynamo

  6. abstract def query(query: Query[_]): ScanamoOps[List[Either[DynamoReadError, V]]]

    Run a query against keys in a secondary index

  7. abstract def queryPaginatedM[M[_]](query: Query[_], pageSize: Int)(implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a scan with the ability to introduce effects into the computation.

    Performs a scan with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page, with a maximum of pageSize items per page.

    Note

    DynamoDB will only ever return maximum 1MB of data per query, so pageSize is an upper bound.

  8. abstract def queryRaw(query: Query[_]): ScanamoOps[QueryResponse]

    Queries the index and returns the raw DynamoDB result.

  9. abstract def scan(): ScanamoOps[List[Either[DynamoReadError, V]]]

    Scan a secondary index

  10. abstract def scanPaginatedM[M[_]](pageSize: Int)(implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a scan with the ability to introduce effects into the computation.

    Performs a scan with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page, with a maximum of pageSize items per page..

    Note

    DynamoDB will only ever return maximum 1MB of data per scan, so pageSize is an upper bound.

  11. abstract def scanRaw: ScanamoOps[ScanResponse]

    Scans the index and returns the raw DynamoDB result.

Concrete 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( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def queryM[M[_]](query: Query[_])(implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a query with the ability to introduce effects into the computation.

    Performs a query with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page.

    To control how many maximum items to load at once, use queryPaginatedM

  15. final def scanM[M[_]](implicit arg0: Monad[M], arg1: MonoidK[M]): ScanamoOpsT[M, List[Either[DynamoReadError, V]]]

    Performs a scan with the ability to introduce effects into the computation.

    Performs a scan with the ability to introduce effects into the computation. This is useful for huge tables when you don't want to load the whole of it in memory, but scan it page by page.

    To control how many maximum items to load at once, use scanPaginatedM

  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. 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 AnyRef

Inherited from Any

Ungrouped