Manage Box Data in DBArtisan as a JDBC Source

Ready to get started?

Download a free trial of the Box Driver to get started:

 Download Now

Learn more:

Box Icon Box JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Box cloud storage data including Files, Folders, Tasks, Groups, and more!



Use wizards in DBArtisan to create a JDBC data source for Box.

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

Integrate Box Data into DBArtisan Projects

Follow the steps below to register Box 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.

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

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.box.jar

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

    Below is a typical connection string:

    jdbc:box:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
  6. Finish the wizard to connect to Box data. Box entities are displayed in the Datasource Explorer.

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