List user-defined types (UDTs) (TypeScript)

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 a promise that resolves to an unordered list of TypeDescriptor objects that describe each user-defined type in the keyspace.

Parameters

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. 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 `Db` object.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

Examples

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

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

// Get a database
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});

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

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

Client reference

For more information, see the client reference.

List user-defined types (UDTs) (TypeScript)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback