Excel Add-In for Elasticsearch

Build 24.0.9062

接続プロパティ

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

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

Authentication


プロパティ説明
AuthScheme認証で使用されるスキーム。None、Basic、Negotiate (Kerberos)、AwsRootKeys、AwsIAMRoles、AwsEC2Roles、APIKey、およびTemporaryCredentials のエントリーが許容されます。デフォルト値はNone です。
UserElasticsearch に認証を行っているユーザー。
PasswordElasticsearch への認証に使われるパスワード。
UseSSLThis property sets whether the provider attempts to negotiate TLS/SSL connections to the server.
ServerElasticsearch REST サーバーのホスト名またはIP アドレス。あるいは、単一のクラスタ内の複数のノードを指定することもできますが、その場合はすべてのノードがREST API コールをサポートできる必要があります。
PortElasticsearch REST サーバーのポート。
APIKeyThe APIKey used to authenticate to Elasticsearch.
APIKeyIdThe APIKey Id to authenticate to Elasticsearch.

Connection


プロパティ説明
DataModelElasticsearch ドキュメントをパースしてデータベースのメタデータを生成するときに使用するデータモデルを指定します。
ExposeDotIndicesIf false, indices whose name starts with a '.' (dot indices) will not be exposed as tables or views by the provider. If true, dot indices will be exposed as tables or views.
AliasesFilterビューとして公開されるエイリアスをフィルタリングするために使用されるエイリアス名またはフィルタのカンマ区切りのリスト。
IndicesAndDataStreamsFilterインデックスおよびデータストリーム名またはフィルタのカンマ区切りリスト。
UseLakeFormationこのプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。

AWS Authentication


プロパティ説明
AWSAccessKeyAWS アカウントのアクセスキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSSecretKeyAWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWSRoleARN認証時に使用するロールのAmazon リソースネーム。
AWSRegionAmazon Web サービスのホスティングリージョン。
AWSSessionTokenAWS のセッショントークン。
TemporaryTokenDurationThe amount of time (in seconds) an AWS temporary token will last.
AWSExternalId他のアカウントでロールを引き受ける際に必要となる一意の識別子。
AWSWebIdentityTokenID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。

Kerberos


プロパティ説明
KerberosKDCユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。
KerberosRealmユーザー認証に使用されるKerberos 領域。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)。
KerberosUserThe principal name for the Kerberos Domain Controller. Used in the format host/user@realm
KerberosKeytabFileKerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealmサービスのKerberos レルム。
KerberosServiceKDCサービスのKerberos KDC。
KerberosTicketCacheMIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL


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

Firewall


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

Proxy


プロパティ説明
ProxyAutoDetectこの接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。
ProxyServerHTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPortプロキシサーバー( ProxyServer 接続プロパティで指定)が起動しているTCP ポート。
ProxyAuthSchemeProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。
ProxyUserProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPasswordProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


プロパティ説明
Logfileログファイルの名前と場所を指定するファイルパス。
Verbosityログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。
LogModulesログファイルに含めるコアモジュール。
MaxLogFileSizeログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。
MaxLogFileCountログファイルの最大ファイル数を指定する文字列。

Schema


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
FlattenObjectsフラット化されたオブジェクトとしてカラムを表示するか、オブジェクトプロパティをJSON 文字列として返すか。
FlattenArraysテーブルカラムとして返したいネストされた配列エレメントの数に FlattenArrays を設定します。デフォルトで、ネスト配列はJSON 文字列として返されます。

Caching


プロパティ説明
AutoCacheSELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。
CacheProviderデータのキャッシュに使用されるプロバイダーの名前。
CacheConnectionキャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。
CacheLocationキャッシュデータベースへのパスとファイル名を指定します。
CacheToleranceAutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。
Offlineオフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。
CacheMetadataこのプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。

Miscellaneous


プロパティ説明
ClientSideEvaluationSet ClientSideEvaluation to true to perform Evaluation client side on nested objects.
GenerateSchemaFilesスキーマを生成して保存するユーザーの好みのタイミングを示します。
MaxResultsデフォルトのSearch API 使用時にElasticsearch から返される結果の最大数。
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PageSizeElasticsearch から返されるリクエストあたりの結果数。
PaginationModeSpecifies whether to use PIT with search_after or scrolls to page through query results.
PITDurationSpecifies the time unit to use for keep alive when retrieving results via PIT API.
QueryPassthroughこのオプションを使用すると、正確なクエリをElasticsearch に渡すことができます。
Readonlyこのプロパティを使用して、provider からElasticsearch へのアクセスを読み取り専用に設定できます。
RowScanDepthテーブルメタデータの生成時にスキャンする最大の行数。このプロパティを使って、provider がどのように配列を検出するかをより深くコントロールすることができます。
ScrollDurationSpecifies the time unit to use for keep alive when retrieving results via the Scroll API.
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseFullyQualifiedNestedTableNameSet this to true to set the generated table name as the complete source path when flattening nested documents using Relational DataModel .
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062