The Schema API is an extension of the Data Sources API. The Schema API can be used to retrieve the information needed to configure a schema for OData connectivity.

Important: For backend data stores that support schemas, Hybrid Data Pipeline provides an option to restrict the metadata exposed by the service to a single schema. When a schema has been specified for the Metadata Exposed Schemas option in the Web UI (or the HDPMetadataExposedSchemas property via the Data Sources API), the Schema API can only be used to query the specified schema.

The following table lists the operations that can be performed and their associated URLs. A detailed description for these operations follows.

Task Request URL
Retrieve a list of available schemas GET <myserver>:<port>/api/mgmt/datasources/{datasourceid}/schemas
Retrieve table names GET <myserver>:<port>/api/mgmt/datasources/{datasourceid}/schemas/ <schemaName>/tables
Retrieve table information GET <myserver>:<port>/api/mgmt/datasources/{datasourceid}/schemas/ <schemaName>/tables/<tableName>
Retrieve column information for a table GET <myserver>:<port>/api/mgmt/datasources/{datasourceid}/schemas/ <schemaName>/tables/tableName/columns
Retrieve primary keys for a table GET <myserver>:<port>/api/mgmt/datasources/{datasourceid}/schemas/ <schemaName>/tables/<tableName>/primarykeys