Cmdlets for Elasticsearch

Build 20.0.7654

Parameters (Connect-Elasticsearch Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Parameter Required Description
AuthScheme    認証で使用されるスキーム。None、Basic、Negotiate (Kerberos)、AwsRootKeys およびAwsIAMRoles のエントリーが許容されます。デフォルト値はNone です。 
AutoCache    SELECT クエリの結果を、 CacheLocation 、または&rpCacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 
AWSAccessKey  True  AWS アカウントのアクセスキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 
AWSRegion  True  Amazon Web サービスのホスティングリージョン。 
AWSRoleARN  True  認証時に使用するロールのAmazon リソースネーム。 
AWSSecretKey  True  AWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 
AWSSessionToken    AWS のセッショントークン。 
CacheConnection    キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 
CacheLocation    キャッシュデータベースへのパスとファイル名を指定します。 
CacheMetadata    このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 
CacheProvider    データのキャッシュに使用されるプロバイダーの名前。 
CacheTolerance    AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 
ClientSideEvaluation    Set ClientSideEvaluation to true to perform Evaluation client side on nested objects. 
DataModel    Elasticsearch ドキュメントをパースしてデータベースのメタデータを生成するときに使用するデータモデルを指定します。 
FirewallPassword    プロキシベースのファイアウォールへの認証に使われるパスワード。 
FirewallPort    プロキシベースのファイアウォールのTCP ポート。 
FirewallServer    プロキシベースのファイアウォールの名前もしくはIP アドレス。 
FirewallType    プロキシベースのファイアウォールで使われるプロトコル。 
FirewallUser    プロキシベースのファイアウォールに認証するために使うユーザー名。 
FlattenArrays    テーブルカラムとして返したいネストされた配列エレメントの数に FlattenArrays を設定します。デフォルトで、ネスト配列はJSON 文字列として返されます。 
FlattenObjects    フラット化されたオブジェクトとしてカラムを表示するか、オブジェクトプロパティをJSON 文字列として返すか。 
GenerateSchemaFiles    スキーマを生成して保存するユーザーの好みのタイミングを示します。 
KerberosKDC    ユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。 
KerberosKeytabFile    Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。 
KerberosRealm    ユーザーの認証で使用されるKerberos 領域。 
KerberosServiceKDC    サービスのKerberos KDC。 
KerberosServiceRealm    サービスのKerberos レルム。 
KerberosSPN    Kerberos ドメインコントローラーのサービスプリンシパル名(SPN)。 
KerberosTicketCache    MIT Kerberos 資格情報キャッシュファイルへのフルパス。 
Location    テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 
Logfile    ログファイルの名前と場所を指定するファイルパス。 
LogModules    ログファイルに含まれるコアモジュール。 
MaxLogFileCount    ログファイルの最大ファイル数を指定する文字列。サイズリミットを超えると、日付と時刻が末尾に追加された新しいログが同じフォルダ内に作成され、最も古いログファイルが削除されます。 
MaxLogFileSize    ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。サイズリミットを超えると、日付と時刻が末尾に追加された新しいログが同じフォルダ内に作成されます。 
MaxResults    デフォルトのSearch API 使用時にElasticsearch から返される結果の最大数。 
MaxRows    クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 
Offline    オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 
Other    これらの隠しプロパティは特定のユースケースでのみ使用されます。 
PageSize    Elasticsearch から返されるリクエストあたりの結果数。 
Password    Elasticsearch への認証に使われるパスワード。 
Port  True  Elasticsearch REST サーバーのポート。 
ProxyAuthScheme    ProxyServer プロキシへの認証で使われる認証タイプ。 
ProxyAutoDetect    これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 
ProxyExceptions    ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 
ProxyPassword    ProxyServer プロキシへの認証に使われるパスワード。 
ProxyPort    ProxyServer プロキシが起動しているTCP ポート。 
ProxyServer    HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 
ProxySSLType    ProxyServer プロキシへの接続時に使用するSSL タイプ。 
ProxyUser    ProxyServer プロキシへの認証に使われるユーザー名。 
PseudoColumns    このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 
QueryPassthrough    このオプションを使用すると、正確なクエリをElasticsearch に渡すことができます。 
Readonly    このプロパティを使用して、provider からElasticsearch へのアクセスを読み取り専用に設定できます。 
RowScanDepth    テーブルメタデータの生成時にスキャンする最大の行数。このプロパティを使って、provider がどのように配列を検出するかをより深くコントロールすることができます。 
RTK    ライセンス供与で使用されるランタイムキー。 
ScrollDuration    Scroll API 経由で結果を取得する際に使用するtime unit の指定。 
Server  True  Elasticsearch REST サーバーのホスト名またはIP アドレス。 
SSLClientCert    SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。 
SSLClientCertPassword    TLS/SSL クライアント証明書のパスワード。 
SSLClientCertSubject    TLS/SSL クライアント証明書の件名。 
SSLClientCertType    TLS/SSL クライアント証明書を格納するキーストアの種類。 
SSLServerCert    TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 
SupportEnhancedSQL    このプロパティは、API から直接サポートされる範囲を超えるSQL 機能の拡張は、インメモリによるクライアントサイド処理を有効にすることで可能になります。 
Tables    このプロパティは、レポートされたテーブルを使用可能なテーブルのサブセットに制限します。例えば、Tables=TableA,TableB,TableC です。 
TemporaryTokenDuration  True  The amount of time (in seconds) an AWS temporary token will last. 
Timeout    タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 
User    Elasticsearch に認証を行っているユーザー。 
Verbosity    ログファイルに含まれる詳細の量を決定するメッセージレベル。 
Views    レポートされたビューを使用可能なテーブルのサブセットに制限します。例えば、Views=ViewA,ViewB,ViewC です。 

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654