List table names (C#)
Gets the names of 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 the table names as an unordered list of strings.
Parameters
Use the ListTableNamesAsync method, which belongs to the Database class.
You can also use ListTableNames, which is the synchronous version of the method.
Method signature
public Task<List<string>> ListTableNamesAsync(
ListTableNamesOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
Optional. General API options for this operation, including the keyspace and timeout. For more information and examples, see Customize API interaction. |
Examples
The following examples demonstrate how to list table names.
List table names
using System.Text.Json;
using DataStax.AstraDB.DataApi;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get a database
var client = new DataAPIClient();
var database = client.GetDatabase(
"API_ENDPOINT",
"APPLICATION_TOKEN"
);
// List table names
var names = await database.ListTableNamesAsync();
Console.WriteLine(JsonSerializer.Serialize(names));
}
}List table names and specify the keyspace
By default, this method uses the working keyspace of your database. If you want to use a different keyspace, you must specify the keyspace.
using System.Text.Json;
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();
var database = client.GetDatabase(
"API_ENDPOINT",
"APPLICATION_TOKEN"
);
// List table names
var names = await database.ListTableNamesAsync(
new ListTableNamesOptions() { Keyspace = "KEYSPACE_NAME" }
);
Console.WriteLine(JsonSerializer.Serialize(names));
}
}Client reference
For more information, see the client reference.
