ODBC Driver for Apache CouchDB

Build 25.0.9434

Linux DSN の構成

このセクションでは、以下のいくつかのLinux ディストリビューションでODBC 接続をセットアップしDSN を設定する方法を説明します:Ubuntu のようなDebian ベースのシステム、Red Hat Enterprise Linux (RHEL)、およびFedora のようなRed Hat Linux プラットフォーム。

Linux の最小バージョン

Red Hat ベースおよびDebian ベースシステムでサポートされる最小バージョンは以下のとおりです。

OSMin. Version
Ubuntu18.04
Debian10
RHEL8
Fedora28
SUSE15

ドライバー依存関係のインストール

必要な依存関係をインストールするには、次のコマンドをルートとしてまたはsudo で実行します。

  • Debian/Ubuntu:
    apt-get install libc6 libstdc++6 zlib1g libgcc1
  • RHEL/Fedora:
    yum install glibc libstdc++ zlib libgcc

ドライバーのインストール

標準のパッケージ管理システムを使用してドライバーをインストールできます。

Ubuntu のようなDebian ベースのシステムでは、次のコマンドをroot またはsudo で実行します。

dpkg -i /path/to/driver/setup/ApacheCouchDBODBCDriverforUnix.deb 

RPM パッケージ形式をサポートするシステムでは、次のコマンドをroot またはsudo で実行します。

rpm -ivh /path/to/driver/ApacheCouchDBODBCDriverforUnix.rpm 

ドライバーのライセンス

次のコマンドを実行して本製品 のライセンスを取得します。評価版をアクティベートするには、<key> の入力を省略してください。

cd /opt/cdata/cdata-odbc-driver-for-apachecouchdb/bin/
sudo ./install-license.sh <key>

ドライバーマネージャー経由の接続

ドライバーマネージャーはドライバーをロードし、アプリケーションからドライバーに関数呼び出しを渡します。本製品 をドライバーマネージャーに登録して、ドライバーマネージャーのコンフィギュレーションファイルにDSN を定義する必要があります。

本製品 のインストールでは、本製品 をunixODBC ドライバーマネージャーに登録し、システムDSN を作成します。UnixODBC ドライバーマネージャーは、Python やその他多くのアプリケーションから使用できます。アプリケーションに別のドライバーマネージャーが組み込まれている可能性があります。

DSN の作成

unixODBC をインストールしてDSN を設定するには、unixODBC の使用 を参照してください。OBIEE、Informatica、およびSAS に接続するDSN を作成するには、DataDirect ドライバーマネージャーの使用 を参照してください。

Apache CouchDB への接続

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

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

Apache CouchDB への認証

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

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

Basic 認証

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

  • AuthSchemeBasic
  • 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 本製品 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 本製品.

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 本製品 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 本製品 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 本製品 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;

匿名認証

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

  • AuthSchemeNone
  • PublicDatabases:テーブルとしてリストする公開データベースのカンマ区切りリスト。

ドライバーエンコーディングの設定

ODBC ドライバーは、ODBC ドライバーマネージャーで使用するエンコーディングを指定する必要があります。デフォルトでは、Unix 用のCData ODBC ドライバーはunixODBC と互換性のあるUTF-16 を使用するように設定されていますが、他のドライバーマネージャーでは代替エンコーディングが必要な場合があります。

また、ANSI ODBC API を使用するアプリケーションからODBC ドライバーを使用している場合は、ANSI コードページを設定する必要があります。例えば、ANSI アプリケーションに日本語の文字をインポートするには、設定ファイル'/opt/cdata/cdata-odbc-driver-for-apachecouchdb/lib/cdata.odbc.apachecouchdb.ini' でコードページを指定できます。

[Driver]
AnsiCodePage = 932

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434