Manage Square Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Square seamlessly integrates Square data into database management tools like DBArtisan by enabling you to access Square data as a database. This article shows how to create a JDBC source for Square in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Square Data into DBArtisan Projects

Follow the steps below to register Square data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

   Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.square.jar

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

   Below is a typical connection string:

   jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH
6. Finish the wizard to connect to Square data. Square entities are displayed in the Datasource Explorer.

You can now work with Square data as you work with any other database. See the driver help documentation for more information on the queries supported by the Square API.