CData Sync App は、IBM Cloud SQL Query データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
IBM Cloud SQL Query コネクタはCData Sync アプリケーションから使用可能で、IBM Cloud SQL Query からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、IBM Cloud SQL Query への接続を作成します。IBM Cloud SQL Query アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからIBM Cloud SQL Query コネクタをダウンロードおよびインストールします。
必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。
OAuth 認証では、IBM Cloud SQL Query を使用するためにブラウザと対話する必要はありません。IBM Cloud への接続 で説明するとおり、Sync App はこの処理をサポートします。
IBM Cloud に接続するにはApiKey が必要です。すべてのバケットが同じリージョンに属する場合は、オプションでRegion を設定することもできます。
接続すると、Sync App がOAuth プロセスを完了します。
IBM Cloud でアカウントを作成したら、下記の手順に従って接続プロパティを取得します。
ApiKey を取得するには、次の手順を実行してください。
接続するには、CloudObjectStorageCRN およびSqlQueryCRN が必要です。これらの値は自動的に決定されます。これに失敗した場合や、複数のSQL Query サービスが利用可能な場合は、これらの接続プロパティを設定することをお勧めします。適切な値を見つけるには、次のことができます：
IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。
IBM Cloud アカウントにSQL Query がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。
The CData Sync App enables you to persist schema definitions to configuration files. Schema files make it easy to customize and save the dynamically detected schemas, or to define your own view of the data.
You can invoke the CreateSchema stored procedure to manually generate a schema file based on the provided input parameters. This is particularly useful in situations where the name of the file in CloudStorageObject does not have (the correct) file extension.
After creating a schema, you may use the name of the generated file to query from that view.
下記の手順に従って、IBM Cloud SQL Query をクエリするためのデフォルトSync App を設定します。
ジョブがサーバー側で開始されると、IBM Cloud SQL Query は自動的にこのジョブをチェックして処理を終了します。プロバイダがジョブステータスに対して行っているリクエストの待機時間を設定するには、PollingInterval を使用できます。
一部のクエリは複雑になる可能性があり、結果が取得されるまでに時間がかかることに注意してください。そのため、多くの不必要なリクエストをしないためにPollingInterval が長くなるように設定されている可能性があります。SELECT クエリが単純な"Select * FROM Table" クエリでなく、少なくともクライテリアや予測が含まれている場合のみ、サーバー側でジョブが開始されます。各ジョブの結果は"Select" 操作のみをサポートするため、ビューと見なされます。
IBM Cloud SQL Query は、実行した各クエリの結果をResultLocationURI 内のCSV またはJSON ファイルに格納します。CleanQueryResults を使用すると、実行されたすべてのクエリに対してこれらのファイルを自動的にクリーニングできます。
プロセス内の最後の接続を切断すると、この動作によってパフォーマンスが若干低下することに注意してください。
QueryCachingLevel を設定して、ResultLocationURI に格納されているクエリ結果の使用方法を変更します。これは、特定のクエリを複数回実行するときに特に役立ちます。これは、IBM Cloud SQL Query が同じデータを再度スキャンすることはなく、単に前回の実行の結果を使用するということです。これらの結果は、QueryTolerance で指定された秒数より前にジョブが開始された場合は使用されません。
デフォルトのバケットはBucket および接続プロパティを設定することで指定できます。これはオプションで、クエリを発行するときにバケットを指定しない場合に使用されます。Bucket が設定されていない場合、バケット名は[Schema].[Table] の形式でクエリのスキーマとして使用する必要があります。
結果は異なるデータ型で格納される場合があります。デフォルトでは、CData Sync App はCSV を使用します。これはStoreResultsAs を設定することで変更できます。
このセクションでは、IBM Cloud SQL Query Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、IBM Cloud SQL Query にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
| Name | Description |
| RecentJobs | Query information regarding recent executed jobs. At most, information about the 30 latest jobs will be returned. |
| Services | Query resource instances belonging to the current authenticated user. |
Query information regarding recent executed jobs. At most, information about the 30 latest jobs will be returned.
The driver uses the IBM Cloud SQL Query API to process search criteria that refer to JobId columns.
For example, the following queries are processed server side:
SELECT * FROM RecentJobs WHERE JobId = '86402b0c-4665-4936-b0ff-e5051f5f5a49'
| Name | Type | Description |
| JobId | String | The id of the job. |
| Statement | String | The statement sent to the API for the job. |
| Status | String | The status of the job. |
Query resource instances belonging to the current authenticated user.
| Name | Type | Description |
| Name | String | The name of the service. |
| CRN | String | The CRN (Cloud resource name) of the service. |
| プロパティ | 説明 |
| ApiKey | The API Key used to identify the user to IBM Cloud. |
| CloudObjectStorageCRN | The CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud. |
| SqlQueryCRN | The CRN which uniquely identifies your SQL Query instance in IBM Cloud. |
| プロパティ | 説明 |
| Bucket | The name of the bucket in IBM Cloud that you will be connecting to. |
| ResultLocationURI | A COSURI (e.g. cos://region/bucket) where job files will be stored. |
| Region | The geographic location of the bucket you're connecting to. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュール。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| CleanQueryResults | CleanQueryResults specifies whether query cache files should be deleted once the connection is closed. |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PollingInterval | Specifies the amount of time in seconds that the provider should wait between the job status requests. |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| QueryCachingLevel | Sets the level of caching for executed queries. |
| QueryTolerance | Specifies the amount of time in seconds queries cache for if QueryCachingLevel is set to local or cloud. |
| StoreResultsAs | Specifies the data type of the generated results file after a job has been completed. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| ApiKey | The API Key used to identify the user to IBM Cloud. |
| CloudObjectStorageCRN | The CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud. |
| SqlQueryCRN | The CRN which uniquely identifies your SQL Query instance in IBM Cloud. |
The API Key used to identify the user to IBM Cloud.
Access to resources in the IBM Cloud SQL Query REST API is governed by an API key in order to retrieve token. An API Key is created by navigating to Manage --> Access (IAM) --> Users and clicking 'Create'.
The CRN which uniquely identifies your Cloud Object Storage instance in IBM Cloud.
Access to resources, such as data, in the IBM Cloud SQL Query REST API is governed by an Instance Cloud Resource Name. To retrieve your CloudObjectStorage CRN, select your Cloud Object Storage instance from the Dashboard, then click the 'Service credentials' tab on the right hand side and create or select one of the existing credentials by clicking on view credentials. Among the information displayed, you will find the CloudObjectStorageCRN (resource_instance_id). Use that value for this property. If not specified, the IBM Cloud SQL Query will automatically retrieve the CloudObjectStorageCRN. If more than one CloudObjectStorage service is available, then the first one in the list will be picked.
The CRN which uniquely identifies your SQL Query instance in IBM Cloud.
Access to resources, such as jobs, in the IBM Cloud SQL Query REST API is governed by an Instance Cloud Resource Name. To retrieve your SqlQuery CRN, select your SQL Query instance from the Dashboard. On the left hand side, the manage tab should be automatically selected. On that page, you may find the SqlQuery CRN of that instance under the 'Deployment details' pane. If not specified, the IBM Cloud SQL Query will automatically retrieve the SqlQueryCRN. If more than one SqlQuery service is available, then the first one in the list will be picked.
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| Bucket | The name of the bucket in IBM Cloud that you will be connecting to. |
| ResultLocationURI | A COSURI (e.g. cos://region/bucket) where job files will be stored. |
| Region | The geographic location of the bucket you're connecting to. |
The name of the bucket in IBM Cloud that you will be connecting to.
In order to access resources in the IBM Cloud SQL Query REST API, a Bucket can be used. All bucket names are listed on the IBM Cloud Dashboard. This is value is optional and can be left blank , which will allow the CData Sync App to automatically determine the Bucket.
A COSURI (e.g. cos://region/bucket) where job files will be stored.
A COSURI (e.g. cos://region/bucket) where job files will be stored.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
| タイプ | デフォルトポート | 説明 |
| TUNNEL | 80 | これが設定されている場合、Sync App はIBM Cloud SQL Query への接続を開き、プロキシを経由して通信が行われます。 |
| SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
| AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\IBMCloudSQLQuery 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` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| CleanQueryResults | CleanQueryResults specifies whether query cache files should be deleted once the connection is closed. |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PollingInterval | Specifies the amount of time in seconds that the provider should wait between the job status requests. |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| QueryCachingLevel | Sets the level of caching for executed queries. |
| QueryTolerance | Specifies the amount of time in seconds queries cache for if QueryCachingLevel is set to local or cloud. |
| StoreResultsAs | Specifies the data type of the generated results file after a job has been completed. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
CleanQueryResults specifies whether query cache files should be deleted once the connection is closed.
IBM Cloud SQL Query stores the results of every query you execute as a CSV or JSON file in Bucket.
You can use CleanQueryResults, to clean these files for every query executed. Note that this behavior will add a minor performance hit when you disconnect the last connection in a process.
See デフォルトの動作のカスタマイズ for more information on configuring IBM Cloud's query caching.
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Specifies the amount of time in seconds that the provider should wait between the job status requests.
Once a job is initiated server-side, IBM Cloud automatically checks for this job to finish processing. You can use PollingInterval to configure the wait time of the requests that the provider is doing towards the job status.
Note that some queries may be complex and it will take longer for the result to be retrieved, that is why the PollingInterval might be configured to be longer in order not to make so many unnecessary requests. A job is initiated server-side only when the Select query is not a simple "Select * From Table" query but it has at least a criteria or projection in it. The outcome of each job is considered a view as it supports only "Select" operation.
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
Sets the level of caching for executed queries.
Sets the level of caching for executed queries.
| Local | Setting QueryCachingLevel to Local will persist the query Id returned by IBM Cloud SQL Query after a query execution individually for every connection. Closing the connection will clean the cache, so that only a single connection can make use of the results. |
| Cloud | Setting QueryCachingLevel to Cloud will attempt to retrieve the latest executed jobs by IBM Cloud SQL Query, and if the query being run matches with one of the recent finished jobs, a job will not be created and the result set will be retrieved directly. If CleanQueryResults is set to true (default false), then the result sets of these recent (cached) jobs will be removed. |
| None | Setting QueryCachingLevel to None will disable the feature. |
Specifies the amount of time in seconds queries cache for if QueryCachingLevel is set to local or cloud.
Values lower than 1 are not accepted.
Specifies the data type of the generated results file after a job has been completed.
| CSV | Setting StoreResultsAs to CSV will store the results in the CSV format. |
| JSON | Setting StoreResultsAs to JSON will store the results in the JSON format. |
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM [CloudObjectStorage_1].[SampleBucket_1].Jobs WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"