client.databases.list_schemas

A method of the Databases endpoint.

list_schemas(id: int, *, name: str = None, credential_id: int = None) ListResponse

List schemas in this database

API URL: GET /databases/{id}/schemas

import civis
client = civis.APIClient()
response = client.databases.list_schemas(...)
Parameters:
idint

The ID of the database.

namestr, optional

If specified, will be used to filter the schemas returned.Substring matching is supported (e.g., “name=schema” will return both “schema1” and “schema2”). Does not apply to BigQuery databases.

credential_idint, optional

If provided, schemas will be filtered based on the given credential.

Returns:
civis.ListResponse
  • schemastr

    The name of a schema.