Cmdlets for Apache CouchDB

Build 24.0.9062

Parameters (Connect-ApacheCouchDB Cmdlet)

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

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Apache CouchDB.
URLThe URL used to connect to the Apache CouchDB.
User認証で使用されるApache CouchDB ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
PublicDatabasesSpecify a comma-separated list of public databases to list as tables.

JWTAuthentication


PropertyDescription
JWTTokenThe JWT token to use for authentication.
JWTSubjectThe user subject for which the application is requesting delegated access.
JWTIssuerThe issuer of the JWT token.
JWTAlgorithmThe encryption algorithm used for signing the JWT token.
JWTExpirationHow long the JWT token should remain valid, in seconds.
JWTKeyTypeThe type of the encryption key which is used for signing the JWT token.
JWTKeyThe encryption key for signing the JWT token.
JWTHeadersA collection of extra headers that should be included in the JWT header.
JWTClaimsA collection of extra claims that should be included in the JWT payload.
CredentialsLocationThe location of the settings file where the JWT token is saved.

SSL


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

Firewall


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

Proxy


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

Logging


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

Schema


PropertyDescription
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ListViewsWhether to list views from Apache CouchDB or not.

Caching


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

Miscellaneous


PropertyDescription
FlattenArraysSet FlattenArrays to the number of array elements to flatten into columns. Otherwise, arrays are returned as JSON strings.
FlattenObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, embedded objects as raw JSON strings.
FlexibleSchemaSet FlexibleSchema to true to scan for additional metadata on the query result set. Otherwise, the metadata will remain the same.
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeApache CouchDB から返されるページあたりの結果の最大数。
PseudoColumnsカラムとして公開する擬似カラムのセットを指定します。
Readonlyこのプロパティを使用して、provider からApache CouchDB へのアクセスを読み取り専用に設定できます。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
RTKライセンス供与で使用されるランタイムキー。
SeparatorCharacterThe character or characters used to denote hierarchy.
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionSchemeDetermines how the provider will scan the data to determine the fields and data types in each document collection.
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

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