Manage predefined columns

Prerequisites

Install the Tablestore SDK for Java and initialize the client.

Function description

Add predefined columns

Call addDefinedColumn to add one or more predefined columns to a table.

public AddDefinedColumnResponse addDefinedColumn(AddDefinedColumnRequest addDefinedColumnRequest) throws TableStoreException, ClientException

The following example adds a STRING predefined column named name to example_table.

AddDefinedColumnRequest request = new AddDefinedColumnRequest();
request.setTableName("example_table");
request.addDefinedColumn("name", DefinedColumnType.STRING);
client.addDefinedColumn(request);

Delete predefined columns

Call deleteDefinedColumn to delete one or more predefined columns from a table.

public DeleteDefinedColumnResponse deleteDefinedColumn(DeleteDefinedColumnRequest deleteDefinedColumnRequest) throws TableStoreException, ClientException

The following example deletes the predefined column named name from example_table.

DeleteDefinedColumnRequest request = new DeleteDefinedColumnRequest();
request.setTableName("example_table");
request.addDefinedColumn("name");
client.deleteDefinedColumn(request);

Parameters

Add predefined column request

AddDefinedColumnRequest contains the following parameters.

Name	Type	Description
tableName (required)	`String`	The name of the table.
definedColumns (required)	`List<DefinedColumnSchema>`	The predefined columns to add.

Predefined columns

Each element in AddDefinedColumnRequest.definedColumns[] is of the DefinedColumnSchema type and contains the following parameters.

Name	Type	Description
name (required)	`String`	The name of the predefined column.
type (required)	`DefinedColumnType`	The data type of the predefined column. Valid values are `STRING`, `INTEGER`, `BINARY`, `DOUBLE`, and `BOOLEAN`.

Delete predefined column request

DeleteDefinedColumnRequest contains the following parameters.

Name	Type	Description
tableName (required)	`String`	The name of the table.
definedColumns (required)	`List<String>`	The names of the predefined columns to delete.