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

Python
TypeScript
Java
curl

Returns the table names as an unordered list of strings.

Example response:

["quickstart_table", "another_table"]

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

Example resolved response:

["quickstart_table", "another_table"]

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

Python
TypeScript
Java
curl

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. Default: The database’s working keyspace.
`table_admin_timeout_ms`	`Optional[int]`	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.

Default: The database’s working keyspace.

table_admin_timeout_ms

Optional[int]

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.

options

ListTablesOptions

The options for this operation.

Options (ListTablesOptions):

Name Type Summary

Name	Type	Summary
`nameOnly?`	`boolean`	If false or undefined, the response includes table names and metadata. If true, the response includes only table names.
`keyspace?`	`string`	Optional. The keyspace to inspect. Default: The database’s working keyspace.
`timeout?`	`number \| TimeoutDescriptor`	The client-side timeout for this operation.

nameOnly?

boolean

If false or undefined, the response includes table names and metadata. If true, the response includes only table names.

keyspace?

string

Optional. The keyspace to inspect.

Default: The database’s working keyspace.

timeout?

number | TimeoutDescriptor

The client-side timeout for this operation.

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`	Specialization of the operation, including `timeout` and `keyspace`.

options

ListTablesOptions

Specialization of the operation, including timeout and keyspace.

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
`listTables`	`command`	The Data API command to get a list of tables in a keyspace in a database.
`options.explain`	`boolean`	If true, the response includes table names and metadata. If false or unset, the response includes only table names.

listTables

command

The Data API command to get a list of tables in a keyspace in a database.

options.explain

boolean

If true, the response includes table names and metadata. If false or unset, the response includes only table names.

Examples

The following examples demonstrate how to list table names.

List table names

Python
TypeScript
Java
curl

from astrapy import DataAPIClient

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

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

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

// Get a database
const client = new DataAPIClient("APPLICATION_TOKEN");
const database = client.db("API_ENDPOINT");

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

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

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);
  }
}

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.

Python
TypeScript
Java
curl

from astrapy import DataAPIClient

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

# 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("APPLICATION_TOKEN");
const database = client.db("API_ENDPOINT");

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

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

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);
  }
}

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

Client reference

Python
TypeScript
Java
curl

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