List collection metadata (Python)

Gets information about 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

Returns a list of CollectionDescriptor objects that describe each collection.

Parameters

Use the list_collections method, which belongs to the astrapy.Database class.

Method signature

list_collections(
  *,
  keyspace: str,
  collection_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> list[CollectionDescriptor]

Name Type Summary

Name	Type	Summary
`keyspace`	`str`	Optional. The keyspace to inspect. Default: The working keyspace for the database. This is `default_keyspace` unless you set a different working keyspace when you created the `Database` object.
`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 working keyspace for the database. This is default_keyspace unless you set a different working keyspace when you created the Database object.

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.

Examples

The following examples demonstrate how to get collection metadata.

from astrapy import DataAPIClient

# Get a database
client = DataAPIClient()
database = client.get_database(
    "API_ENDPOINT", token="APPLICATION_TOKEN"
)

# List collections
database.list_collections()

Client reference

For more information, see the client reference.

List collection metadata (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback