List table names (TypeScript)
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 a promise that resolves to the table names as an unordered list of strings.
Parameters
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 |
|---|---|---|
|
|
The options for this operation.
See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Must be |
|
|
Optional. The keyspace to inspect. For an example, see List table names and specify the keyspace. Default: The working keyspace for the database.
This is |
|
|
Optional. A timeout to impose on the underlying API request. |
Examples
The following examples demonstrate how to list table names.
List table names
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);
})();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.
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);
})();Client reference
For more information, see the client reference.
