接続の設定

コネクタのインストール後、Apache CouchDB 内のデータのデータソースに接続して作成できます。

データソースの設定

データに接続するには、次の手順を実行してください：

接続 | To a Server で詳細をクリックします。
Apache CouchDB by CData というデータソースを選択します。
接続に必要な情報を入力します。
サインインをクリックします。
必要に応じて、データベースおよびスキーマを選択して利用可能なテーブルとビューを確認できます。

Connection Builder の使用

connector は、代表的な接続プロパティをTableau 内で直接利用できるようにします。しかし、より高度な設定が必要な場合や接続に関するトラブルシューティングが必要な場合には、使いにくいことがあります。 connector には、Tableau の外で接続を作成してテストできる、独立したConnection Builder が付属しています。

Connection Builder にアクセスする方法は2つあります。

Windows では、スタートメニューのCData Tableau Connector for Apache CouchDB フォルダの下にあるConnection Builder というショートカットを使用します。
また、ドライバーのインストールディレクトリに移動し、lib ディレクトリで.jar ファイルを実行することによってもConnection Builder を開始できます。

Connection Builder では、接続プロパティに値を設定し、接続テストをクリックしてその動作を確認できます。また、クリップボードにコピーボタンを使用して、接続文字列をコピーすることもできます。この接続文字列は、Tableau 内のconnector 接続ウィンドウにあるConnection String オプションに指定できます。

Apache CouchDB への接続

URL 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスでadmin_only_all_dbs オプションを設定し、テーブルをリストするためにconnector が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

Apache CouchDB への認証

Apache CouchDB は3種類の認証をサポートします。

Basic：基本的なユーザー名 / パスワード認証。
JWT：JWT 認証。
None：パブリックなデータベースへの匿名アクセス。

Basic 認証

データに接続するには以下を設定します。

AuthScheme：Basic。
User 認証に使用されるApache CouchDB ユーザーアカウント。
Password 認証するユーザーに関連付けられたApache CouchDB パスワード。

JWT Authentication

Set AuthScheme to JWT.

You can either automatically generate (and, if applicable, refresh) a JWT or manually generate one:

Automatic Token Generation

Configure the connector to automatically generate the tokens:

Required

JWTSubject: The name of the user to assign to the JWT.
JWTAlgorithm: The algorithm to use for the JWT signature.
JWTKeyType: The encryption key's type.
JWTKey: The encryption key used to sign the JWT generated by the connector.

Optional

JWTIssuer: The issuer of the JWT.
JWTExpiration: The duration for which the JWT remains valid, in seconds.
JWTHeaders: A collection of extra headers to include in the JWT header.
JWTClaims: A collection of extra claims to include in the JWT payload.
CredentialsLocation: The filepath of the settings file containing the JWT. If a settings file does not exist in this location, the connector creates a new settings file when it retrieves a JWT.

Manual Token Generation

You can generate the tokens yourself manually and pass them to the connector by using the JWTToken connection property.

Generating the Key Pair

When using asymmetric algorithms to sign the tokens, you must generate a private/public key pair. For that, a cryptographic library like OpenSSL can be used. For example:

# generate private key
openssl genrsa --out private_rsa256.pem 2048

# extract public key
openssl rsa -in private_rsa256.pem -pubout > public_rsa256.pem

JWT Configurations

Refer to CouchDB JWT Authentication Documentation for the following.

The alg and sub are required claims and will always be validated by the Apache CouchDB instance. Other required claims can be configured in the server (see required_claims). In that case, you must use JWTHeaders and JWTClaims so that the connector can include those additional claims when generating the JWT.

You can use roles_claim_name or the roles_claim_path options to assign roles to the JWTs.

An example configuration of the server and corresponding sample connection string are shown below:

Example Server Configuration

[chttpd]
...
authentication_handlers = {chttpd_auth, jwt_authentication_handler}, {chttpd_auth, cookie_authentication_handler}, {chttpd_auth, default_authentication_handler}
admin_only_all_dbs = false
...

[jwt_auth]
...
required_claims = exp
roles_claim_path = my.nested._couchdb\.roles
rsa:rsa_256 = -----BEGIN PUBLIC KEY-----\nYOUR_PUBLIC_KEY\n-----END PUBLIC KEY-----\n
...

Example Connection String

Url=http://localhost:5984;
JWTSubject=JWT User 1;
JWTAlgorithm=RS256;
JWTKeyType=PEMKEY_FILE;
JWTKey=PATH_TO_FOLDER\private_rsa256.pem;
JWTHeaders=kid : rsa_256 | Custom Header 1 : Test 1;
JWTClaims= my : eyJuZXN0ZWQiOnsiX2NvdWNoZGIucm9sZXMiOlsidXNlcjIiXX19 | Custom Claim 1 : Test 1;

匿名認証