databases_list_schemas {civis}

List schemas in this database

Description

List schemas in this database

Usage

databases_list_schemas(id, name = NULL, credential_id = NULL)

Arguments

id

integer required. The ID of the database.

name

string 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").

credential_id

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

Value

An array containing the following fields:

schema

string, The name of a schema.