List collection names
Gets the names of the collections 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
-
CLI
Returns the collection names as an unordered list of strings.
Example response:
['my_collection', 'my_vector_collection']
Returns a promise that resolves to the collection names as an unordered list of strings.
Example resolved response:
["quickstart_collection", "another_collection"]
Returns the collection names as a Stream of strings.
Returns the collection names as an unordered list of strings in the status.collections
field of the response.
Example response:
{
"status": {
"collections":[
"quickstart_collection",
"another_collection"
]
}
}
Prints the names of the collections.
Example response:
+---------------------+
| Name |
+---------------------+
| collection_simple |
| collection_vector |
| msp |
+---------------------+
Parameters
-
Python
-
TypeScript
-
Java
-
curl
-
CLI
Use the list_collection_names
method, which belongs to the astrapy.Database
class.
Method signature
list_collection_names(
*,
keyspace: str,
collection_admin_timeout_ms: int,
request_timeout_ms: int,
timeout_ms: int,
) -> list[str]
Name | Type | Summary |
---|---|---|
|
|
Optional. The keyspace to inspect. Default: The database’s working keyspace. |
|
|
A timeout, in milliseconds, for the underlying HTTP request.
If not provided, the |
Use the listCollections
method, which belongs to the Db
class.
Method signature
async listCollections(
options: {
nameOnly: true,
keyspace?: string,
timeout?: number | TimeoutDescriptor,
}
): string[]
Name | Type | Summary |
---|---|---|
|
Optional.
The options for this operation.
See Properties of |
Name | Type | Summary |
---|---|---|
|
Must be |
|
|
Optional. The keyspace to inspect. Default: The database’s working keyspace. |
|
|
|
Optional. The timeout(s) to apply to this method.
You can specify Details about the
|
Use the listCollectionNames
method, which belongs to the com.datastax.astra.client.Database
class.
Method signature
List<String> listCollectionNames()
List<String> listCollectionNames(ListCollectionOptions options)
Name | Type | Summary |
---|---|---|
|
Optional. The options for this operation, including the keyspace and timeouts. |
Use the findCollections
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 '{
"findCollections": {
"options": {
"explain": false
}
}
}'
Name | Type | Summary |
---|---|---|
|
|
Must be |
Command signature
astra db list-collections DATABASE_ID | cut -b 1-23
Name | Type | Summary |
---|---|---|
|
|
To get the |
Examples
The following examples demonstrate how to get collection names.
-
Python
-
TypeScript
-
Java
-
curl
-
CLI
from astrapy import DataAPIClient
# Get a database
client = DataAPIClient()
database = client.get_database(
"API_ENDPOINT",
token="APPLICATION_TOKEN",
)
# List collections
database.list_collection_names()
import { DataAPIClient } from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient("APPLICATION_TOKEN");
const database = client.db("API_ENDPOINT");
// List collections
(async function () {
await database.listCollections({ nameOnly: true });
})();
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 collections
List<String> collectionNames = database.listCollectionNames();
}
}
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"findCollections": {
"options": {
"explain": false
}
}
}'
astra db list-collections DATABASE_ID | cut -b 1-23
Client reference
-
Python
-
TypeScript
-
Java
-
curl
-
CLI
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.
For more information, see the Astra CLI documentation.