Connect to JSON Services in DBeaver

The CData JDBC Driver for JSON 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 JSON services with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for JSON Services

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.json.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the JSONDriver 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.json.JSONDriver.
6. Add jdbc:json: in the URL Template field.

Create a Connection to JSON Services

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 JSON.

   データソースへの認証については、ヘルプドキュメントの「はじめに」を参照してください。本製品は、JSON API を双方向データベーステーブルとして、JSON ファイルを読み取り専用ビュー（ローカル ファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー）としてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。詳細はヘルプドキュメントの「はじめに」を参照してください。

   URI を設定して認証値を入力したら、DataModel を設定してデータ表現とデータ構造をより厳密に一致させます。

   DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、次の基本設定を切り替えます。

   • Document（デフォルト）：JSON データのトップレベルのドキュメントビューをモデル化します。本製品 は、ネストされたオブジェクト配列を集約されたJSON オブジェクトとして返します。
   • FlattenedDocuments：ネストされた配列オブジェクトと親オブジェクトを、単一テーブルに暗黙的に結合します。
   • Relational：階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれています。

   リレーショナル表現の設定についての詳細は、ヘルプドキュメントの「JSON データのモデリング」を参照してください。また、以下の例で使用されているサンプルデータも確認できます。データには人や所有する車、それらの車に行われたさまざまなメンテナンスサービスのエントリが含まれています。

   Amazon S3 内のJSON への接続

   URI をバケット内のJSON ドキュメントに設定します。さらに、次のプロパティを設定して認証します。

   • AWSAccessKey：AWS アクセスキー（username）に設定。
   • AWSSecretKey：AWS シークレットキーに設定。

   Box 内のJSON への接続

   URI をJSON ファイルへのパスに設定します。Box へ認証するには、OAuth 認証標準を使います。 認証方法については、Box への接続 を参照してください。

   Dropbox 内のJSON への接続

   URI をJSON ファイルへのパスに設定します。Dropbox へ認証するには、OAuth 認証標準を使います。 認証方法については、Dropbox への接続 を参照してください。ユーザーアカウントまたはサービスアカウントで認証できます。ユーザーアカウントフローでは、以下の接続文字列で示すように、ユーザー資格情報の接続プロパティを設定する必要はありません。 URI=dropbox://folder1/file.json; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;

   SharePoint Online SOAP 内のJSON への接続

   URI をJSON ファイルを含むドキュメントライブラリに設定します。認証するには、User、Password、およびStorageBaseURL を設定します。

   SharePoint Online REST 内のJSON への接続

   URI をJSON ファイルを含むドキュメントライブラリに設定します。StorageBaseURL は任意です。指定しない場合、ドライバーはルートドライブで動作します。 認証するには、OAuth 認証標準を使用します。

   FTP 内のJSON への接続

   URI をJSON ファイルへのパスが付いたサーバーのアドレスに設定します。認証するには、User およびPassword を設定します。

   Google Drive 内のJSON への接続

   デスクトップアプリケーションからのGoogle への認証には、InitiateOAuth をGETANDREFRESH に設定して、接続してください。詳細はドキュメントの「Google Drive への接続」を参照してください。

   Below is a typical connection string:

   jdbc:json:URI=C:/people.json;DataModel=Relational;

Query JSON Services

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.