Tablestore：資料表操作

建立表時不帶索引

以下樣本用於建立資料表。

private static void createTable(SyncClient client) {
    //設定資料表名稱。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    //為資料表添加主鍵列。主鍵為pk1（String類型）和pk2（Integer類型），其中pk1主鍵列為分區鍵，pk2主鍵列為自增列。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER, PrimaryKeyOption.AUTO_INCREMENT));
    //資料的到期時間，-1表示永不到期。
    int timeToLive = -1;
    //最大版本數，屬性列值最多保留1個版本，即儲存最新的版本。
    int maxVersions = 1;
    //有效版本偏差，即寫入資料的時間戳記與系統目前時間的偏差允許最大值為86400秒（1天）。
    long maxTimeDeviation = 86400L;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions, maxTimeDeviation);
    //設定預留讀寫輸送量，容量型執行個體下的資料表只能設定為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>");
    //為資料表添加主鍵列。主鍵為pk1（String類型）和pk2（Integer類型）。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER));
    //為資料表添加預定義列。預定義列為defcol1（String類型）和defcol2（Integer類型）。
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol1", DefinedColumnType.STRING));
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol2", DefinedColumnType.INTEGER));
    //資料永不到期，-1表示永不到期。
    int timeToLive = -1;
    //最大版本數，屬性列值最多保留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>");
    //為資料表添加主鍵列。主鍵為pk1（String類型）和pk2（Integer類型）。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER));
    //為資料表添加預定義列。預定義列為defcol1（String類型）和defcol2（Integer類型）。
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol1", DefinedColumnType.STRING));
    tableMeta.addDefinedColumn(new DefinedColumnSchema("defcol2", DefinedColumnType.INTEGER));
    //資料的到期時間，-1表示永不到期。1。
    int timeToLive = -1;
    //最大版本數，屬性列值最多保留1個版本，即儲存最新的版本。
    int maxVersions = 1;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);
    
    //本地二級索引
    ArrayList<IndexMeta> indexMetas = new ArrayList<IndexMeta>();
    //設定索引名稱。
    IndexMeta indexMeta = new IndexMeta("<INDEX_NAME>");
    //設定索引類型為本地二級索引（IT_LOCAL_INDEX）。
    indexMeta.setIndexType(IT_LOCAL_INDEX);
    //設定索引更新模式為同步更新（IUM_SYNC_INDEX）。當索引類型為本地二級索引時，索引更新模式必須為同步更新。
    indexMeta.setIndexUpdateMode(IUM_SYNC_INDEX);
    //為索引添加主鍵列。主鍵列為pk1、defcol1和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>");
    //為資料表添加主鍵列。主鍵為pk1（String類型）和pk2（Integer類型）。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER));
    //資料的到期時間，-1表示永不到期。
    int timeToLive = -1;
    //最大版本數，屬性列值最多保留1個版本，即儲存最新的版本。
    int maxVersions = 1;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);
    
    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions);
    //開啟局部事務。如果資料表配置了主鍵自增列，則開啟局部事務配置不會生效。
    request.setLocalTxnEnabled(true);
    client.createTable(request);
}

建立基於KMS服務祕密金鑰加密的表

以下樣本用於建立資料表時使用基於KMS服務祕密金鑰加密表中資料。該表的主鍵為pk（String類型），屬性列值只保留最新版本資料以及資料永不到期。

private static void createTable(SyncClient client) {
    //設定資料表名稱。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    //如果要配置表加密，需要對建表請求配置加密相關參數，支援KMS服務密鑰或BYOK自訂密鑰兩種類型。此處為使用KMS服務密鑰。
    SSESpecification sseKms = new SSESpecification(true, SSEKeyType.SSE_KMS_SERVICE);
    //為資料表添加主鍵列。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk", PrimaryKeyType.STRING)); 
    //資料的到期時間，單位為秒，-1表示永不到期。帶索引表的資料表資料生命週期必須設定為-1。
    int timeToLive = -1; 
    //儲存的最大版本數，1表示每列上最多儲存一個版本即儲存最新的版本。帶索引表的資料表最大版本數必須設定為1。
    int maxVersions = 1; 
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions);
    CreateTableRequest request = new CreateTableRequest(tableMeta, tableOptions);
    //設定預留讀寫輸送量，容量型執行個體中的資料表只能設定為0，高效能執行個體中的資料表可以設定為非零值。
    request.setReservedThroughput(new ReservedThroughput(new CapacityUnit(0, 0))); 
    request.setSseSpecification(sseKms);
    client.createTable(request);
}

建立帶有主鍵自增列的表

以下樣本用於建立資料表時配置主鍵自增列。該表的主鍵為pk1（String類型）和pk2（Integer類型），其中pk1主鍵列為分區鍵，pk2主鍵列為自增列。

private static void createTable(SyncClient client) {
    //設定資料表名稱。
    TableMeta tableMeta = new TableMeta("<TABLE_NAME>");
    //為資料表添加主鍵列。第一列為分區鍵。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk1", PrimaryKeyType.STRING));
    //為資料表添加主鍵列。第二列為自增列，類型為INTEGER，屬性為AUTO_INCREMENT。
    tableMeta.addPrimaryKeyColumn(new PrimaryKeySchema("pk2", PrimaryKeyType.INTEGER, PrimaryKeyOption.AUTO_INCREMENT));
    //資料的到期時間，單位為秒，-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("表的列表如下：");
    for (String tableName : response.getTableNames()) {
        System.out.println(tableName);
    }
}

更新表配置

private static void updateTable(SyncClient client) {
    //資料的到期時間，-1表示永不到期。
    int timeToLive = -1;
    //最大版本數，屬性列值最多保留5個版本。
    int maxVersions = 5;
    //有效版本偏差，即寫入資料的時間戳記與系統目前時間的偏差允許最大值為86400秒（1天）。
    long maxTimeDeviation = 86400L;
    TableOptions tableOptions = new TableOptions(timeToLive, maxVersions, maxTimeDeviation);
    //允許UpdateRow相關更新寫入操作。
    tableOptions.setAllowUpdate(true);
    
    //開啟Stream功能，設定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("表的名稱：" + tableMeta.getTableName());
    System.out.println("表的主鍵：");
    for (PrimaryKeySchema primaryKeySchema : tableMeta.getPrimaryKeyList()) {
        System.out.println(primaryKeySchema);
    }
    TableOptions tableOptions = response.getTableOptions();
    System.out.println("表的TTL:" + tableOptions.getTimeToLive());
    System.out.println("表的MaxVersions:" + tableOptions.getMaxVersions());
    //只能查看加密表的加密配置資訊。非加密表無此配置項。
    //System.out.println("表的加密配置：" + response.getSseDetails());
    ReservedThroughputDetails reservedThroughputDetails = response.getReservedThroughputDetails();
    System.out.println("表的預留讀輸送量："
            + reservedThroughputDetails.getCapacityUnit().getReadCapacityUnit());
    System.out.println("表的預留寫輸送量："
            + 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);
}