Drop a database (Go)

Terminating a database permanently deletes all of its data, including automatic backups. You cannot undo this action.

Deletes a database and erases all data stored in it.

You need an application token with permission to create and configure databases, such as the Organization Administrator role.

For more information, see Get endpoint and token.

Result

Deletes the specified database and erases all data stored in the database.

A successful operation does not return anything.

Parameters

Use the DropDatabase method, which belongs to the AstraAdmin type.

Method signature

func (a *AstraAdmin) DropDatabase(
  ctx context.Context,
  databaseID string,
  opts ...options.DropDatabaseOption
) error

Name Type Summary

Name	Type	Summary
`ctx`	`context.Context`	The context for the operation.
`databaseID`	`string`	The ID of the database to drop.
`opts`	`…options.DropDatabaseOption`	Optional. A builder to generate options for this operation. See Methods of the `DropDatabaseOption` builder for more details.

ctx

context.Context

The context for the operation.

databaseID

string

The ID of the database to drop.

opts

…options.DropDatabaseOption

Optional. A builder to generate options for this operation. See Methods of the DropDatabaseOption builder for more details.

Methods of the `DropDatabaseOption` builder
Method	Summary
`SetBlocking(v bool)`	Optional. Whether to wait for the database to be fully deleted before returning. If false, the method returns immediately after issuing the deletion request. Default: true
`SetPollInterval(v time.Duration)`	Optional. Controls how often to check the database status if `SetBlocking()` is true. Default: 10 seconds
`UpdateAPIOptions(v …APIOption)`	Optional. General API options for this operation, including the timeout.

Examples

The following examples demonstrate how to drop a database.

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()

	client := astra.NewClient(
		options.API().SetToken("APPLICATION_TOKEN"),
	)

	admin, err := client.Admin()

	if err != nil {
		log.Fatal(err)
	}

	err = admin.DropDatabase(ctx, "DATABASE_ID")

	if err != nil {
		log.Fatal(err)
	}
}

Client reference

For more information, see the client reference.

Drop a database (Go)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback