response = client.databases.collections(database="my_first_database")
const response = await client.databases.collections({
database: "my_first_database",
});
curl -X GET 'https://api.hydradb.com/databases/collections?database=my_first_database' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"collections": ["user_alex", "user_johndoe", "workspace_42", "collection_default_abc123"],
"message": "Successfully retrieved collection IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": true,
"data": {
"collections": [],
"message": "Successfully retrieved collection IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
Databases
List Collections
List collection IDs inside a database.
GET
/
databases
/
collections
response = client.databases.collections(database="my_first_database")
const response = await client.databases.collections({
database: "my_first_database",
});
curl -X GET 'https://api.hydradb.com/databases/collections?database=my_first_database' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"collections": ["user_alex", "user_johndoe", "workspace_42", "collection_default_abc123"],
"message": "Successfully retrieved collection IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": true,
"data": {
"collections": [],
"message": "Successfully retrieved collection IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
Lists the collection IDs in a database. Collections are created by writing to them, so a new database has none: the first ingest without a
collection creates the default collection, and the first ingest under a new collection value creates that one.
response = client.databases.collections(database="my_first_database")
const response = await client.databases.collections({
database: "my_first_database",
});
curl -X GET 'https://api.hydradb.com/databases/collections?database=my_first_database' \
-H "Authorization: Bearer <your_api_key>" \
-H "API-Version: 2"
{
"success": true,
"data": {
"collections": ["user_alex", "user_johndoe", "workspace_42", "collection_default_abc123"],
"message": "Successfully retrieved collection IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": true,
"data": {
"collections": [],
"message": "Successfully retrieved collection IDs"
},
"error": null,
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 12.3
}
}
{
"success": false,
"data": null,
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"latency_ms": 4.8
}
}
Related resources
- After this: List Context: browse the sources in one
collection - After this: Delete Collection: remove a collection
- Related: Database Stats: row counts for the database
- Guide: Databases and Collections
Authorizations
Send your API key as Authorization: Bearer <your_api_key>.
Query Parameters
Database identifier
Example:
"acme_corp"
Response
OK
Show child attributes
Show child attributes
Example:
{
"collections": ["team_docs", "engineering"],
"message": "Success",
"sub_tenant_ids": ["sub_tenant_4567", "sub_tenant_8901"]
}
Error details on failure, or null on success.
Show child attributes
Show child attributes
Example:
null
Show child attributes
Show child attributes
Example:
{
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234",
"warnings": [
{
"code": "acl_ignored_by_connector_enforcement",
"message": "This connector enforces ACL, so the request's acl was ignored."
}
]
}
Whether the request succeeded.
Example:
true
Was this page helpful?