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
C#
curl

Returns the collection names as an unordered list of strings.

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

Returns the collection names as a Stream of strings.

Returns the collection names as an unordered list 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"
    ]
  }
}

Parameters

Python
TypeScript
Java
C#
curl

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

Name	Type	Summary
`keyspace`	`str`	Optional. The keyspace to inspect. Default: The database’s working keyspace.
`collection_admin_timeout_ms`	`int`	Optional. 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.

collection_admin_timeout_ms

int

Optional. 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 listCollections method, which belongs to the Db class.

Method signature

async listCollections(
  options: {
    nameOnly: true,
    keyspace?: string,
    timeout?: number | TimeoutDescriptor,
  }
): string[]

Name Type Summary

Name	Type	Summary
`options`	`ListCollectionsOptions`	The options for this operation. See Properties of `options` for more details.

options

ListCollectionsOptions

The options for this operation. See Properties of options for more details.

Properties of `options`
Name	Type	Summary
`nameOnly`	`true`	Must be `true` to return only the collection names. Otherwise, additional metadata about the collections is returned.
`keyspace`	`string`	Optional. The keyspace to inspect. Default: The database’s working keyspace.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. The timeout(s) to apply to this method. You can specify `requestTimeoutMs` and `collectionAdminTimeoutMs`. Details about the `timeout` parameter The `TimeoutDescriptor` object can contain these properties: `requestTimeoutMs` (`number`): The maximum time, in milliseconds, that the client should wait for each underlying HTTP request. Default: The default value for the collection. This default is 10 seconds unless you specified a different default when you initialized the `Collection` or `DataAPIClient` object. `collectionAdminTimeoutMs` (`number`): The maximum time, in milliseconds, for collection admin operations like creating, dropping, and listing collections. Default: The default value for the collection. This default is 60 seconds unless you specified a different default when you initialized the `Collection` or `DataAPIClient` object. If you specify a number instead of a `TimeoutDescriptor` object, that number will be applied to both `requestTimeoutMs` and `collectionAdminTimeoutMs`.

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

Name	Type	Summary
`options`	`ListCollectionOptions`	Optional. The options for this operation, including the keyspace and timeouts.

options

ListCollectionOptions

Optional. The options for this operation, including the keyspace and timeouts.

Use the ListCollectionNamesAsync method, which belongs to the Database class. You can also use ListCollectionNames, which is the synchronous version of the method.

Method signature

public Task<List<string>> ListCollectionNamesAsync(
  ListCollectionNamesOptions options = null
);

Name Type Summary

Name	Type	Summary
`options`	`ListCollectionNamesOptions`	Optional. General API options for this operation, including the keyspace and timeout. For more information and examples, see Customize API interaction.

options

ListCollectionNamesOptions

Optional. General API options for this operation, including the keyspace and timeout. For more information and examples, see Customize API interaction.

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

Name	Type	Summary
`options.explain`	`false`	Must be `false` to return only the collection names. Otherwise, additional metadata about the collections is returned.

options.explain

false

Must be false to return only the collection names. Otherwise, additional metadata about the collections is returned.

Examples

The following examples demonstrate how to get collection names.

Python
TypeScript
Java
C#
curl

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();
const database = client.db("API_ENDPOINT", {
  token: "APPLICATION_TOKEN",
});

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

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get a database
    var client = new DataAPIClient();
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    // List collections
    var names = await database.ListCollectionNamesAsync();

    Console.WriteLine(JsonSerializer.Serialize(names));
  }
}

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
    }
  }
}'

Client reference

Python
TypeScript
Java
C#
curl

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

List collection names

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback