Alter a user-defined type (UDT) (Go)
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.
A successful operation does not return anything.
Parameters
Use the AlterType method, which belongs to the Db type.
Method signature
func (d *Db) AlterType(
ctx context.Context,
name string,
op table.AlterTypeOperation,
opts ...options.AlterTypeOption
) error| Name | Type | Summary |
|---|---|---|
|
|
The context for the operation. |
|
|
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. The options for this method. See Methods of the |
| Method | Summary |
|---|---|
|
Optional. The keyspace where the user-defined type exists. Default: The working keyspace for the database.
This is |
|
Optional. General API options for this operation, including the timeout. |
Examples
The following examples demonstrate how to alter a user-defined type.
Rename fields
package main
import (
"context"
"log"
"github.com/datastax/astra-db-go/v2/astra"
"github.com/datastax/astra-db-go/v2/astra/options"
"github.com/datastax/astra-db-go/v2/astra/table"
)
func main() {
ctx := context.Background()
// Get a database
client := astra.NewClient()
database := client.Database(
"API_ENDPOINT",
options.API().SetToken("APPLICATION_TOKEN"),
)
// Rename fields in a user-defined type
err := database.AlterType(ctx, "member", table.RenameTypeFields{
Fields: map[string]string{
"name": "first_name", "is_active": "is_member",
}})
if err != nil {
log.Fatal(err)
}
}Add fields
package main
import (
"context"
"log"
"github.com/datastax/astra-db-go/v2/astra"
"github.com/datastax/astra-db-go/v2/astra/options"
"github.com/datastax/astra-db-go/v2/astra/table"
)
func main() {
ctx := context.Background()
// Get a database
client := astra.NewClient()
database := client.Database(
"API_ENDPOINT",
options.API().SetToken("APPLICATION_TOKEN"),
)
// Add fields to a user-defined type
err := database.AlterType(ctx, "member", table.AddTypeFields{
Fields: table.Columns{
{Name: "email", Column: table.Text()},
{Name: "credits", Column: table.Int()},
}})
if err != nil {
log.Fatal(err)
}
}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.
