Package io.awspring.cloud.dynamodb

Interface DynamoDbOperations

All Known Implementing Classes:
DynamoDbTemplate
public interface DynamoDbOperations
Interface for simple DynamoDB template operations.
Since:
3.0.0
Author:
Matej Nedic

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(software.amazon.awssdk.enhanced.dynamodb.Key key, Class<?> clazz)
    Deletes a record for a given Key.
    <T> void
    delete(T entity)
    Deletes a record for a given Entity.
    <T> T
    load(software.amazon.awssdk.enhanced.dynamodb.Key key, Class<T> clazz)
    Loads entity for a given Key.
    <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T>
    query(software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest queryEnhancedRequest, Class<T> clazz)
    Queries a data for a given request.
    <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T>
    query(software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest queryEnhancedRequest, Class<T> clazz, String indexName)
    Queries a GlobalSecondaryIndex for a given request and given indexName.
    <T> T
    save(T entity)
    Saves Entity to DynamoDB table.
    <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T>
    scan(software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest scanEnhancedRequest, Class<T> clazz)
    Scans Table using given request.
    <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T>
    scan(software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest scanEnhancedRequest, Class<T> clazz, String indexName)
    Scans GlobalSecondaryIndex using given indexName and request.
    <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T>
    scanAll(Class<T> clazz)
    Scans whole DynamoDB table.
    <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T>
    scanAll(Class<T> clazz, String indexName)
    Scans whole GlobalSecondaryIndex for given indexName.
    <T> T
    update(T entity)
    Updated Entity to DynamoDB table.

  • Method Details

    • save

      <T> T save(T entity)
      Saves Entity to DynamoDB table.
      Type Parameters:
      T - Type of Entity object.
      Parameters:
      entity - - Entity to be saved.

    • update

      <T> T update(T entity)
      Updated Entity to DynamoDB table.
      Type Parameters:
      T - Type of Entity object.
      Parameters:
      entity - - Entity to be saved.

    • delete

      void delete(software.amazon.awssdk.enhanced.dynamodb.Key key, Class<?> clazz)
      Deletes a record for a given Key.
      Parameters:
      key - to determine record in DynamoDB table.
      clazz - Class of entity being deleted so TableSchema can be generated.

    • delete

      <T> void delete(T entity)
      Deletes a record for a given Entity.
      Parameters:
      entity - Entity object for deletion.

    • load

      @Nullable <T> T load(software.amazon.awssdk.enhanced.dynamodb.Key key, Class<T> clazz)
      Loads entity for a given Key.
      Type Parameters:
      T - Type of Entity object.
      Parameters:
      key - to determine record in DynamoDB table.
      clazz - Class of entity being fetched so TableSchema can be generated.

    • query

      <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T> query(software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest queryEnhancedRequest, Class<T> clazz)
      Queries a data for a given request.
      Type Parameters:
      T - Type of Entity object.
      Parameters:
      queryEnhancedRequest - Request that is used by DynamoDbEnhancedClient to execute query request.
      clazz - of entity being fetched so TableSchema can be generated.
      Returns:
      Iterable object which can be used to iterate pages and items.

    • scanAll

      <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T> scanAll(Class<T> clazz)
      Scans whole DynamoDB table.
      Type Parameters:
      T - type of Entity object.
      Parameters:
      clazz - of entity being fetched so TableSchema can be generated.
      Returns:
      Iterable object which can be used to iterate pages and items.

    • scan

      <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T> scan(software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest scanEnhancedRequest, Class<T> clazz)
      Scans Table using given request.
      Type Parameters:
      T - type of Entity object.
      Parameters:
      scanEnhancedRequest - request used by DynamoDbEnhancedClient to execute scan request.
      clazz - of entity being fetched so TableSchema can be generated.
      Returns:
      Iterable object which can be used to iterate pages and items.

    • scan

      <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T> scan(software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest scanEnhancedRequest, Class<T> clazz, String indexName)
      Scans GlobalSecondaryIndex using given indexName and request.
      Type Parameters:
      T - type of Entity object.
      Parameters:
      scanEnhancedRequest - request used by DynamoDbEnhancedClient to execute scan request.
      clazz - of entity being fetched so TableSchema can be generated.
      indexName - name of index that will be used with ScanEnhancedRequest.
      Returns:
      Iterable object which can be used to iterate pages and items.

    • scanAll

      <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T> scanAll(Class<T> clazz, String indexName)
      Scans whole GlobalSecondaryIndex for given indexName.
      Type Parameters:
      T - type of Entity object.
      Parameters:
      clazz - of entity being fetched so TableSchema can be generated.
      indexName - name of index that will be used when scanning.
      Returns:
      Iterable object which can be used to iterate pages and items.

    • query

      <T> software.amazon.awssdk.enhanced.dynamodb.model.PageIterable<T> query(software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest queryEnhancedRequest, Class<T> clazz, String indexName)
      Queries a GlobalSecondaryIndex for a given request and given indexName.
      Type Parameters:
      T - type of Entity object.
      Parameters:
      queryEnhancedRequest - Request that is used by DynamoDbEnhancedClient to execute query request.
      clazz - of entity being fetched so TableSchema can be generated.
      indexName - name of index that will be used with QueryEnhancedRequest.
      Returns:
      Iterable object which can be used to iterate pages and items.