List user-defined types (UDTs) (Java)
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 TableUserDefinedTypeDescriptor objects that describe each user-defined type in the keyspace.
Parameters
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 |
|---|---|---|
|
|
Optional.
The options for this operation, including the keyspace and timeouts.
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.
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);
}
}Client reference
For more information, see the client reference.
