List table names (Python)
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.
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 |
|---|---|---|
|
|
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, in milliseconds, for the underlying HTTP request.
If not provided, the |
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)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)Client reference
For more information, see the client reference.
