Alter a user-defined type (UDT) (Java)

Adds and renames fields in a user-defined type (UDT).

This command can’t rename the user-defined type itself or drop fields from the user-defined type. Instead, you must drop the user-defined type and then re-create the user-defined type with the desired name and fields.

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

Adds or renames fields in a user-defined type.

Does not return anything.

Parameters

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

Method signature

void alterType(String name, AlterTypeOperation operation)

void alterType(
  String name,
  AlterTypeOperation operation,
  AlterTypeOptions options
)

Name Type Summary

Name	Type	Summary
`name`	`String`	The name of the user-defined type to alter.
`operation`	`AlterTypeOperation`	The alter operation to perform. Can be one of the following: An `AlterTypeAddFields` object that defines the name and data type of each field to add to the user-defined type. You can use any supported data type, except for maps, lists, sets, or other user-defined types. An `AlterTypeRenameFields` object that describes the fields to rename. See the examples for usage.
`options`	`AlterTypeOptions`	Optional. The options for this operation. See Methods of the `AlterTypeOptions` class for more details.

name

String

The name of the user-defined type to alter.

operation

AlterTypeOperation

The alter operation to perform.

Can be one of the following:

An AlterTypeAddFields object that defines the name and data type of each field to add to the user-defined type. You can use any supported data type, except for maps, lists, sets, or other user-defined types.
An AlterTypeRenameFields object that describes the fields to rename.

See the examples for usage.

options

AlterTypeOptions

Optional. The options for this operation. See Methods of the AlterTypeOptions class for more details.

Methods of the `AlterTypeOptions` class
Method	Parameters	Summary
`keyspace()`	`String`	Optional. The keyspace where the user-defined type exists. Default: The working keyspace for the database. This is `default_keyspace` unless you set a different working keyspace when you created the `Database` object.

Examples

The following examples demonstrate how to alter a user-defined type.

Rename fields

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.commands.AlterTypeRenameFields;

public class Example {

  public static void main(String[] args) {
    // Get a database
    Database database = new DataAPIClient("APPLICATION_TOKEN").getDatabase("API_ENDPOINT");

    // Rename fields in a user-defined type
    database.alterType(
        "member",
        new AlterTypeRenameFields()
            .addField("name", "first_name")
            .addField("is_active", "is_member"));
  }
}

Add fields

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.commands.AlterTypeAddFields;

public class Example {

  public static void main(String[] args) {
    // Get a database
    Database database = new DataAPIClient("APPLICATION_TOKEN").getDatabase("API_ENDPOINT");

    // Add fields to a user-defined type
    database.alterType(
        "member", new AlterTypeAddFields().addFieldText("email").addFieldInt("credits"));
  }
}

Rename and add fields

You cannot use the client to rename and add fields in the same call. Make separate calls, or use HTTP directly.

Client reference

For more information, see the client reference.

Alter a user-defined type (UDT) (Java)

Result

Parameters

Examples

Rename fields

Add fields

Rename and add fields

Client reference

Was this helpful?

Give Feedback