Queries the schema and the reserved read/write throughput settings of a table.
Request syntax
message DescribeTableRequest {
required string table_name = 1;
}
Parameter | Type | Required | Description |
---|---|---|---|
table_name | string | Yes | The name of the table whose information you want to query. |
Response syntax
message DescribeTableResponse {
required TableMeta table_meta = 1;
required ReservedThroughputDetails reserved_throughput_details = 2;
required TableOptions table_options = 3;
optional StreamDetails stream_details = 5;
repeated bytes shard_splits = 6;
}
Parameter | Type | Description |
---|---|---|
table_meta | TableMeta | The schema of the table. The schema is the same as the schema that was defined when the table was created. |
reserved_throughput_details | ReservedThroughputDetails | The reserved read/write throughput settings of the table. The reserved read/write throughput settings of the table include the most recent reserved read/write throughput value, the time when the reserved read/write throughput value was last updated, and the number of times that the reserved read/write throughput value was decreased on the current day. |
table_options | TableOptions | The most recent value of the table_options parameter. |
stream_details | StreamDetails | Indicates whether Stream-related attributes are enabled. |
shard_splits | bytes | The split points of all partitions in the table. |
Use Tablestore SDKs
You can use the following Tablestore SDKs to query the schema and the reserved read/write
throughput settings of a table:
- Tablestore SDK for Java: DescribeTable
- Tablestore SDK for Go: DescribeTable
- Tablestore SDK for Python: DescribeTable
- Tablestore SDK for Node.js: DescribeTable
- Tablestore SDK for .NET: DescribeTable
- Tablestore SDK for PHP: DescribeTable