List table names
|
Tables with the Data API are currently in public preview. Development is ongoing, and the features and functionality are subject to change. Hyper-Converged Database (HCD), and the use of such, is subject to the DataStax Preview Terms. |
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 |
|---|---|---|
|
|
Optional if you specified a keyspace when instantiating the Default: The database’s working keyspace. |
|
|
A timeout, in milliseconds, for the underlying HTTP request.
If not provided, the |
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. |
Options (ListTablesOptions):
| Name | Type | Summary |
|---|---|---|
|
|
If false or undefined, the response includes table names and metadata. If true, the response includes only table names. |
|
|
Optional if you specified a keyspace when instantiating the Default: The database’s working keyspace. |
|
|
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 |
|---|---|---|
|
Specialization of the operation, including |
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 |
|---|---|---|
|
|
The Data API command to get a list of tables in a keyspace in a database. |
|
|
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
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# List table names
result = database.list_table_names(keyspace="KEYSPACE_NAME")
print(result)import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
// 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.DataAPIClients;
import com.datastax.astra.client.databases.Database;
import java.util.List;
public class Example {
public static void main(String[] args) {
// Get a database
DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// List table names
List<String> result = database.listTableNames();
System.out.println(result);
}
}curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"listTables": {
"options": {
"explain": false
}
}
}'Client reference
-
Python
-
TypeScript
-
Java
-
curl
For more information, see the client reference.
For more information, see the client reference.
For more information, see the client reference.
Client reference documentation is not applicable for HTTP.
