Ready to get started?

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

 Download Now

Learn more:

DocuSign Icon DocuSign JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with DocuSign data including Accounts, Envelopes, Folders, and more!

How to connect to DocuSign Data with Squirrel SQL client



Connect to DocuSign data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for DocuSign enables you to execute queries to DocuSign data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for DocuSign data and execute queries.

Add the JDBC Driver for DocuSign

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for DocuSign.
  4. In the Example URL box, enter jdbc:docusign:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.docusign.DocuSignDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData DocuSign Source.
    • Driver: Select the CData JDBC Driver for DocuSign.
    • URL: Enter jdbc:docusign:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    To connect to DocuSign, set the following connection properties:

    • UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
    • AccountId (optional): set it in the connection string if you have access to multiple Account Ids

    Authenticating to DocuSign

    DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information.

    Below is a typical connection string:

    jdbc:docusign:OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; CallbackURL=http://localhost:33333; InitiateOAuth=GETANDREFRESH
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query DocuSign Data

After the metadata has loaded, a new tab for the DocuSign data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT DocumentId, DocumentName FROM Documents WHERE DocumentName = 'TPSReport'