List user-defined type names (UDTs) (Python)

Gets the names of 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 the names of the user-defined types as an unordered list of strings.

Parameters

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

Method signature

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

Name Type Summary

Name	Type	Summary
`keyspace`	`str`	Optional. The keyspace to inspect. Default: The working keyspace for the database. This is `default_keyspace` unless you set a different working keyspace when you created the `Database` object.
`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. The keyspace to inspect.

Default: The working keyspace for the database. This is default_keyspace unless you set a different working keyspace when you created the Database object.

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.

Examples

The following examples demonstrate how to list names of the user-defined types in a keyspace.

from astrapy import DataAPIClient

# Get a database
client = DataAPIClient()
database = client.get_database(
    "API_ENDPOINT", token="APPLICATION_TOKEN"
)

# List type names
result = database.list_type_names()
print(result)

Client reference

For more information, see the client reference.

List user-defined type names (UDTs) (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback