Drop an index (Go)
Deletes an index from a table in a database.
|
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 index.
A successful operation does not return anything.
Parameters
Use the DropTableIndex method, which belongs to the Db type.
Method signature
func (d *Db) DropTableIndex(
ctx context.Context,
name string,
opts ...options.DropTableIndexOption
) error| Name | Type | Summary |
|---|---|---|
|
|
The context for the operation. |
|
|
The name of the index to delete. |
|
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 an index with the given name does not exist in the keyspace and no index was dropped. Default: false |
|
Optional. General API options for this operation, including the timeout. |
Examples
The following examples demonstrate how to drop an index from a table.
Drop an index
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 an index
err := database.DropTableIndex(
ctx,
"INDEX_NAME",
)
if err != nil {
log.Fatal(err)
}
}Drop an index only if the index exists
Use this option to silently do nothing if an index 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 an index
err := database.DropTableIndex(
ctx,
"INDEX_NAME",
options.DropTableIndex().SetIfExists(true),
)
if err != nil {
log.Fatal(err)
}
}Client reference
For more information, see the client reference.
