Metadata Tables

This operation returns information about available tables.

Request Format

GET /tables

Query String Parameters

Parameter	Description	Notes
catalogName	Restricts results to the specified catalog.	Optional
schemaName	Restricts results to the specified schema.	Optional
tableName	Restricts results to the specified table.	Optional
tableType	Restricts results to the specified table type(s).	Optional; separate multiple values with commas

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.
TABLE_NAME	String	The table name.
TABLE_TYPE	String	The table type.
REMARKS	String; Nullable	A description of the table.

Example Response

Request

GET https://cloud.cdata.com/api/tables?tableName=Account

Response

{
    "results": [
        {
            "schema": [
                {
                    "ordinal": 0,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_tables",
                    "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_tables",
                    "columnName": "TABLE_SCHEMA",
                    "columnLabel": "TABLE_SCHEMA",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 255,
                    "precision": 255,
                    "scale": 0,
                    "nullable": true
                },
                {
                    "ordinal": 2,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_tables",
                    "columnName": "TABLE_NAME",
                    "columnLabel": "TABLE_NAME",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 512,
                    "precision": 512,
                    "scale": 0,
                    "nullable": true
                },
                {
                    "ordinal": 3,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_tables",
                    "columnName": "TABLE_TYPE",
                    "columnLabel": "TABLE_TYPE",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 512,
                    "precision": 512,
                    "scale": 0,
                    "nullable": true
                },
                {
                    "ordinal": 4,
                    "catalogName": "CData",
                    "schemaName": "QueryFederation",
                    "tableName": "sys_tables",
                    "columnName": "REMARKS",
                    "columnLabel": "REMARKS",
                    "dataType": 5,
                    "dataTypeName": "VARCHAR",
                    "length": 512,
                    "precision": 512,
                    "scale": 0,
                    "nullable": true
                }
            ],
            "rows": [
                [
                    "Salesforce1",
                    "Salesforce",
                    "Account",
                    "TABLE",
                    null
                ]
            ],
            "affectedRows": -1
        }
    ]
}