Deploying a Custom Connector

JDBC is one of the most widely supported Java APIs for connecting to a variety of relational databases. With Sisense's custom connector, you can leverage JDBC drivers to connect to additional data sources.
For a complete list of supported connectors, see Introduction to Data Sources.

To create a custom connector:

  1. Click the Admin tab.

  2. From the Server & Hardware menu, click System Management.

  3. In the System Management pane, click Configuration.

  4. In the System Configuration page, scroll to the bottom and click Manage Connectors.

  5. In the left pane menu, click +JDBC Connector. The Create JDBC Connector page appears.

  6. Populate the mandatory parameters:

    • Connector ID - Enter the ID of the connector.

    • Display Name - Enter the display name that identifies the connector in the Data Designer.

    • Upload jar file - Upload the relevant JDBC driver JAR file for the location that you want to connect to (see Connecting to Custom Connectors with JDBC Drivers.)

    • Class name - Enter the name of the main class from the driver, taken from the driver provider. The connector uses this name to connect to the driver.

  7. If necessary, open the Advanced Configuration drop-down and populate the optional parameters:

    • Enable custom query (default: true) - Enable or disable the use of a custom query. When enabled, the data modeler can use a custom import query for the connection.

    • Fetch relations - Allows using and adding relationships between tables in the data model.

    • Upload a connector icon - Upload the SVG file with the icon to display for this connector in the Connections list. The name of the file must be icon.svg.

    • Node color - Select a color, in Hex format only, to identify the connector in the Data Model. It is recommended to use the color schema of the data source.

    • Parameters delimiter - The delimiter that separates connection string parameters.

    • SQL query delimiter - The delimiter that separates SQL statements. It is used for custom import queries.

    • Default connection string - Used when creating the specific connection in the data model. Use parameters as instructed by the driver’s provider.

    • Connection string parameters - The connection string parameters that are added to all connections.

    • Connection properties - Additional properties for every connection created by this connector.

    • Connection set functions - Supported functions: autoCommit, readOnly, transactionIsolation.

    • Statement set functions - The JDBC function called after every connection is established.

    • Enable connector for Live - Enable this for live JDBC usage. To enable this connector for live models, you must provide a dialect file.

      • Select a dialect from a supported Provider - Select a dialect from the relevant provider (for the list of providers, see Analytical Engine Overview). The selection determines the syntax of the generated SQL query.

      • Upload dialect - Upload your own dialect. Upload a manual Java class to resolve SQL dialect issues.

  8. Click Create.

Creating a Connection String

With JDBC, a database is represented by a connection string, or URL, that defines its location and additional properties.

The connection string required to connect to a JDBC data source varies according to the requirements of that particular provider. You should check the provider's documentation for details regarding their requirements.
For example, a connection string to a Postgres data source has the following form:

jdbc:postgresql://host:port/database

For Postgres, your connection string should include the following:

  • Host: The host name of the server. Defaults to localhost. To specify an IPv6 address, enclose the host parameter with square brackets, for example:
    jdbc:postgresql://[::1]:5740/accounting
  • Port: The port number the server is listening on. Defaults to the PostgreSQL™ standard port number (5432).
  • Database: The database name.

See Postgres JDBC documentation for more information.

JDBC Authentication

If you are using any browser-based authentication, for example, OAuth, while connecting to your data source with a custom connector, you need to update the JDBC configuration file. For information, click Configuring a Custom Connector to Use OAuth.

Accumulate Builds for Custom Connectors

By default, the data that comes from your JDBC data sources is not accumulated at the time of the build. To enable data accumulation by integer and date in tables originating from JDBC data sources, click Enabling Accumulative Build for Connector.