Zoomdata Version

Implementing a Connection to Zoomdata


When an administrator adds a connector to Zoomdata, Zoomdata queries the connector to describe itself. This description tells Zoomdata which connection type it serves, as well as some metadata about the data store to which it can connect. The connector uses a method called DescribeServerResponse to describe itself to Zoomdata.

Your connector server must include in its response, at the very least, a field called storageType. It is a string that uniquely identifies the data store with which the connector interfaces.

Currently there is no collision detection for names within Zoomdata, so storageType should avoid existing names such as “MYSQL”. Using storageType names already present in Zoomdata may lead to unpredictable results. Use a prefix or suffix to disambiguate common data store names.

The other data store information is optional, but can tell Zoomdata the minimum and maximum supported versions of the data store, as well as provide an icon for the Zoomdata UI to show with the connection type.

The best practice for icons is to provide a valid SVG file converted to binary, even though the API still provides legacy support for multiple image types.

Although the API supports multiple types for legacy, the current implementation expects the icon to be a valid SVG file converted to binary. For our example connector to the hypothetical MyDB data store, the connector might return the following description.

Field name Value Notes
storageType MYDB Because we know that there will be no other connector server for MyDBs, we can just use MYDB as the storageType.
maxSupportedVersion 0.9.2
minSupportedVersion 0.8 In the example, the connector works with MyDB versions as old as version 0.8.x.
Icon (binary SVG file) If you do not provide an icon, Zoomdata will use a default image.

We also provide the following connection parameters.

Parameter Name Type Required Notes
JDBC_URL ParameterString true
USER_NAME ParameterString false Usernames and passwords are only required if the data store requires them.
PASSWORD ParameterPassword false Password parameter values are never shown in plain text.

Each connection parameter can also have a description that explains its purpose to a user creating a data source. Give a brief, informative description when possible.

Although a DescribeServerResponse can return more than one ServerDescription, the best practice is for a single connector to return a single ServerDescription.

Back to top