Drop a table (Go)
|
Tables with the Data API are currently in public preview. Development is ongoing, and the features and functionality are subject to change. Hyper-Converged Database (HCD), and the use of such, is subject to the DataStax Preview Terms. |
Deletes a table from a database, including all data stored in the table.
|
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
Deletes the specified table from the database, including all data stored in the table.
A successful operation does not return anything.
Parameters
Use the DropTable method, which belongs to the Db type.
Method signature
func (d *Db) DropTable(
ctx context.Context,
name string,
opts ...options.DropTableOption
) error| Name | Type | Summary |
|---|---|---|
|
|
The context for the operation. |
|
|
The name of the table to drop. |
|
Optional.
A builder to generate options for this operation.
See Methods of the |
| Method | Summary |
|---|---|
|
Optional if you specified a working keyspace when you created the Default: The working keyspace set when you created the |
|
Optional. Whether the command should silently succeed even if a table with the given name does not exist in the keyspace and no table was dropped. For an example, see Drop a table only if the table exists. Default: false |
|
Optional. General API options for this operation, including the timeout. |
Examples
The following examples demonstrate how to drop a table.
Drop a table by name
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(
options.API().SetEnvironment(options.EnvironmentHCD),
)
database := client.Database(
"API_ENDPOINT",
options.API().
SetUsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD",
).
SetKeyspace("KEYSPACE_NAME"),
)
// Drop a table
err := database.DropTable(ctx, "TABLE_NAME")
if err != nil {
log.Fatal(err)
}
}Drop a table through a Table object
If you get a Table object through one of the clients, you can drop the table through that object.
The Go client does not support this method of dropping a table. Instead, drop the table by name.
Drop a table only if the table exists
Use this option to silently do nothing if a table 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(
options.API().SetEnvironment(options.EnvironmentHCD),
)
database := client.Database(
"API_ENDPOINT",
options.API().
SetUsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD",
).
SetKeyspace("KEYSPACE_NAME"),
)
// Drop a table
err := database.DropTable(
ctx,
"TABLE_NAME",
options.DropTable().SetIfExists(true),
)
if err != nil {
log.Fatal(err)
}
}Client reference
For more information, see the client reference.
