Alter a user-defined type (UDT) (Python)
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 alter_type method, which belongs to the astrapy.Database class.
Method signature
alter_type(
name: str,
*,
operation: AlterTypeOperation,
keyspace: str,
table_admin_timeout_ms: int,
request_timeout_ms: int,
timeout_ms: int,
) -> None| Name | Type | Summary |
|---|---|---|
|
|
The name of the user-defined type to alter. |
|
|
The alter operation to perform. Can be one of the following:
See the examples for usage. |
|
|
Optional if you specified a working keyspace when you created the Default: The working keyspace set when you created the |
|
|
Optional.
A timeout, in milliseconds, to impose on the underlying API request.
If not provided, the Table defaults apply.
This parameter is aliased as |
Examples
The following examples demonstrate how to alter a user-defined type.
Rename fields
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import AlterTypeRenameFields
# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace="KEYSPACE_NAME",
)
# Rename fields in a user-defined type
database.alter_type(
"member",
AlterTypeRenameFields(
fields={"name": "first_name", "is_active": "is_member"}
),
)Add fields
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import (
AlterTypeAddFields,
ColumnType,
TableScalarColumnTypeDescriptor,
)
# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace="KEYSPACE_NAME",
)
# Add fields to a user-defined type
database.alter_type(
"member",
AlterTypeAddFields(
fields={
"email": TableScalarColumnTypeDescriptor(ColumnType.TEXT),
"credits": TableScalarColumnTypeDescriptor(ColumnType.INT),
}
),
)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.
