Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、PostgreSQL への接続を作成します。PostgreSQL アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからPostgreSQL コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

PostgreSQL への接続

PostgreSQL に接続するには、通常次の接続プロパティが必要です。

• Server：PostgreSQL データベースをホスティングしているサーバーのホスト名またはIP アドレス。
• User：PostgreSQL サーバーに認証する際に使われるユーザー。

また、オプションで以下を設定することもできます。

• Database：PostgreSQL サーバーに接続する場合のデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。
• Port：PostgreSQL データベースをホスティングしているサーバーのポート。5432がデフォルトです。

標準

他のスキームを選択しない限り、Sync App がPostgreSQL サーバーに接続する際に使用するデフォルトの認証メカニズムはパスワードです。

標準認証を使用する場合、PostgreSQL にログイン資格情報で接続するにはAuthScheme をPassword に設定します。

そして、認証するために、認証するユーザに紐づいたPassword を設定します。

pg_hba.conf 認証スキーム

Sync App がサポートするパスワード認証スキームのサブタイプは、PostgreSQL サーバー上のpg_hba.conf ファイルで有効化する必要があります。

PostgreSQL サーバーでの認証の設定について、詳しくはPostgreSQL ドキュメントを参照してください。

MD5

Sync App は、MD5 でパスワードを検証することで認証できます。pg_hba.conf ファイルのauth-method をmd5 に設定し、この認証方法を有効にする必要があります。

SASL

Sync App は、SASL（特にSCRAM-SHA-256）でパスワードを検証することで認証できます。pg_hba.conf ファイルのauth-method をscram-sha-256 に設定し、この認証方法を有効にする必要があります。

Azure

Microsoft Azure でPostgreSQL への接続に利用できる方法は以下のとおりです。

• Azure Active Directory OAuth
• Azure Active Directory Password
• Azure Active Directory MSI

Azure AD

Azure AD は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでPostgreSQL との通信を要求します。下記で説明するとおり、Sync App はさまざまな方法でこれをサポートします。 AuthScheme をAzureAD に設定します。すべてのAzure AD フローは、すでに設定済みであることを前提として書かれています。

デスクトップアプリケーション

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムAzureAD アプリの作成 を参照してください。

認証に関する2つの方法の違いは、カスタムOAuth アプリケーションを使用する場合に、2つの接続プロパティを追加で設定する必要があることだけです。

次の接続プロパティを設定して、接続してください。

• OAuthClientId：（カスタムアプリケーションのみ）アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：（カスタムアプリケーションのみ）アプリケーション設定のクライアントシークレットに設定。
• CallbackURL：アプリケーション設定のリダイレクトURL に設定。

接続すると、Sync App はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

Web アプリケーション

Web アプリケーション経由で接続する場合は、 PostgreSQL にカスタムOAuth アプリを登録する必要があります。カスタムAzureAD アプリの作成 を参照してください。それからSync App を使用してOAuth トークンの値を取得および管理します。 OAuth アクセストークンの取得

認証タイプに応じて以下のいずれかの接続プロパティグループを設定して、OAuthAccessToken を取得します。

1. クライアントシークレットを使用した認証
   • OAuthClientId：アプリ設定のクライアントId に設定。
   • OAuthClientSecret：アプリ設定のクライアントシークレットに設定。
2. 証明書を使用した認証
   • OAuthClientId：アプリ設定のクライアントId に設定。
   • OAuthJWTCert：JWT 証明書ストアを設定。
   • OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

1. GetOAuthAuthorizationUrl ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

   ストアドプロシージャがOAuth エンドポイントのURL を返します。

2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を呼び出し、新しいアクセストークンを取得します。

管理者の同意

管理者の同意とは、Azure Active Directory テナントの管理者が、管理者の同意を必要とするアプリケーションに権限を付与することを指します。 CData Sync App 内の埋め込みアプリには、管理者の同意を必要とするアクセス許可はありません。したがって、この情報はカスタムアプリケーションにのみ適用されます。

管理者の同意の付与

Azure ポータルで新しいAzureAD アプリを作成する場合には、アプリに必要なアクセス許可を指定する必要があります。一部のアクセス許可には、「管理者の同意が必要」と記載されている場合があります。 例えば、すべてのグループのアクセス許可には管理者の同意が必要です。アプリに管理者の同意が必要な場合、いくつかの方法があります。

管理者の同意を付与する最も簡単な方法は、管理者がportal.azure.com にログインして、［アプリの登録］で作成したアプリに移動するだけです。API のアクセス許可で、 同意の付与をクリックして、アプリが作成されたテナントでアクセス権限を持つようにします。

組織に複数のテナントがある場合、または組織外の他のテナントにアプリのアクセス許可を与える必要がある場合、GetAdminConsentURL ストアドプロシージャを使用してAdmin Authorization URL を生成します。GetOAuthAuthorizationUrl とは異なり、このエンドポイントから返される重要な情報はありません。OAuth アプリケーションが正常に認可されると、アクセス権限が付与されたことを示すBoolean 値が返されます。

管理者がOAuth アプリケーションを承認後、認証を続行できます。

クライアントクレデンシャル

クライアント資格情報は、直接ユーザー認証が行われないOAuth のフローを指します。代わりに、資格情報はアプリ自体のためだけに作成されます。 アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。そのため、認証フローが標準とは少し違ったものになります。

クライアントOAuth フロー

クライアントOAuth フローに関連するすべての権限には、管理者の同意が必要です。これは、CData Sync App が埋め込まれたアプリをクライアントOAuth フローでは使用できないことを意味します。クライアント資格情報を使用するには、独自のOAuth アプリの作成が必要になります。 詳しくは、カスタムAzureAD アプリの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には、委任されたアクセス許可とアプリケーションの許可の2つの異なるアクセス許可セットがあります。 クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。インテグレーションに必要なアクセス許可を選択します。

認証タイプに応じていずれかの接続プロパティグループを設定すると、接続できるようになります。

1. クライアントシークレットを使用した認証
   • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
   • AzureTenant：接続するテナントに設定。
   • OAuthGrantType：CLIENT に設定。
   • OAuthClientId：アプリ設定のクライアントId に設定。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
2. 証明書を使用した認証
   • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
   • AzureTenant：接続するテナントに設定。
   • OAuthGrantType：CLIENT に設定。
   • OAuthClientId：アプリ設定のクライアントId に設定。
   • OAuthJWTCert：JWT 証明書ストアを設定。
   • OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Note： Azure PostgreSQL Flexible サーバーはサポート対象外です。Azure PostgreSQL Single Server インスタンスのみサポートされます。

Azure PostgreSQL インスタンスでActive Directory 管理者が設定されていることを確認します（Active Directory 管理者 -> 管理者の設定）。

次に、接続するには以下を設定します。

• User：Azure PostgreSQL サーバーへのアクセス権を付与したAzure Active Directory ユーザーに設定。
• AzureTenant：Azure 上のPostgreSQL への認証に使用するOAuth アプリの概要ページにある、Directory (tenant) ID に設定。
• Server：Azure PostgreSQL インスタンスの概要ページにある、Azure PostgreSQL のサーバー名に設定。
• Database：Azure PostgreSQL インスタンスで接続するデータベースに設定。
• Port：PostgreSQL データベースをホスティングしているサーバーのポート。 5432がデフォルトです。
• OAuthClientId：Azure 上のPostgreSQL への認証に使用するOAuth アプリの概要ページにある、アプリケーション（クライアント）ID に設定。
• OAuthClientSecret：認証するOAuth アプリの証明書とシークレットページで生成されたクライアントシークレットの値に設定。
• CallbackURL：OAuth アプリの作成時に指定したリダイレクトURI に設定。

Azure パスワード

Azure 資格情報を使用して直接接続するには、次の接続プロパティを指定します。

• AuthScheme：AzurePassword に設定。
• User：Azure への接続に使用するユーザーアカウントに設定。
• Password：Azure への接続に使用するパスワードに設定。
• AzureTenant：Azure 上のPostgreSQL への認証に使用するOAuth アプリの概要ページにある、Directory (tenant) ID に設定。
• Server：Azure PostgreSQL インスタンスの概要ページにある、Azure PostgreSQL のサーバー名に設定。
• Database：Azure PostgreSQL インスタンスで接続するデータベースに設定。
• Port：PostgreSQL データベースをホスティングしているサーバーのポート。 5432がデフォルトです。

GCP サービスアカウント

サービスアカウントを使用してPostgreSQL Google SQL Cloud Instance に認証するには、新しいサービスアカウントを作成し、アカウント証明書のコピーを用意する必要があります。サービスアカウントを持っていない場合は、カスタムAzureAD アプリの作成 の手順に従って作成できます。 JSON ファイルの場合は、以下のプロパティを設定します。

• AuthScheme：GCPServiceAccount に設定。
• InitiateOAuth：GETANDREFRESH に設定。
• OAuthJWTCertType：GOOGLEJSON に設定。
• OAuthJWTCert：Google が提供する.json ファイルへのパスに設定。
• OAuthJWTSubject：（オプション）この値は、サービスアカウントがGSuite ドメインの一部で、委任を有効にする場合にのみ設定します。このプロパティの値は、データにアクセスしたいユーザーのE メールアドレスでなければなりません。

PFX ファイルの場合は、代わりに以下のプロパティを設定します。

• AuthScheme：GCPServiceAccount に設定。
• InitiateOAuth：GETANDREFRESH に設定。
• OAuthJWTCertType：PFXFILE に設定。
• OAuthJWTCert：Google が提供する.pfx ファイルへのパスに設定。
• OAuthJWTCertPassword：（オプション）.pfx ファイルのパスワードに設定。Google はPFX 証明書を暗号化するため、ほとんどの場合、これを提供する必要があります。
• OAuthJWTCertSubject：（オプション）複数の証明書を格納するOAuthJWTCertType を使用している場合にのみ設定。Google によって生成されたPFX 証明書には設定しないでください。
• OAuthJWTIssuer：サービスアカウントのE メールアドレスに設定。このアドレスには、通常iam.gserviceaccount.com ドメインが含まれます。
• OAuthJWTSubject：（オプション）この値は、サービスアカウントがGSuite ドメインの一部で、委任を有効にする場合にのみ設定します。このプロパティの値は、データにアクセスしたいユーザーのE メールアドレスでなければなりません。

MSI

Azure VM 上でPostgreSQL を実行している場合は、Managed Service Identity（MSI）の資格情報を利用して接続が可能です。

• AuthScheme：AzureMSI に設定。
• User：マネージドサービスのID にマッピングするAzure PostgreSQL ユーザーに設定。myuser@myservername の形式で入力し、myservername には"postgres.database.azure.com" の部分を含まないようにします。
• Server：Azure PostgreSQL インスタンスの概要ページにある、Azure PostgreSQL のサーバー名に設定。
• Database：Azure PostgreSQL インスタンスで接続するデータベースに設定。
• Port：PostgreSQL データベースをホスティングしているサーバーのポート。 5432がデフォルトです。

MSI 資格情報が認証用に自動的に取得されます。

Amazon Web Services

AWS キーを取得

IAM ユーザーの認証情報を取得するには、以下の手順に従ってください。

1. IAM コンソールにサインインします。
2. ナビゲーションペインで［ユーザー］を選択します。
3. ユーザーのアクセスキーを作成または管理するには、ユーザーを選択してから［セキュリティ認証情報］タブを選択します。

AWS ルートアカウントの認証情報を取得するには、以下の手順に従ってください。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

AWS IAM ロール

多くの場合、認証にはAWS ルートユーザーのダイレクトなセキュリティ認証情報ではなく、IAM ロールを使用することをお勧めします。

AWS ロールとして認証するには、次を設定します。

• AuthScheme：AwsIAMRoles に設定。
• User：aws_iam ロールを付与したAWS ホスティングPostgreSQL ユーザーに設定。このユーザーは、rds-db:connect 権限を含むポリシーを含むロールのAWS ユーザーにマッピングする必要があります。
• AWSRoleARN：認証するIAM ユーザーに付属するロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSAccessKey：認証するIAM ユーザーのアクセスキー。
• AWSSecretKey：認証するIAM ユーザーのシークレットキー。

Note： AWS ルートユーザーのAWSAccessKey およびAWSSecretKey を指定する場合、ロールは使用できません。

Kerberos

Kerberos 認証は、CData Sync App が接続を試行している際にPostgreSQL サーバーで開始されます。この認証方法を有効化するには、PostgreSQL サーバーでKerberos を設定します。PostgreSQL サーバーでのKerberos 認証の設定を完了したら、Sync App からKerberos 認証を行う方法についてKerberos の使用 を参照してください。

このセクションでは、Kerberos でPostgreSQL に認証する方法を説明します。

Kerberos

Kerberos を使用してPostgreSQL に認証するには、次のプロパティを設定します。

• KerberosKDC：Kerberos KDC マシンのホスト名またはIP アドレスに設定。
• KerberosSPN：PostgreSQL のKerberos プリンシパルのサービスとホストに設定。これは、principal value（例：ServiceName/[email protected]）の'@' 記号の前の値（例：ServiceName/MyHost）です。

Kerberos チケットの取得

次のオプションのいずれかを使用して、必要なKerberos チケットを取得できます。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はないことに注意してください。

1. KRB5CCNAME という名前の環境変数が作成されていることを確認してください。
2. KRB5CCNAME 環境変数をクレデンシャルキャッシュファイルを指すパスに設定します（例えばC:\krb_cache\krb5cc_0 または/tmp/krb5cc_0）。このファイルは、MIT Kerberos チケットマネージャーでチケットを生成するときに作成されます。
3. チケットを取得するには、MIT Kerberos チケットマネージャーアプリケーションを開き、Get Ticket をクリックしてプリンシパル名とパスワードを入力し、OK をクリックします。成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。
4. クレデンシャルキャッシュファイルを作成したので、Sync App はキャッシュファイルを使用してPostgreSQL に接続するためのKerberos チケットを取得します。

KRB5CCNAME 環境変数を設定する代わりに、KerberosTicketCache プロパティを使用してファイルパスを直接設定できます。 設定すると、Sync App は指定されたキャッシュファイルを使用してPostgreSQL に接続するためのKerberos チケットを取得します。

Keytab ファイル

KRB5CCNAME 環境変数が設定されていない場合、Keytab ファイルを使用してKerberos チケットを取得できます。これを行うには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

KRB5CCNAME 環境変数およびKerberosKeytabFile プロパティの両方が設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。これを行うには、User およびPassword プロパティを、PostgreSQL での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります（例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合）。

このような環境では、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

CData Sync can use logical replication configured in PostgreSql to incrementally update your destination table. PostgreSQL uses logical decoding to surface the contents of the write-ahead logs, which track data changes in the database, into a readable format. Those changes are read by Sync and pushed into the destination.

Enable Logical Replication for CData Sync

1. Ensure the wal_level is set to logical in in your postgres database. You can set wal_level=logicial in the postgresql.conf file.
2. Create a logical replication slot for Sync.
   

   	SELECT pg_create_logical_replication_slot('cdatasync_replication_slot', 'test_decoding');

   Note: The slot name'cdatasync_replication_slot' is an example and can be susbstituted with any name. You will need this slot name when creating your Job in Sync. It is important that this slot is only used by Sync since changes are consumed when reading from the slot.
3. Ensure that the user connecting from Sync has permision to read the replication slot.
   

   	ALTER ROLE <postgres-user> WITH REPLICATION;

4. In Sync, create a job with a PostgreSQL sources. After selecting the "Change Data Capture" option, enter the replication slot name.

Deletion Behavior

Logical Replication allows Sync to track deleted records when the source table has a primary key. If the source table does not have a primary key, Sync will not be able to retrieve deleted records.

このセクションでは、PostgreSQL Sync App の高度な機能を厳選して説明します。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

クライアントSSL 証明書

PostgreSQL Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

In addition to modeling data directly from PostgreSQL, the CData Sync App also includes a few built in stored procedures designed for assisting with OAuth connections against Azure hosted SQL Server. The stored procedures are listed here.

データ型のマッピング

Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

PostgreSQL	Data スキーマ
abstime	string
aclitem	string
bigint	long
bigserial	long
bit varying	string
bit	string
boolean	bool
box	string
bytea	binary
char	string
character varying	string
character	string
cid	string
cidr	string
circle	string
date	date
daterange	string
double precision	float
gtsvector	string
inet	string
int2vector	string
int4range	string
int8range	string
integer	int
json	string
jsonb	binary
line	string
lseg	string
macaddr8	string
macaddr	string
money	decimal
name	string
numeric	decimal
numrange	string
oid	string
oidvector	string
path	string
pg_dependencies	string
pg_lsn	string
pg_ndistinct	string
pg_node_tree	string
point	string
polygon	string
real	float
refcursor	string
regclass	string
regconfig	string
regdictionary	string
regnamespace	string
regoper	string
regoperator	string
regproc	string
regprocedure	string
regrole	string
regtype	string
reltime	string
serial	int
smallint	int
smallserial	int
smgr	string
text	string
tid	string
time with time zone	string
time without time zone	time
timestamp with time zone	datetime
timestamp without time zone	datetime
tinterval	string
tsquery	string
tsrange	string
tstzrange	string
tsvector	string
txid_snapshot	string
uuid	uuid
xid	string
xml	string

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
AuthScheme	認証で使用されるスキーム。有効な入力値は、Password、AzureAD、AzurePassword、AzureMSI、AwsIAMRoles、AwsEC2Roles、GCPServiceAccount です。
Server	サーバーのホスト名またはIP アドレス。
Database	PostgreSQL データベースの名前。
User	認証で使用されるPostgreSQL ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
Port	PostgreSQL サーバーのポート番号。
UseSSL	このフィールドはSSL が有効化されているかどうかを設定します。
Visibility	Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for the current user.

AWS Authentication

---

プロパティ	説明
AWSAccessKey	AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。
AWSSecretKey	AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。
AWSRoleARN	認証時に使用するロールのAmazon リソースネーム。
AWSExternalId	A unique identifier that might be required when you assume a role in another account.

Azure Authentication

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthGrantType	OAuth フローのグラント種別。

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

Kerberos

---

プロパティ	説明
KerberosKDC	ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。
KerberosRealm	ユーザー認証に使用されるKerberos 領域。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。
KerberosKeytabFile	Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealm	サービスのKerberos レルム。
KerberosServiceKDC	サービスのKerberos KDC。
KerberosTicketCache	MIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクト。
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSH

---

プロパティ	説明
SSHAuthMode	SFTP サーバーへのログオンに使用する認証方法。
SSHClientCert	ユーザーの認証に使用する秘密鍵。
SSHClientCertPassword	SSHClientCert キーのパスワード（ある場合）。
SSHClientCertSubject	SSH クライアント証明書のサブジェクト。
SSHClientCertType	SSHClientCert 秘密鍵の種類。
SSHServer	SSH サーバー。
SSHPort	SSH ポート。
SSHUser	SSH ユーザー。
SSHPassword	SSH パスワード。
SSHServerFingerprint	SSH サーバーのフィンガープリント。
UseSSH	PostgreSQL 接続をSSH 経由でトンネルするかどうか。 SSH を使用します。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
IgnoredSchemas	メタデータクエリによって取得されたスキーマのリストからスキーマを非表示にするために使用される、可視性制限フィルタ。例えば、'information_schema, pg_catalog' です。スキーマ名は、大文字・小文字が区別されます。

Miscellaneous

---

プロパティ	説明
AllowPreparedStatement	クエリステートメントを実行前に準備します。
BrowsePartitions	By default the provider exposes the super table and its partitions by metadata. You may hide sub partitions by setting this property to false.
FetchResultSetMetadata	This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.
IncludeTableTypes	If set to true, the provider will query for the types of individual tables and views.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
QueryPassthrough	このオプションは、クエリをPostgreSQL サーバーにas-is で渡します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TimeZone	Sets the time zone the server will use to return datetime/timestamp columns.

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	認証で使用されるスキーム。有効な入力値は、Password、AzureAD、AzurePassword、AzureMSI、AwsIAMRoles、AwsEC2Roles、GCPServiceAccount です。
Server	サーバーのホスト名またはIP アドレス。
Database	PostgreSQL データベースの名前。
User	認証で使用されるPostgreSQL ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。
Port	PostgreSQL サーバーのポート番号。
UseSSL	このフィールドはSSL が有効化されているかどうかを設定します。
Visibility	Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for the current user.

認証で使用されるスキーム。有効な入力値は、Password、AzureAD、AzurePassword、AzureMSI、AwsIAMRoles、AwsEC2Roles、GCPServiceAccount です。

解説

このフィールドは、Password およびUser とともに、サーバーに対して認証をするために使われます。デフォルト値はPassword です。次のオプションを使って、認証スキームを選択してください。

• Password：認証にPostgreSQL Server パスワードを使う場合に設定。
• AzureAD：Azure Active Directory OAuth 認証を使用する場合に設定。
• AzurePassword：Azure Active Directory パスワード認証を使用する場合に設定。
• AzureMSI：Azure Active Directory MSI（Managed Service Identity）認証を使用する場合に設定。
• AwsIAMRoles：Amazon RDS インスタンスのPostgreSQL サーバーに接続するためにAmazon Web Services IAM ロールを使用する場合に設定。
• AwsEC2Roles：CData Sync App が現在実行されているEC2 マシンに割り当てられたIAM ロールを、自動的に使用する場合に設定。
• GCPServiceAccount: Google Service Account を使用してPostgreSQL のGoogle SQL Cloud インスタンスに認証する場合に設定。

サーバーのホスト名またはIP アドレス。

解説

PostgreSQL Database をホスティングしているサーバーのホスト名またはIP アドレス。指定されない場合は、デフォルト値 "localhost" が使用されます。

PostgreSQL データベースの名前。

解説

PostgreSQL Server に接続する場合のデータベース。データベースが提供されていない場合は、ユーザーのデフォルトデータベースが使用されます。

認証で使用されるPostgreSQL ユーザーアカウント。

解説

このフィールドは、Password とともに、PostgreSQL サーバーに対して認証をするために使われます。

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

PostgreSQL サーバーのポート番号。

解説

PostgreSQL Database をホスティングしているServer サーバーのポート番号。指定されない場合は、デフォルトのポート番号（5432）が使われます。

このフィールドはSSL が有効化されているかどうかを設定します。

解説

このフィールドは、Sync App がサーバーとのTLS/SSL 接続をネゴシエートするかどうかを設定します。デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合します。別の証明書を指定するには、SSLServerCert を設定します。

Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for the current user.

解説

By default, visibility filtering is not applied. Filtering values are case insensitive.

このセクションでは、本プロバイダーの接続文字列で設定可能なAWS Authentication プロパティの全リストを提供します。

---

プロパティ	説明
AWSAccessKey	AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。
AWSSecretKey	AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。
AWSRoleARN	認証時に使用するロールのAmazon リソースネーム。
AWSExternalId	A unique identifier that might be required when you assume a role in another account.

AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

解説

AWS アカウントのアクセスキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

解説

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

認証時に使用するロールのAmazon リソースネーム。

解説

AWS の外部で認証する場合は、AWS アカウント認証情報ではなく、ロールを認証に使用するのが 一般的です。AWSRoleARN を入力すると、CData Sync App はAWSAccessKey とAWSSecretKey を直接 使用する代わりに、ロールベースの認証を実行します。この認証を実行するためには、AWSAccessKey と AWSSecretKey を指定する必要があります。RoleARN を設定するときは、AWS ルートユーザーの 認証情報を使用できません。AWSAccessKey およびAWSSecretKey はIAM ユーザーのものである必要があります。

A unique identifier that might be required when you assume a role in another account.

解説

A unique identifier that might be required when you assume a role in another account.

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

解説

データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は［Azure ポータル］->［Azure Active Directory］->［プロパティ］のディレクトリId です。

通常、Tenant を指定する必要はありません。OAuthGrantType をCODE（デフォルト）に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。

OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthGrantType	OAuth フローのグラント種別。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

OAuth フローのグラント種別。

解説

次のオプションが利用可能です：CODE,CLIENT

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

USER	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。
GOOGLEJSON	この証明書ストアは、サービスアカウント情報を含むJSON ファイルの名前です。Google サービスに接続する場合にのみ有効です。
GOOGLEJSONBLOB	この証明書ストアは、サービスアカウントのJSON を含む文字列です。Google サービスに接続する場合にのみ有効です。

OAuth JWT 証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。

OAuth JWT 証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

Java Web Token の発行者。

解説

Java Web Token の発行者。通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーには、発行者アカウントのコピーが含まれています。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。

このセクションでは、本プロバイダーの接続文字列で設定可能なKerberos プロパティの全リストを提供します。

---

プロパティ	説明
KerberosKDC	ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。
KerberosRealm	ユーザー認証に使用されるKerberos 領域。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。
KerberosKeytabFile	Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealm	サービスのKerberos レルム。
KerberosServiceKDC	サービスのKerberos KDC。
KerberosTicketCache	MIT Kerberos 資格情報キャッシュファイルへのフルパス。

ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Sync App は、Kerberos KDC サービスにセッションチケットと一時セッションキーを要求します。Kerberos KDC サービスは、通常、ドメインコントローラーと同じコンピュータに置かれています。

Kerberos KDC が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからKDC を取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)。
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App は設定されているドメイン名およびホストからそれらを推測します。

ユーザー認証に使用されるKerberos 領域。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Kerberos 領域は、Kerberos キー配布センター（KDC）サービスを使用してユーザーを認証するために使用されます。Kerberos 領域は、管理者が任意の文字列に設定できますが、通常はドメイン名に基づいて設定されます。

Kerberos 領域が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからデフォルトレルムを取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App はユーザー設定されているドメイン名およびホストからそれらを推測します。これは、一部のWindows 環境で機能します。

Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。

解説

Kerberos ドメインコントローラーのSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN を設定します。

Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

解説

Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

サービスのKerberos レルム。

解説

KerberosServiceRealm は、クロスレルムKerberos 認証を使用するときにサービスKerberos レルムを指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

サービスのKerberos KDC。

解説

KerberosServiceKDC は、クロスレルムKerberos 認証を使用するときにサービスKerberos KDC を指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

MIT Kerberos 資格情報キャッシュファイルへのフルパス。

解説

このプロパティは、MIT Kerberos チケットマネージャーまたはkinit コマンドを使用して作成された資格情報キャッシュファイルを使用する場合に設定できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。
SSLClientCertType	TLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPassword	TLS/SSL クライアント証明書のパスワード。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクト。
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。

解説

クライアント証明書のための証明書ストア名。

SSLClientCertType フィールドは、SSLClientCert により指定された証明書ストアの種類を指定します。ストアがパスワードで保護されている場合は、SSLClientCertPassword でパスワードを指定します。

SSLClientCert は、SSLClientCertSubject フィールドとともにクライアント証明書を指定するために使われます。SSLClientCert に値がある場合で、SSLClientCertSubject が設定されている場合は、証明書の検索が始まります。詳しくは、SSLClientCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

TLS/SSL クライアント証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

USER - デフォルト	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。

TLS/SSL クライアント証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

TLS/SSL クライアント証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。例えば、"CN=www.server.com, OU=test, C=US, [email protected]" です。共通のフィールドとその説明は以下のとおりです。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSH プロパティの全リストを提供します。

---

プロパティ	説明
SSHAuthMode	SFTP サーバーへのログオンに使用する認証方法。
SSHClientCert	ユーザーの認証に使用する秘密鍵。
SSHClientCertPassword	SSHClientCert キーのパスワード（ある場合）。
SSHClientCertSubject	SSH クライアント証明書のサブジェクト。
SSHClientCertType	SSHClientCert 秘密鍵の種類。
SSHServer	SSH サーバー。
SSHPort	SSH ポート。
SSHUser	SSH ユーザー。
SSHPassword	SSH パスワード。
SSHServerFingerprint	SSH サーバーのフィンガープリント。
UseSSH	PostgreSQL 接続をSSH 経由でトンネルするかどうか。 SSH を使用します。

SFTP サーバーへのログオンに使用する認証方法。

解説

• None：認証は行われません。現在のUser の値は無視され、接続は匿名でログインされます。
• Password：Sync App は、User とPassword の値を使用してユーザーを認証します。
• Public_Key：Sync App は、User とSSHClientCert の値を使用してユーザーを認証します。SSHClientCert には、この認証方法を成功させるために使用可能な秘密鍵が必要です。

ユーザーの認証に使用する秘密鍵。

解説

公開鍵認証を使用するには、SSHClientCert に有効な秘密鍵が含まれている必要があります。 公開鍵はオプションで、含まれていない場合はSync App が秘密鍵から生成します。 Sync App は公開鍵をサーバーに送信し、ユーザーが公開鍵を認証した場合に接続が許可されます。

SSHClientCertType フィールドは、SSHClientCert により指定されたキーストアの種類を指定します。 ストアがパスワードで保護されている場合は、SSHClientCertPassword でパスワードを指定します。

一部の種類のキーストアは、複数のキーを含むことができるコンテナです。 デフォルトでは、Sync App はストアの最初のキーを選択しますが、SSHClientCertSubject を使用して特定のキーを指定することも可能です。

SSHClientCert キーのパスワード（ある場合）。

解説

このプロパティは、SSHAuthMode がPublicKey に設定され、SSHClientCert が秘密鍵に設定されているSFTP サーバーに認証する場合にのみ使用されます。

SSH クライアント証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	Eメールアドレス

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

SSHClientCert 秘密鍵の種類。

解説

このプロパティには次の値の1つを設定できます。

種類	説明	許容されるBlob 値
MACHINE/USER		Blob 値はサポートされていません。
JKSFILE/JKSBLOB		base64のみ
PFXFILE/PFXBLOB	PKCS12形式（.pfx）のファイル。証明書と秘密鍵の両方を含む必要があります。	base64のみ
PEMKEY_FILE/PEMKEY_BLOB	PEM 形式のファイル。RSA、DSA、またはOPENSSH の秘密鍵を含む必要があります。オプションで、秘密鍵と一致する証明書を含むことができます。	base64またはプレーンテキスト。blob をテキストとして入力する場合、改行をスペースに置き換えることができます。
PPKFILE/PPKBLOB	puttygen ツールで作成されたPuTTY 形式の秘密鍵。	base64のみ
XMLFILE/XMLBLOB	.NET のRSA クラスによって生成される形式のXML キー：RSA.ToXmlString(true)。	base64またはプレーンテキスト。

SSH サーバー。

解説

SSH サーバー。

SSH ポート。

解説

SSH ポート。

SSH ユーザー。

解説

SSH ユーザー。

SSH パスワード。

解説

SSH パスワード。

SSH サーバーのフィンガープリント。

解説

SSH サーバーのフィンガープリント。

PostgreSQL 接続をSSH 経由でトンネルするかどうか。 SSH を使用します。

解説

デフォルトでは、Sync App はPostgreSQL に直接接続しようとします。 このプションを有効にすると、Sync App は代わりにSSHServer でSSH 接続を確率し、PostgreSQL への接続をトンネルします。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はPostgreSQL への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
IgnoredSchemas	メタデータクエリによって取得されたスキーマのリストからスキーマを非表示にするために使用される、可視性制限フィルタ。例えば、'information_schema, pg_catalog' です。スキーマ名は、大文字・小文字が区別されます。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\PostgreSQL Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

メタデータクエリによって取得されたスキーマのリストからスキーマを非表示にするために使用される、可視性制限フィルタ。例えば、'information_schema, pg_catalog' です。スキーマ名は、大文字・小文字が区別されます。

解説

デフォルトでは、制限は適用されません。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
AllowPreparedStatement	クエリステートメントを実行前に準備します。
BrowsePartitions	By default the provider exposes the super table and its partitions by metadata. You may hide sub partitions by setting this property to false.
FetchResultSetMetadata	This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.
IncludeTableTypes	If set to true, the provider will query for the types of individual tables and views.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
QueryPassthrough	このオプションは、クエリをPostgreSQL サーバーにas-is で渡します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TimeZone	Sets the time zone the server will use to return datetime/timestamp columns.

クエリステートメントを実行前に準備します。

解説

AllowPreparedStatement プロパティがfalse に設定されている場合は、ステートメントは実行されるたびに解析されます。たくさんの異なるクエリを一回だけ実行する場合は、このプロパティをfalse に設定すると便利です。

同じクエリを繰り返し実行する場合は、このプロパティをデフォルトのTrue のままにしておくとパフォーマンスが向上します。クエリを準備することで、同じクエリを何度も繰り返しコンパイルすることを避けられます。ただし、プリペアドステートメントの場合、ステートメントが準備される間Sync App は接続をアクティブかつオープンに保つ必要があります。

By default the provider exposes the super table and its partitions by metadata. You may hide sub partitions by setting this property to false.

解説

This property has an effect on servers running version 10 and later.

This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.

解説

By default, the Sync App may request that the server provide detailed information about resultset columns like the table name. It requires issuing additional metadata queries via the Sync App, and it may affect query performance essentially in some scenarios. Consider setting this property to False in order to gain performance in your application if you don't need the respective meta-information for the column.

If set to true, the provider will query for the types of individual tables and views.

解説

If set to true, the Sync App will query PostgreSQL server for the types of individual tables and views.

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

このオプションは、クエリをPostgreSQL サーバーにas-is で渡します。

解説

これが設定されていると、クエリはPostgreSQL に直接渡されます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

Sets the time zone the server will use to return datetime/timestamp columns.

解説

The server stores time with time zone and timestamp with time zone in UTC. If the TimeZone property is not set, the provider uses the client's local time zone.

Setting this property can be useful when you need the server to convert to a specific time zone, which is different from the client's local time zone.