Custom Schemas

Version 22.0.8486


Custom Schemas

Version 22.0.8486


Custom schemas are personalized endpoints which define inputs and describe the output formats of specific data objects. Custom schemas are required by some connections to return specific reports or result sets. For example, a reporting API may dynamically return different fields depending on the input parameters specified for the report. In those cases, CData Connect supports operations that allow you to easily create and manage your custom schemas.

Note: Not all connections support custom schemas. If the Custom Schema tab does not appear in a connection view, that connection does not support custom schemas.

Create a Custom Schema

To create a new custom schema for a connection that supports this functionality, follow these steps:

  1. Open the connection.
  2. Select the Custom Schema tab in the connection menu.
  3. Click Create New Custom Schema.
  4. Select the custom schema type and fill out the requested information. The information varies between connections and schema types.
  5. Click Add Schema to generate the schema in your connection.

Access Data from a Custom Schema

Once you have added your custom schema, it is available as a custom view in the corresponding connection. For example, after creating the Custom Schema my_custom_schema in the connection My_Connection1, you can access the newly exposed data with the following SELECT query:

SELECT * FROM My_Connection1.my_custom_schema