Metadata Schemas

This operation returns information about available schemas.

Request Format

GET /schemas

Query String Parameters

Parameter	Description	Notes
catalogName	Restricts results to the specified catalog.	Optional
schemaName	Restricts results to the specified schema.	Optional

Response Format

This operation returns the following columns in our standard JSON result object.

Column	Data Type	Description
TABLE_CATALOG	String	The catalog name.
TABLE_SCHEMA	String	The schema name.

Example

Request

GET https://cloud.cdata.com/api/schemas

Response

{
    "results": [
        {
            "schema": [
                {
                    "ordinal": 0,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_schemas",
                    "columnName": "TABLE_CATALOG",
                    "columnLabel": "TABLE_CATALOG",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 255,
                    "precision": 255,
                    "scale": 0,
                    "nullable": true
                },
                {
                    "ordinal": 1,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_schemas",
                    "columnName": "TABLE_SCHEMA",
                    "columnLabel": "TABLE_SCHEMA",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 255,
                    "precision": 255,
                    "scale": 0,
                    "nullable": true
                }
            ],
            "rows": [
                [
                    "Salesforce1",
                    "Salesforce"
                ]
            ],
            "affectedRows": -1
        }
    ]
}