Skip to main content
GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
schemaString
cURL
curl --request GET \
  --url https://api.example.com/v1/instances/{instance}/databases/{database}/schemaString
{
  "schemaString": "<string>"
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

Query Parameters

​
type
enum<string>
Available options:
OBJECT_TYPE_UNSPECIFIED,
DATABASE,
SCHEMA,
TABLE,
VIEW,
MATERIALIZED_VIEW,
FUNCTION,
PROCEDURE,
SEQUENCE
​
schema
string

It's empty for DATABASE.

​
object
string

It's empty for DATABASE and SCHEMA.

​
metadata.name
string

The database metadata name.

Format: instances/{instance}/databases/{database}/metadata

​
metadata.characterSet
string

The character_set is the character set of a database.

​
metadata.collation
string

The collation is the collation of a database.

​
metadata.owner
string

The owner of the database.

​
metadata.searchPath
string

The search_path is the search path of a PostgreSQL database.

Response

OK

​
schemaString
string