List collection names (C#)
Gets the names of the collections 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 collection names as an unordered list of strings.
Parameters
Use the ListCollectionNamesAsync method, which belongs to the Database class.
You can also use ListCollectionNames, which is the synchronous version of the method.
Method signature
public Task<List<string>> ListCollectionNamesAsync(
ListCollectionNamesOptions 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 get collection names.
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(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// List collections
var names = await database.ListCollectionNamesAsync();
Console.WriteLine(JsonSerializer.Serialize(names));
}
}Client reference
For more information, see the client reference.
