Connect to Square Data in DBeaver





Square JDBC Driver

Square のTransaction、Items、Subscriptions データをJava ベースのアプリケーションから手軽に連携。



Manage Square data with visual tools in DBeaver like the query browser.


The CData JDBC Driver for Square implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Square data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Square Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.square.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the SquareDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.square.SquareDriver.
  6. Add jdbc:square: in the URL Template field.

Create a Connection to Square Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to Square.

    Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

    追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

    Below is a typical connection string:


Query Square Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.