Drop a user-defined type (UDT) (Go)
Drops a user-defined type (UDT) from a keyspace.
You can’t drop a user-defined type that is currently used by a table. You must first use drop the columns that use the user-defined type.
|
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
Drops the specified user-defined type.
A successful operation does not return anything.
Parameters
Use the DropType method, which belongs to the Db type.
Method signature
func (d *Db) DropType(
ctx context.Context,
name string,
opts ...options.DropTypeOption
) error| Name | Type | Summary |
|---|---|---|
|
|
The context for the operation. |
|
|
The name of the user-defined type to drop. |
|
Optional.
A builder to generate options for this operation.
See Methods of the |
| Method | Summary |
|---|---|
|
Optional. The keyspace containing the user-defined type. Default: The working keyspace for the database.
This is |
|
Optional. Whether the command should silently succeed even if a user-defined type with the given name does not exist in the keyspace and a user-defined type wasn’t dropped. Default: false |
|
Optional. General API options for this operation, including the timeout. |
Examples
The following examples demonstrate how to drop a user-defined type.
Drop a user-defined type
package main
import (
"context"
"log"
"github.com/datastax/astra-db-go/v2/astra"
"github.com/datastax/astra-db-go/v2/astra/options"
)
func main() {
ctx := context.Background()
// Get a database
client := astra.NewClient()
database := client.Database(
"API_ENDPOINT",
options.API().SetToken("APPLICATION_TOKEN"),
)
// Drop a user-defined type
err := database.DropType(ctx, "UDT_NAME")
if err != nil {
log.Fatal(err)
}
}Drop a user-defined type only if the type exists
Use this option to silently do nothing if a user-defined type with the specified name does not exist.
package main
import (
"context"
"log"
"github.com/datastax/astra-db-go/v2/astra"
"github.com/datastax/astra-db-go/v2/astra/options"
)
func main() {
ctx := context.Background()
// Get a database
client := astra.NewClient()
database := client.Database(
"API_ENDPOINT",
options.API().SetToken("APPLICATION_TOKEN"),
)
// Drop a user-defined type
err := database.DropType(
ctx,
"UDT_NAME",
options.DropType().SetIfExists(true),
)
if err != nil {
log.Fatal(err)
}
}Client reference
For more information, see the client reference.
