All Products
Search
Document Center

Tablestore:Manage predefined columns

Last Updated:Jul 22, 2026

Tablestore SDK for Java adds predefined columns to or deletes them from an existing Wide Column model table.

Prerequisites

Install the Tablestore SDK for Java and initialize the client.

Function description

Use the following methods to manage predefined columns.

Add predefined columns

public AddDefinedColumnResponse addDefinedColumn(AddDefinedColumnRequest addDefinedColumnRequest) throws TableStoreException, ClientException

Adds one or more predefined columns to the specified table.

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

public DeleteDefinedColumnResponse deleteDefinedColumn(DeleteDefinedColumnRequest deleteDefinedColumnRequest) throws TableStoreException, ClientException

Deletes one or more predefined columns from the specified table.

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

AddDefinedColumnRequest parameters

AddDefinedColumnRequest contains the following parameters.

  • tableName (required) String: The name of the table.

  • definedColumns (required) List<DefinedColumnSchema>: The predefined columns to add. Each item 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.

DeleteDefinedColumnRequest parameters

DeleteDefinedColumnRequest contains the following parameters.

  • tableName (required) String: The name of the table.

  • definedColumns (required) List<String>: The names of the predefined columns to delete.