List table names

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 list of strings.

Returns a promise that resolves to the table names as an unordered list of strings.

The Go client is in preview. For more information, see astra-db-go.

Returns the table names as an unordered slice of strings.

Returns the table names as an unordered list of strings.

Returns the table names as an unordered list of strings in the status.tables field of the response.

Example response:

{
  "status": {
    "tables":[
      "quickstart_table",
      "another_table"
    ]
  }
}

Parameters

Use the list_table_names method, which belongs to the astrapy.Database class.

Method signature

list_table_names(
  *,
  keyspace: str,
  table_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> list[str]

Name Type Summary

Name	Type	Summary
`keyspace`	`str`	Optional. The keyspace to inspect. For an example, see List table names and specify the keyspace. Default: The database’s working keyspace.
`table_admin_timeout_ms`	`int`	Optional. A timeout, in milliseconds, for the underlying HTTP request. If not provided, the `Database` setting is used. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

keyspace

str

Optional. The keyspace to inspect.

For an example, see List table names and specify the keyspace.

Default: The database’s working keyspace.

table_admin_timeout_ms

int

Optional. A timeout, in milliseconds, for the underlying HTTP request. If not provided, the Database setting is used. This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Use the listTables method, which belongs to the Db class.

Method signature

async listTables(
  options: {
    nameOnly: true,
    keyspace?: string,
    timeout?: number | TimeoutDescriptor,
  },
): TableDescriptor[]

Name Type Summary

Name	Type	Summary
`options`	`ListTablesOptions`	The options for this operation. See Properties of `options` for more details.

options

ListTablesOptions

The options for this operation. See Properties of options for more details.

Properties of `options`
Name	Type	Summary
`nameOnly`	`true`	Must be `true` to return only the table names. Otherwise, additional metadata about the tables is returned.
`keyspace`	`string`	Optional. The keyspace to inspect. For an example, see List table names and specify the keyspace. Default: The database’s working keyspace.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

The Go client is in preview. For more information, see astra-db-go.

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

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.

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. The keyspace to inspect. Default: The database’s working keyspace.
`UpdateAPIOptions(v …APIOption)`	Optional. General API options for this operation, including the timeout.

Use the listTableNames method, which belongs to the com.datastax.astra.client.databases.Database class.

Method signature

List<String> listTableNames()

List<String> listTableNames(ListTablesOptions listTablesOptions)

Name Type Summary

Name	Type	Summary
`options`	`ListTablesOptions`	Optional. The options for this operation, including the keyspace and timeouts.

options

ListTablesOptions

Optional. The options for this operation, including the keyspace and timeouts.

Use the ListTableNamesAsync method, which belongs to the Database class. You can also use ListTableNames, which is the synchronous version of the method.

Method signature

public Task<List<string>> ListTableNamesAsync(
  ListTableNamesOptions options = null
);

Name Type Summary

Name	Type	Summary
`options`	`ListTableNamesOptions`	Optional. General API options for this operation, including the keyspace and timeout. For more information and examples, see Customize API interaction.

options

ListTableNamesOptions

Optional. General API options for this operation, including the keyspace and timeout. For more information and examples, see Customize API interaction.

Use the listTables command.

Command signature

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "listTables": {
    "options": {
      "explain": false
    }
  }
}'

Name Type Summary

Name	Type	Summary
`options.explain`	`false`	Must be `false` to return only the table names. Otherwise, additional metadata about the tables is returned.

options.explain

false

Must be false to return only the table names. Otherwise, additional metadata about the tables is returned.

Examples

The following examples demonstrate how to list table names.

List table names

from astrapy import DataAPIClient

# Get a database
client = DataAPIClient()
database = client.get_database(
    "API_ENDPOINT", token="APPLICATION_TOKEN"
)

# List table names
result = database.list_table_names()
print(result)

import { DataAPIClient } from "@datastax/astra-db-ts";

// Get a database
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});

// List table names
(async function () {
  const result = await database.listTables({ nameOnly: true });

  console.log(result);
})();

The Go client is in preview. For more information, see astra-db-go.

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

	database := client.Database(
		"API_ENDPOINT",
		options.API().SetToken("APPLICATION_TOKEN"),
	)

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

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

	fmt.Println(names)
}

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.databases.Database;
import java.util.List;

public class Example {

  public static void main(String[] args) {
    // Get a database
    Database database = new DataAPIClient("APPLICATION_TOKEN").getDatabase("API_ENDPOINT");

    // List table names
    List<String> result = database.listTableNames();

    System.out.println(result);
  }
}

using System.Text.Json;
using DataStax.AstraDB.DataApi;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get a database
    var client = new DataAPIClient();
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // List table names
    var names = await database.ListTableNamesAsync();

    Console.WriteLine(JsonSerializer.Serialize(names));
  }
}

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "listTables": {
    "options": {
      "explain": false
    }
  }
}'

List table names and specify the keyspace

By default, this method uses the working keyspace of your database. If you want to use a different keyspace, you must specify the keyspace.

from astrapy import DataAPIClient

# Get a database
client = DataAPIClient()
database = client.get_database(
    "API_ENDPOINT", token="APPLICATION_TOKEN"
)

# List table names
result = database.list_table_names(keyspace="KEYSPACE_NAME")
print(result)

import { DataAPIClient } from "@datastax/astra-db-ts";

// Get a database
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});

// List table names
(async function () {
  const result = await database.listTables({
    nameOnly: true,
    keyspace: "KEYSPACE_NAME",
  });

  console.log(result);
})();

The Go client is in preview. For more information, see astra-db-go.

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

	database := client.Database(
		"API_ENDPOINT",
		options.API().SetToken("APPLICATION_TOKEN"),
	)

	// List table names
	names, err := database.ListTableNames(
		ctx,
		options.ListTables().SetKeyspace("KEYSPACE_NAME"),
	)

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

	fmt.Println(names)
}

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.commands.options.ListTablesOptions;
import java.util.List;

public class Example {

  public static void main(String[] args) {
    // Get a database
    Database database = new DataAPIClient("APPLICATION_TOKEN").getDatabase("API_ENDPOINT");

    // List table names
    ListTablesOptions options = new ListTablesOptions().keyspace("KEYSPACE_NAME");
    List<String> result = database.listTableNames(options);

    System.out.println(result);
  }
}

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get a database
    var client = new DataAPIClient();
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // List table names
    var names = await database.ListTableNamesAsync(
      new ListTableNamesOptions() { Keyspace = "KEYSPACE_NAME" }
    );

    Console.WriteLine(JsonSerializer.Serialize(names));
  }
}

This option has no literal equivalent in HTTP. Instead, you always specify the keyspace in the path.

Client reference

For more information, see the client reference.

The Go client is in preview. For more information, see astra-db-go.

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

List table names

Result

Parameters

Examples

List table names

List table names and specify the keyspace

Client reference

Was this helpful?

Give Feedback