Connect to Templated Data in RazorSQL

The CData JDBC Driver for Templated enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Templated using wizards in RazorSQL.

Create a JDBC Data Source for Templated Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     To authenticate to Templated, you will need an API key. You can obtain your API key from the Templated Dashboard under the API Key tab (app.templated.io > Dashboard > API Key).

     Using API Key Authentication

     After setting the following connection properties, you are ready to connect:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Templated API key.

     Example connection string:

     Profile=C:\profiles\Templated.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
     

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Templated JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.api.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     

     A typical JDBC URL is the following:

     jdbc:api:Profile=C:\profiles\Templated.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';

Query Templated Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.