Tablestore:データテーブルに対する操作

インデックスなしでデータテーブルを作成する

次のサンプルコードは、データテーブルを作成する方法の例を示しています。

private static void createTable(SyncClient client) {
    // データテーブルの名前を指定します。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    // データテーブルに主キー列を追加します。テーブルには、String 型の pk1 主キー列と Integer 型の pk2 主キー列が含まれています。pk1 主キー列はパーティションキーです。pk2 主キー列は自動インクリメント主キー列です。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER, PrimaryKeyOption.AUTO_INCREMENT));
    // データテーブルのデータの TTL を指定します。-1 の値は、データテーブルのデータが期限切れにならないことを指定します。
    int timeToLive = -1;
    // データテーブルの各属性列に保持できる最大バージョン数を指定します。この例では、各属性列の最新バージョンのみを保持できます。
    int maxVersions = 1;
    // 現在のシステム時刻と書き込まれたデータのタイムスタンプの最大差を指定します。この例では、最大差は 86,400 秒 (1 日) に設定されています。
    long maxTimeDeviation = 86400L;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions, maxTimeDeviation);
    // 予約済み読み取りスループットまたは書き込みスループットを指定します。キャパシティインスタンスのデータテーブルの場合、予約済み読み取りスループットまたは書き込みスループットは 0 のみに設定できます。高パフォーマンスインスタンスのデータテーブルの場合、予約済み読み取りスループットまたは書き込みスループットを 0 以外の値に設定できます。
    ReservedThroughput reservedThroughput = new ReservedThroughput(new CapacityUnit(0, 0));

    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions, reservedThroughput);
    client.createTable(request);
}

データテーブルとセカンダリインデックスを作成する

private static void createTable(SyncClient client) {
    // データテーブルの名前を指定します。    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    // データテーブルの主キー列を指定します。この例では、主キー列は String 型の pk1 と Integer 型の pk2 です。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER));
    // データテーブルの事前定義された列を指定します。この例では、事前定義された列は String 型の defcol1 と Integer 型の defcol2 です。
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol1", DefinedColumnType.STRING));
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol2", DefinedColumnType.INTEGER));
    // timeToLive パラメーターを設定します。-1 の値は、データテーブルのデータが期限切れにならないことを指定します。
    int timeToLive = -1;
    // maxVersions パラメーターを設定します。1 の値は、各属性列の最新バージョンのみが保持されることを指定します。
    int maxVersions = 1;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);

    // グローバルセカンダリインデックスを作成します。
    ArrayList<IndexMeta> indexMetas = new ArrayList<IndexMeta>();
    // グローバルセカンダリインデックスの名前を指定します。
    IndexMeta indexMeta = new IndexMeta("<INDEX_NAME>");
    // インデックスの主キー列を指定します。この例では、主キー列は defcol1、pk1、および pk2 です。
    indexMeta.addPrimaryKeyColumn("defcol1");
    indexMeta.addPrimaryKeyColumn("pk1");
    indexMeta.addPrimaryKeyColumn("pk2");
    // インデックスの事前定義された列を指定します。この例では、事前定義された列は defcol2 です。
    indexMeta.addDefinedColumn("defcol2");
    indexMetas.add(indexMeta);

    // データテーブルとインデックスを同時に作成します。
    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions, indexMetas);
    client.createTable(request);
}

private static void createTable(SyncClient client) {
    // データテーブルの名前を指定します。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    // データテーブルの主キー列を指定します。この例では、主キー列は String 型の pk1 と Integer 型の pk2 です。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER));
    // データテーブルの事前定義された列を指定します。この例では、事前定義された列は String 型の defcol1 と Integer 型の defcol2 です。
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol1", DefinedColumnType.STRING));
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol2", DefinedColumnType.INTEGER));
    // timeToLive パラメーターを設定します。-1 の値は、データテーブルのデータが期限切れにならないことを指定します。
    int timeToLive = -1;
    // maxVersions パラメーターを設定します。1 の値は、各属性列の最新バージョンのみが保持されることを指定します。
    int maxVersions = 1;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);

    // ローカルセカンダリインデックスを作成します。
    ArrayList<IndexMeta> indexMetas = new ArrayList<IndexMeta>();
    // ローカルセカンダリインデックスの名前を指定します。
    IndexMeta indexMeta = new IndexMeta("<INDEX_NAME>");
    // IndexType パラメーターを IT_LOCAL_INDEX に設定して、ローカルセカンダリインデックスを作成します。
    indexMeta.setIndexType(IT_LOCAL_INDEX);
    // IndexUpdateMode パラメーターを IUM_SYNC_INDEX に設定します。ローカルセカンダリインデックスを作成する場合は、インデックス更新モードを同期更新に設定する必要があります。
    indexMeta.setIndexUpdateMode(IUM_SYNC_INDEX);
    // インデックスの主キー列を指定します。この例では、主キー列は defcol1、pk1、および pk2 です。
    indexMeta.addPrimaryKeyColumn("pk1");
    indexMeta.addPrimaryKeyColumn("defcol1");
    indexMeta.addPrimaryKeyColumn("pk2");
    // インデックスの事前定義された列を指定します。この例では、事前定義された列は defcol2 です。
    indexMeta.addDefinedColumn("defcol2");
    indexMetas.add(indexMeta);

    // データテーブルとインデックスを同時に作成します。
    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions, indexMetas);
    client.createTable(request);
}

ローカルトランザクションが有効なテーブルを作成する

次のサンプルコードは、ローカルトランザクション機能が有効なデータテーブルを作成する方法の例を示しています。

private static void createTable(SyncClient client) {
    // データテーブルの名前を指定します。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    // データテーブルに主キー列を追加します。データテーブルには、String 型の pk1 主キー列と Integer 型の pk2 主キー列が含まれています。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER));
    // データテーブルのデータの TTL を指定します。-1 の値は、データテーブルのデータが期限切れにならないことを指定します。
    int timeToLive = -1;
    // データテーブルの各属性列に保持できる最大バージョン数を指定します。この例では、各属性列の最新バージョンのみを保持できます。
    int maxVersions = 1;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);

    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions);
    // ローカルトランザクション機能を有効にします。データテーブルに自動インクリメント主キー列を指定した場合、ローカルトランザクション機能の設定はテーブルに対して有効になりません。
    request.setLocalTxnEnabled(true);
    client.createTable(request);
}

KMS キーベースの暗号化が有効なテーブルを作成する

次のサンプルコードは、データテーブルを作成するときに、データテーブルに対して KMS キーベースの暗号化を有効にする方法の例を示しています。この例では、データテーブルには STRING 型の pk 主キー列が含まれており、各属性列の最新バージョンのみが保持され、データテーブルのデータは期限切れになりません。

private static void createTable(SyncClient client) {
    // データテーブルの名前を指定します。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    // データ暗号化を設定する場合は、createTable リクエストで暗号化関連のパラメーターを設定します。KMS キーベースの暗号化と BYOK ベースの暗号化という 2 つの暗号化モードがサポートされています。この例では、KMS キーベースの暗号化が有効になっています。
    SSESpecification sseKms = new SSESpecification(true, SSEKeyType.SSE_KMS_SERVICE);
    // データテーブルに主キー列を追加します。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk", PrimaryKeyType.STRING));
    // データの有効期間を指定します。-1 の値は、データが期限切れにならないことを指定します。単位: 秒。インデックステーブルを作成するデータテーブルの場合、timeToLive パラメーターを -1 に設定する必要があります。
    int timeToLive = -1;
    // 各属性列に保持できるデータバージョンの最大数を指定します。1 の値は、各属性列の最新バージョンのみが保持されることを指定します。インデックステーブルを作成するデータテーブルの場合、maxVersions パラメーターを 1 に設定する必要があります。
    int maxVersions = 1;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);
    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions);
    // 予約済み読み取りスループットと予約済み書き込みスループットを指定します。キャパシティインスタンスのデータテーブルの場合は 0 に設定する必要があり、高パフォーマンスインスタンスのデータテーブルの場合は 0 以外の値に設定できます。
    request.setReservedThroughput(new ReservedThroughput(new CapacityUnit(0, 0)));
    request.setSseSpecification(sseKms);
    client.createTable(request);
}

自動インクリメント主キー列を持つテーブルを作成する

次のサンプルコードは、自動インクリメント主キー列を含むテーブルを作成する方法の例を示しています。テーブルには、データ型が STRING の pk1 主キー列とデータ型が INTEGER の pk2 主キー列が含まれています。pk1 列はパーティションキー列で、pk2 列は自動インクリメント主キー列です。

private static void createTable(SyncClient client) {
    // テーブルの名前を指定します。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    // 最初の主キー列を作成します。最初の主キー列はパーティションキー列です。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    // データ型が INTEGER の 2 番目の主キー列を作成し、列の属性を AUTO_INCREMENT に設定します。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER, PrimaryKeyOption.AUTO_INCREMENT));
    // データの有効期間 (TTL) を指定します。-1 の値は、データが期限切れにならないことを指定します。単位: 秒。
    int timeToLive = -1;  
    // 各列に保持できる最大バージョン数を指定します。1 の値は、各列の最新バージョンのみが保持されることを指定します。
    int maxVersions = 1; 
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);
    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions);
    client.createTable(request);
}

テーブルの名前のクエリ

次のサンプルコードは、インスタンス内のすべてのテーブルの名前をクエリする方法の例を示しています。

private static void listTable(SyncClient client) {
    ListTableResponse response = client.listTable();
    System.out.println("List of tables:");
    for (String tableName : response.getTableNames()) {
        System.out.println(tableName);
    }
}

テーブルの設定の更新

private static void updateTable(SyncClient client) {
    // timeToLive パラメーターの値を更新します。-1 の値は、データテーブルのデータが期限切れにならないことを指定します。
    int timeToLive = -1;
    // maxVersions パラメーターの値を更新します。5 の値は、各属性列に最大 5 つのバージョンのデータが保持されることを指定します。
    int maxVersions = 5;
    // maxTimeDeviation パラメーターの値を更新します。86400 の値は、現在のシステム時刻とデータの書き込み時刻の最大差が 86400 秒 (1 日) であることを指定します。
    long maxTimeDeviation = 86400L;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions, maxTimeDeviation);
    // データテーブルで UpdateRow 操作を許可します。
    tableOptions.setAllowUpdate(true);

    // Stream 機能を有効にし、ストリームの有効期間を 24 時間に設定します。
    //StreamSpecification streamSpecification = new StreamSpecification(true, 24);

    // データテーブルの名前を指定します。
    UpdateTableRequest request = new UpdateTableRequest("<TABLE_NAME>");
    request.setTableOptionsForUpdate(tableOptions);
    client.updateTable(request);
}

private static void updateTable(SyncClient client) {
    // 新しい予約済み読み取りスループットを 1 に、新しい予約済み書き込みスループットを 1 に設定します。キャパシティインスタンスのデータテーブルの場合、予約済み読み取りスループットと書き込みスループットは 0 のみに設定できます。
    ReservedThroughput reservedThroughput = new ReservedThroughput(new CapacityUnit(1, 1));

    // データテーブルの名前を指定します。
    UpdateTableRequest request = new UpdateTableRequest("<TABLE_NAME>");
    request.setReservedThroughputForUpdate(reservedThroughput);
    client.updateTable(request);
}

テーブルに関する情報のクエリ

次のサンプルコードは、テーブルのスキーマ情報、オプションの設定、予約済み読み取りスループット、および予約済み書き込みスループットをクエリする方法の例を示しています。

private static void describeTable(SyncClient client) {
    // テーブルの名前を指定します。
    DescribeTableRequest request = new DescribeTableRequest("<TABLE_NAME>");
    DescribeTableResponse response = client.describeTable(request);
    TableMeta tableMeta = response.getTableMeta();
    System.out.println("Table name:" + tableMeta.getTableName());
    System.out.println("Primary key information:");
    for (PrimaryKeySchema primaryKeySchema : tableMeta.getPrimaryKeyList()) {
        System.out.println(primaryKeySchema);
    }
    TableOptions tableOptions = response.getTableOptions();
    System.out.println("Table TTL:" + tableOptions.getTimeToLive());
    System.out.println("Maximum number of data versions:" + tableOptions.getMaxVersions());
    // テーブルの暗号化設定は、テーブルが暗号化されたテーブルの場合にのみ表示できます。テーブルが暗号化されたテーブルでない場合、このパラメーターは返されません。
    System.out.println("Encryption configurations:" + response.getSseDetails());
    ReservedThroughputDetails reservedThroughputDetails = response.getReservedThroughputDetails();
    System.out.println("Reserved read throughput:"
            + reservedThroughputDetails.getCapacityUnit().getReadCapacityUnit());
    System.out.println("Reserved write throughput:"
            + reservedThroughputDetails.getCapacityUnit().getWriteCapacityUnit());
}

事前定義された列の管理

次のサンプルコードは、テーブルに事前定義された列を追加する方法の例を示しています。この例では、definedColumnName01 (タイプ: STRING)、definedColumnName02 (タイプ: INTEGER)、および definedColumnName03 (タイプ: STRING) という事前定義された列が追加されます。

public static void addDefinedColumnRequest(SyncClient client) {
    AddDefinedColumnRequest addDefinedColumnRequest = new AddDefinedColumnRequest();
    // テーブルの名前を指定します。
    addDefinedColumnRequest.setTableName("<TABLE_NAME>");
    // テーブルに事前定義された列を追加します。
    addDefinedColumnRequest.addDefinedColumn("definedColumnName01",DefinedColumnType.STRING);
    addDefinedColumnRequest.addDefinedColumn("definedColumnName02",DefinedColumnType.INTEGER);
    addDefinedColumnRequest.addDefinedColumn("definedColumnName03",DefinedColumnType.STRING);
    client.addDefinedColumn(addDefinedColumnRequest);
}

不要になった事前定義された列を削除できます。

次のサンプルコードは、テーブルから definedColumnName01 および definedColumnName02 という事前定義された列を削除する方法の例を示しています。

public static void deleteDefinedColumnRequest(SyncClient client){
    DeleteDefinedColumnRequest deleteDefinedColumnRequest = new DeleteDefinedColumnRequest();
    // テーブルの名前を指定します。
    deleteDefinedColumnRequest.setTableName("<TABLE_NAME>");
    // テーブルから事前定義された列を削除します。
    deleteDefinedColumnRequest.addDefinedColumn("definedColumnName01");
    deleteDefinedColumnRequest.addDefinedColumn("definedColumnName02");
    client.deleteDefinedColumn(deleteDefinedColumnRequest);
}

データテーブルの削除

次のサンプルコードは、exampletable テーブルを削除する方法の例を示しています。

private static void deleteTable(SyncClient client) {
    // データテーブルの名前を指定します。
    DeleteTableRequest request = new DeleteTableRequest("<TABLE_NAME>");
    client.deleteTable(request);
}