Tablestore:Query information of a table

Prerequisites

A client is initialized. For more information, see Initialize a Tablestore client.

Method

public DescribeTableResponse DescribeTable(DescribeTableRequest request)

Asynchronous method:

public Task<DescribeTableResponse> DescribeTableAsync(DescribeTableRequest request)

Sample code

The following sample code demonstrates how to query information of the test_table table.

try
{
    var request = new DescribeTableRequest("test_table");
    var response = client.DescribeTable(request);

    // Table schema information
    var tableMeta = response.TableMeta;
    Console.WriteLine("* Table name: " + tableMeta.TableName);
    Console.WriteLine("* Primary key information");
    foreach (var primaryKey in tableMeta.PrimaryKeySchema)
    {
        Console.WriteLine($"{primaryKey.Item1}:{primaryKey.Item2}");
    }
    Console.WriteLine("* Predefined column information");
    foreach (var definedColumn in tableMeta.DefinedColumnSchema)
    {
        Console.WriteLine($"{definedColumn.Item1}:{definedColumn.Item2}");
    }

    // Table configuration information
    var tableOptions = response.TableOptions;
    Console.WriteLine("* Table configuration information");
    Console.WriteLine("Time to live: " + tableOptions.TimeToLive);
    Console.WriteLine("Max versions: " + tableOptions.MaxVersions);
    Console.WriteLine("Max version offset: " + tableOptions.DeviationCellVersionInSec);
    Console.WriteLine("Allow updates: " + tableOptions.AllowUpdate);

    // Table Stream information
    var streamDetails = response.StreamDetails;
    Console.WriteLine("* Whether to enable Stream: " + streamDetails.EnableStream);
    if (streamDetails.EnableStream)
        Console.WriteLine("Stream expiration time: " + streamDetails.ExpirationTime);

    // Table reserved read/write throughput
    var reservedThroughputDetails = response.ReservedThroughputDetails;
    Console.WriteLine("* Reserved read/write throughput");
    Console.WriteLine("Reserved read throughput: " + reservedThroughputDetails.CapacityUnit.Read);
    Console.WriteLine("Reserved write throughput: " + reservedThroughputDetails.CapacityUnit.Write);
}
catch (Exception ex)
{
    Console.WriteLine($"Describe table failed, exception:{ex.Message}");
}