List user-defined types (UDTs) (C#)
Gets information about the user-defined types (UDTs) 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 an unordered list of UserDefinedTypeInfo objects that describe each user-defined type in the keyspace.
Parameters
Use the ListTypesAsync method, which belongs to the Database class.
You can also use ListTypes, which is the synchronous version of the method.
Method signature
public Task<List<UserDefinedTypeInfo>> ListTypesAsync(
ListTypesOptions 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 metadata about user-defined types in a keyspace.
using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing table
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// List types
var types = await database.ListTypesAsync();
Console.WriteLine(JsonSerializer.Serialize(types));
}
}Client reference
For more information, see the client reference.
