Database Catalog

View as Markdown

Get a Database CatalogGET /api/2.0/database/catalogs/{name}Create a Database CatalogPOST /api/2.0/database/catalogsDelete a Database CatalogDELETE /api/2.0/database/catalogs/{name}

DatabaseCatalog object

namestringPublic Preview

The name of the catalog in UC.

database_instance_namestringPublic Preview

The name of the DatabaseInstance housing the database.

database_namestringPublic Preview

The name of the database (in an instance) associated with the catalog.

uidstringPublic PreviewOutput only

create_database_if_not_existsbooleanPublic PreviewInput only

View as Markdown

The DatabaseCatalog object

{
  "name": "string",
  "database_instance_name": "string",
  "database_name": "string",
  "uid": "string",
  "create_database_if_not_exists": true
}

Get a Database Catalog Public Preview

GET /api/2.0/database/catalogs/{name}

Get a Database Catalog.

API scopes: postgres

Parameters

namestringRequiredpath

Response

Returns the DatabaseCatalog object.

View as Markdown

Response

{
  "name": "string",
  "database_instance_name": "string",
  "database_name": "string",
  "uid": "string"
}

Create a Database Catalog Public Preview

POST /api/2.0/database/catalogs

Create a Database Catalog.

API scopes: postgres

Request body

catalogobjectRequired

Show child attributesHide child attributes

namestringRequired

The name of the catalog in UC.

database_instance_namestringRequired

The name of the DatabaseInstance housing the database.

database_namestringRequired

The name of the database (in an instance) associated with the catalog.

create_database_if_not_existsbooleanInput only

Response

Returns the DatabaseCatalog object.

View as Markdown

Request

{
  "catalog": {
    "name": "string",
    "database_instance_name": "string",
    "database_name": "string",
    "create_database_if_not_exists": true
  }
}

Response

{
  "name": "string",
  "database_instance_name": "string",
  "database_name": "string",
  "uid": "string"
}

Delete a Database Catalog Public Preview

DELETE /api/2.0/database/catalogs/{name}

Delete a Database Catalog.

API scopes: postgres

Parameters

namestringRequiredpath

View as Markdown

Response

{}