Find all databases
Lists all databases.
|
You need an application token with permission to create and configure databases, such as the Organization Administrator role. For more information, see Get endpoint and token. |
Result
-
Python
-
TypeScript
-
Java
-
curl
Returns a list of AstraDBAdminDatabaseInfo objects that each describe a database.
Returns a promise that resolves to a list of FullDatabaseInfo objects that each describe a database.
Returns a list of DatabaseInfo objects that each describe a database.
Returns 200 Success and an array of objects that each describe a database.
Example response, truncated for brevity:
[
{
"id": "DB_ID",
"orgId": "organizations/ORG_ID",
"ownerId": "users/USER_ID",
"info": {
"name": "DB_NAME",
"keyspace": "INITIAL_KEYSPACE_NAME",
"cloudProvider": "CLOUD_PROVIDER",
"region": "REGION",
"additionalKeyspaces": [
"SECOND_KEYSPACE_NAME"
],
"dbType": "vector"
},
"creationTime": "2012-11-01T22:08:41+00:00",
"terminationTime": "2019-11-01T22:08:41+00:00",
"status": "ACTIVE",
# Response truncated for brevity
}
]Parameters
-
Python
-
TypeScript
-
Java
-
curl
Use the list_databases method, which belongs to the AstraDBAdmin class.
Method signature
list_databases(
*,
include: str,
provider: str,
page_size: int,
database_admin_timeout_ms: int,
request_timeout_ms: int,
timeout_ms: int,
) -> list[AstraDBAdminDatabaseInfo]| Name | Type | Summary |
|---|---|---|
|
|
Optional. Filters the returned databases by status. Can be one of: Some of these status are short-lived or do not apply to Serverless (Vector) databases. Default: |
|
|
Optional. Filters the returned databases by cloud provider. Can be one of: Default: |
|
|
Optional. The number of results per page for the underlying API request. The client manages pagination for you and returns the full list. Maximum: 100 Default: 25 |
|
|
Optional.
A timeout, in milliseconds, to impose on each underlying API request.
If not provided, the This parameter is aliased as |
Use the listDatabases method, which belongs to the AstraAdmin class.
Method signature
async listDatabases(
options?: {
include?: AstraDatabaseStatusFilter,
provider?: AstraDatabaseCloudProviderFilter,
limit?: number,
startingAfter?: string,
timeout: number | TimeoutDescriptor,
}): AstraFullDatabaseInfo[]| Name | Type | Summary |
|---|---|---|
|
Optional.
The options for this operation.
See Properties of |
| Name | Type | Summary |
|---|---|---|
|
Optional. Filters the returned databases by status. Can be one of: Some of these status are short-lived or do not apply to Serverless (Vector) databases. Default: |
|
|
Optional. Filters the returned databases by cloud provider. Can be one of: Default: |
|
|
|
Optional. The number of results per page for the underlying API request. The client manages pagination for you and returns the full list. Maximum: 100 Default: 25 |
|
|
Optional. The number of databases to skip before returning the remaining databases in the list. Default: 0 |
|
|
Optional. A timeout to impose on each underlying API request. |
Use the listDatabases method, which belongs to the com.datastax.astra.client.admin.AstraDBAdmin class.
Method signature
List<DatabaseInfo> listDatabases()This method does not accept any parameters.
Use the DevOps API to get information about all databases in an organization.
The application token must have sufficient permissions to perform the requested operations, such as the Organization Administrator role. Additionally, the application token identifies the organization to query.
Command signature
curl -sS -L -X GET "https://api.astra.datastax.com/v2/databases?include=STRING&provider=STRING&starting_after=STRING&limit=INTEGER" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"| Name | Type | Summary |
|---|---|---|
|
|
Optional. Filters the returned databases by status. Can be one of: Some of these status are short-lived or do not apply to Serverless (Vector) databases. Default: |
|
|
Optional. Filters the returned databases by cloud provider. Can be one of: Default: |
|
|
Optional. The first page of results to return. |
|
|
Optional. The number of results per page. Maximum: 100 Default: 25 |
Examples
The following examples demonstrate how to list databases.
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
client = DataAPIClient("APPLICATION_TOKEN")
admin = client.get_admin()
databases = admin.list_databases()
print(databases)import { DataAPIClient } from "@datastax/astra-db-ts";
const client = new DataAPIClient("APPLICATION_TOKEN");
const admin = client.admin();
(async function () {
const databases = await admin.listDatabases();
console.log(databases);
})();import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.admin.AstraDBAdmin;
import com.datastax.astra.client.databases.definition.DatabaseInfo;
import java.util.List;
public class Example {
public static void main(String[] args) {
DataAPIClient client = new DataAPIClient("APPLICATION_TOKEN");
AstraDBAdmin admin = client.getAdmin();
List<DatabaseInfo> databases = admin.listDatabases();
System.out.println(databases);
}
}curl -sS -L -X GET "https://api.astra.datastax.com/v2/databases" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"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.
