List table names (Go)

Gets the names of the tables in a keyspace.

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

Returns the table names as an unordered slice of strings.

Parameters

Use the ListTableNames method, which belongs to the Db type.

Method signature
func (d *Db) ListTableNames(
  ctx context.Context,
  opts ...options.ListTablesOption
) ([]string, error)
Name Type Summary

ctx

context.Context

The context for the operation.

opts

…​options.ListTablesOption

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

Methods of the ListTablesOption builder
Method Summary

SetKeyspace(v string)

Optional if you specified a working keyspace when you created the Db object. The keyspace to inspect.

Default: The working keyspace set when you created the Db object, if one was provided.

UpdateAPIOptions(v …​APIOption)

Optional. General API options for this operation, including the timeout.

Examples

The following examples demonstrate how to list table names.

List table names

package main

import (
	"context"
	"fmt"
	"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"),
	)

	// List table names
	names, err := database.ListTableNames(ctx)

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

	fmt.Println(names)
}

Client reference

For more information, see the client reference.

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2026 | Privacy policy | Terms of use Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM