Connectors → Custom CData

About the Custom CData Connector

With the Custom CData Connector, you can use a CDATA JDBC driver to ingest data from a SQL database or data warehouse.

Note

The Custom CData connector requires a JAR file from Incorta. Incorta may have not verified or tested the Custom CData connector. The JAR download is only available from Incorta Support and may require additional licensing. The Custom CData connector exposes various properties of the related CDATA JDBC driver for an external data source. You can review the CDATA JDBC driver documentation at Drivers & Data Connectors.

The Custom CDATA connector requires the deployment of a JAR file to the Incorta Node hosts of the Analytics Service and the Loader Service. A systems administrator with root access to the host can deploy the JAR file. A CMC Administrator can restart the Incorta cluster.

The Custom CData connector supports the following Incorta specific functionality:

Feature Supported
Chunking
Data Agent
Encryption at Ingest
Incremental Load
Load Filter
Multi-Source
OAuth
Performance Optimized
Single-Source
Spark Extraction
Webhook Callbacks

Deploy the JAR file

The Custom CData Connector requires a JAR file for the related JDBC driver. Here is an example for Snowflake:

  • cdata.jdbc.snowflake.jar
Note

For the Driver class name, refer to CData JDBC Driver Documentation

To use the Custom CData connector, a System Administrator with root access will need to copy the JDBC driver JAR file of the database to each Incorta Node in an Incorta cluster. A CMC Administrator will need to restart the Analytics and Loader Services in the cluster.

Here are the steps to copy the JAR file to standalone Incorta cluster:

  • Contact Incorta Support and download the Customer CData connector driver JAR file.
  • Secure copy the cdata.jdbc.xyz.jar file to the host of the Analytics Service, Loader Service, and Cluster Management Console. Here is an example using scp:
INCORTA_NODE_HOST=100.101.102.103
INCORTA_NODE_HOST_PEM_FILE="host_key.pem"
INCORTA_NODE_HOST_USER="incorta"
CUSTOM_JDBC_JAR_FILE="cdata.jdbc.xyz.jar"

cd ~/Downloads
scp -i ~/.ssh/${INCORTA_NODE_HOST_PEM_FILE}  ${CUSTOM_JDBC_JAR_FILE} ${INCORTA_NODE_HOST_USER}@${INCORTA_NODE_HOST}:/tmp/
Note

If the Analytics Service, Loader Service, and Cluster Management Console all run on the same host, you only need to secure copy the file once.

  • Secure shell into the host
ssh -i ~/.ssh/${INCORTA_NODE_HOST_PEM_FILE} ${INCORTA_NODE_HOST_USER}@${INCORTA_NODE_HOST}
  • For the Analytics Service and Loader Service hosts, copy the JAR file to the /IncortaNode/extensions/connectors/cdata directory.
INCORTA_INSTALLATION_PATH=/home/incorta/IncortaAnalytics
CUSTOM_JDBC_JAR_FILE="cdata.jdbc.xyz.jar"
cp /tmp/${CUSTOM_JDBC_JAR_FILE} $INCORTA_INSTALLATION_PATH/IncortaNode/extensions/connectors/cdata/${CUSTOM_JDBC_JAR_FILE}
Note

If the Analytics Service and Loader Service both run on the same Incorta Node, the services share the same extensions directory and you need to only copy the file once.

  • For the Cluster Management Console host, copy the JAR file to the /cmc/extensions/connectors/cdata directory.
INCORTA_INSTALLATION_PATH=/home/incorta/IncortaAnalytics
CUSTOM_JDBC_JAR_FILE="cdata.jdbc.xyz.jar"
cp /tmp/${CUSTOM_JDBC_JAR_FILE} $INCORTA_INSTALLATION_PATH/cmc/extensions/connectors/cdata/${CUSTOM_JDBC_JAR_FILE}

Restart the Analytics and Loader Services

Here are the steps to restart the Analytics and Loader Services in an Incorta Cluster from the Cluster Management Console (CMC).

  • As the CMC Administrator, sign in to the CMC.
  • In the Navigation bar, select Clusters.
  • In the cluster list, select a Cluster name.
  • Select the Details tab, if not already selected.
  • In the footer, select Restart.

Steps to connect a database

To connect a database and Incorta, here are the high level steps, tools, and procedures:

Create an external data source

Here are the steps to create a external data source with the Custom CData connector:

  • Sign in to the Incorta Direct Data Platform™.
  • In the Navigation bar, select Data.
  • In the Action bar, select + NewAdd Data Source.
  • In the Choose a Data Source dialog, in Custom, select Custom CData.
  • In the New Data Source dialog, specify the applicable connector properties.
  • To test, select Test Connection.
  • Select Ok to save your changes.

Custom CData connector properties

Here are the properties for the Custom CData connector:

Property Control Description
Data Source Name text box Enter the name of the data source
Driver Class text box Enter the driver class for the database. For example, the Snowflake driver name is
cdata.jdbc.xyz.XYZDriver. To find the drive name, refer to the “Establishing a Connection” article in the CData JDBC Driver for XYZ documentation.
Connection String text box Enter the jdbc connection string.
Show Catalogs toggle Enable to list any data catalogs
Show Schemas toggle Enable to list any data schema
Enable OAuth toggle Enable to allow OAuth authentication
OAuth Client Id text box The client ID assigned when you register your application with an OAuth authorization server.
OAuth Client Secret text box The client secret assigned when you register your application with an OAuth authorization server.

Create a physical schema with the Schema Designer

Here are the steps to create a custom SQL physical schema using the Schema Designer:

  • Sign in to the Incorta Direct Data Platform™.
  • In the Navigation bar, select Schema.
  • In the Action bar, select + New → Create Schema.
  • In Name, specify the physical schema name, and select Save.
  • In Start adding tables to your schema, select SQL Database.
  • In the Data Source dialog, specify the Custom CData table data source properties.
  • Select Add.
  • In the Table Editor, in the Table Summary section, enter the table name.
  • To save your changes, select Done in the Action bar.

Custom CData table data source properties

For a physical schema table in Incorta, you can define the following Custom CData specific data source properties as follows:

Property Control Description
Type drop down list Default is SQL Database
Data Source drop down list Select the Custom CData external data source
Incremental toggle Enable the incremental load configuration for the physical schema table
Fetch Size text box Used for performance improvement, fetch size defines the number of records that will be retrieved from the database in each batch until all records are retrieved. The default is 5000.
Query text box Enter the SQL query to retrieve data from the Custom CData database table. This is a SELECT statement for a SQL query. You must specify a FROM clause. You need to know the Table Name. A file name will serve as a table name.
Update Query text box Enable Incremental to configure this property. Enter the SQL query to retrieve data updates from the Custom CData database table.
Incremental Field Type drop down list Enable Incremental to configure this property. Select the format of the table date column:
  • Timestamp
  • Unix Epoch (seconds)
  • Unix Epoch (milliseconds)
  • Chunking Method drop down list Chunking methods allow for parallel extraction of large tables. The default is No Chunking. There are two chunking methods:
  • By Size of Chunking (Single Table)
  • By Date/Timestamp
  • Chunk Size text box Select By Size of Chunking for the Chunking Method to set this property. Enter the number of records to extract in each chunk in relation to the Fetch Size. The default is 3 times the Fetch Size.
    Order Column drop down list Select By Size of Chunking for the Chunking Method to set this property. Select a column in the source table you want to order by before chunking. It’s typically an ID column and it must be numeric.
    Upper Bound for Order Column text box Optional. Enter the maximum value for the order column.
    Lower Bound for Order Column text box Optional. Enter the minimum value for the order column.
    Order Column [Date/Timestamp] drop down list Select By Date/Timestamp for the Chunking Method to set this property. Select a column in the source table you want to order by before chunking. It should be a Date/Timestamp column.
    Chunk Period drop down list Select the chunk period that will be used in dividing chunks:
  • Daily
  • Weekly (default)
  • Monthly
  • Yearly
  • Custom
  • Number of days text box Select Custom for the Chunk Period to set this property. Enter the chunking period in days
    Callback toggle Enable this option to call back on the source data set
    Callback URL text box Enable Callback to configure this property. Specify the URL.

    View the physical schema diagram with the Schema Diagram Viewer

    Here are the steps to view the physical schema diagram using the Schema Diagram Viewer:

    • Sign in to the Incorta Direct Data Platform™.
    • In the Navigation bar, select Schema.
    • In the list of schemas, select the Custom CData schema.
    • In the Schema Designer, in the Action bar, select Diagram.

    Load the physical schema

    Here are the steps to perform a Full Load of the Custom CData physical schema using the Schema Designer:

    • Sign in to the Incorta Direct Data Platform™.
    • In the Navigation bar, select Schema.
    • In the list of schemas, select the Custom CData schema.
    • In the Schema Designer, in the Action bar, select Load → Load Now → Full.
    • To review the load status, in Last Load Status, select the date.

    Explore the physical schema

    With the full load of the Custom CData physical schema complete, you can use the Analyzer to explore the schema, create your first insight, and save the insight to a new dashboard.

    To open the Analyzer from the schema, follow these steps:

    • In the Navigation bar, select Schema.
    • In the Schema Manager, in the List view, select the Custom CData schema.
    • In the Schema Designer, in the Action bar, select Explore Data.

    © Incorta, Inc. All Rights Reserved.