List user-defined types (UDTs)

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

Python
TypeScript
Java
C#
curl

Returns an unordered list of ListTypeDescriptor objects that describe each user-defined type in the keyspace.

Returns a promise that resolves to an unordered list of TypeDescriptor objects that describe each user-defined type in the keyspace.

Returns an unordered list of TableUserDefinedTypeDescriptor objects that describe each user-defined type in the keyspace.

Returns an unordered list of UserDefinedTypeInfo objects that describe each user-defined type in the keyspace.

The status.types field in the response describes each user-defined type.

Example response:

{
  "status": {
    "types": [
      {
        "type": "userDefined",
        "udtName": "address",
        "definition": {
          "fields": {
            "city": {
              "type": "text"
            },
            "country": {
              "type": "text"
            }
          }
        },
        "apiSupport": {
          "createTable": true,
          "insert": true,
          "read": true,
          "filter": false,
          "cqlDefinition": "demo.address"
        }
      }
    ]
  }
}

Parameters

Python
TypeScript
Java
C#
curl

Use the list_types method, which belongs to the astrapy.Database class.

Method signature

list_types(
  *,
  keyspace: str,
  table_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> list[ListTypeDescriptor]

Name Type Summary

Name	Type	Summary
`keyspace`	`str`	Optional if you specified a keyspace when instantiating the `Database` object. The keyspace to inspect. Default: The database’s working keyspace.
`table_admin_timeout_ms`	`int`	A timeout, in milliseconds, for the underlying HTTP request. If not provided, the `Database` setting is used. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

keyspace

str

Optional if you specified a keyspace when instantiating the Database object. The keyspace to inspect.

Default: The database’s working keyspace.

table_admin_timeout_ms

int

A timeout, in milliseconds, for the underlying HTTP request. If not provided, the Database setting is used. This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Use the listTypes method, which belongs to the Db class.

Method signature

async listTypes(
  options?: {
    nameOnly?: false,
    keyspace?: string,
    timeout?: number | TimeoutDescriptor,
  },
): TypeDescriptor[]

Name Type Summary

Name	Type	Summary
`options`	`ListTypesOptions`	Optional. The options for this operation. See Properties of `options` for more details.

options

ListTypesOptions

Optional. The options for this operation. See Properties of options for more details.

Properties of `options`
Name	Type	Summary
`nameOnly`	`false`	Optional. Must be `false` or undefined to return metadata about the user defined types. Otherwise, only the user defined type names are returned.
`keyspace`	`string`	Optional if you specified a keyspace when instantiating the `Db` object. The keyspace to inspect. Default: The database’s working keyspace.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

Use the listTypes method, which belongs to the com.datastax.astra.client.databases.Database class.

Method signature

List<TableUserDefinedTypeDescriptor> listTypes()

List<TableUserDefinedTypeDescriptor> listTypes(ListTypesOptions options)

Name Type Summary

Name	Type	Summary
`options`	`ListTypesOptions`	Optional. The options for this operation, including the keyspace and timeouts.

options

ListTypesOptions

Optional. The options for this operation, including the keyspace and timeouts.

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

Name	Type	Summary
`options`	`ListTypesOptions`	Optional. General API options for this operation, including the keyspace and timeout. Keyspace is required unless you specified a keyspace when instantiating the `Database` object. For more information and examples, see Customize API interaction.

options

ListTypesOptions

Optional. General API options for this operation, including the keyspace and timeout. Keyspace is required unless you specified a keyspace when instantiating the Database object. For more information and examples, see Customize API interaction.

Use the listTypes command.

Command signature

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "listTypes": {
    "options": {
      "explain": true
    }
  }
}'

Name Type Summary

Name	Type	Summary
`options.explain`	`true`	Must be `true` to return metadata about the user-defined types. Otherwise, only the names of the user-defined types are returned.

options.explain

true

Must be true to return metadata about the user-defined types. Otherwise, only the names of the user-defined types are returned.

Examples

The following examples demonstrate how to get metadata about user-defined types in a keyspace.

Python
TypeScript
Java
C#
curl

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)

# List type metadata
result = database.list_types(keyspace="KEYSPACE_NAME")
print(result)

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});

// List type metadata
(async function () {
  const result = await database.listTypes({
    nameOnly: false,
    keyspace: "KEYSPACE_NAME",
  });

  console.log(result);
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.definition.types.TableUserDefinedTypeDescriptor;
import java.util.List;

public class Example {

  public static void main(String[] args) {
    // Get a database
    Database database =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME");

    // List type metadata
    List<TableUserDefinedTypeDescriptor> result = database.listTypes();

    System.out.println(result);
  }
}

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));
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "listTypes": {
    "options": {
      "explain": true
    }
  }
}'

Client reference

Python
TypeScript
Java
C#
curl

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

List user-defined types (UDTs)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback