List collection metadata (C#)
Gets information about 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 IEnumerable<CollectionInfo>, where each CollectionInfo object describes a collection.
Parameters
Use the ListCollectionsAsync method, which belongs to the Database class.
You can also use ListCollections, which is the synchronous version of the method.
Method signature
public Task<IEnumerable<CollectionInfo>> ListCollectionsAsync(
ListCollectionsOptions 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 get collection metadata.
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 collections
var collectionMetadata = await database.ListCollectionsAsync();
Console.WriteLine(JsonSerializer.Serialize(collectionMetadata));
}
}Client reference
For more information, see the client reference.
