List table metadata (C#)
|
Tables with the Data API are currently in public preview. Development is ongoing, and the features and functionality are subject to change. Hyper-Converged Database (HCD), and the use of such, is subject to the DataStax Preview Terms. |
Gets information about the tables in a keyspace.
|
Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart. |
Result
Returns IEnumerable<TableInfo>, where each TableInfo object describes a table.
Parameters
Use the ListTablesAsync method, which belongs to the Database class.
You can also use ListTables, which is the synchronous version of the method.
Method signature
public Task<IEnumerable<TableInfo>> ListTablesAsync(
ListTablesOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
Optional.
General API options for this operation, including the keyspace and timeout.
Keyspace is required unless you specified a working keyspace when instantiating the |
Examples
The following examples demonstrate how to list table metadata.
List table metadata
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get a database
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// List table metadata
var result = await database.ListTablesAsync();
}
}Client reference
For more information, see the client reference.
