Skip to main content
GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
metadata
{
  "labels": {},
  "lastSyncTime": "2023-11-07T05:31:56Z",
  "backupAvailable": true,
  "datashare": true,
  "drifted": true,
  "version": "<string>"
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

Query Parameters

​
filter
string

Filter is used to filter databases returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filter:

  • schema: the schema name, support "==" operator.
  • table: the table name, support "==" and ".matches()" operator.

For example: schema == "schema-a" table == "table-a" table.matches("table-a") schema == "schema-a" && table.matches("sample") The filter used to search table with wildcard "sample" in the schema "schemas/schema-a". The column masking level will only be returned when a table filter is used.

​
limit
integer

Limit the response size of returned table metadata per schema. For example, if the database has 3 schemas, and each schema has 100 tables, if limit is 20, then only 20 tables will be returned for each schema, total 60 tables. Default 0, means no limit.

Response

OK

DatabaseMetadata is the metadata for databases.

​
labels
object
​
lastSyncTime
string<date-time>
​
backupAvailable
boolean
​
datashare
boolean
​
drifted
boolean

The schema is drifted from the source of truth.

​
version
string

The version of database schema.