Parameters (Connect-SparkSQL Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| AuthScheme | The authentication scheme used. Accepted entries are Plain, LDAP, NOSASL, and Kerberos. |
| Server | The host name or IP address of the server hosting the SparkSQL database. |
| Port | The port for the SparkSQL database. |
| User | The username used to authenticate with SparkSQL. |
| Password | The password used to authenticate with SparkSQL. |
| Database | The name of the SparkSQL database. |
| ProtocolVersion | The Protocol Version used to authenticate with SparkSQL. |
| ImpersonationProxyUser | The proxy user of the Hive user impersonation. |
| SaslQop | Quality of protection for the SASL framework. The level of quality is negotiated between the client and server during authentication. Used by Kerberos authentication with TCP transport. |
| TransportMode | The transport mode to use to communicate with the Hive server. Accepted entries are BINARY and HTTP. |
| Property | Description |
| KerberosKDC | ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。 |
| KerberosRealm | ユーザー認証に使用されるKerberos 領域。 |
| KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。 |
| KerberosKeytabFile | Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。 |
| KerberosServiceRealm | サービスのKerberos レルム。 |
| KerberosServiceKDC | サービスのKerberos KDC。 |
| KerberosTicketCache | MIT Kerberos 資格情報キャッシュファイルへのフルパス。 |
| Property | Description |
| SSLClientCert | SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストア。 |
| SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| Property | Description |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| Property | Description |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| Property | Description |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ（例えば、10MB）を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| Property | Description |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| Property | Description |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| Property | Description |
| AsyncQueryTimeout | The timeout for asynchronous requests issued by the provider to download large result sets. |
| DescribeCommand | The describe command to determine which describe command will use to communicate with the Hive server. Accepted entries are DESCRIBE and DESC. |
| DetectView | Specifies whether to use DECRIBE FORMATTED ... to detect the specified table is view or not. |
| HTTPPath | The path component of the URL endpoint when using HTTP TransportMode. |
| MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| QueryPassthrough | このオプションは、クエリをSpark SQL サーバーにas-is で渡します。 |
| Readonly | このプロパティを使用して、provider からSpark SQL へのアクセスを読み取り専用に設定できます。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| ServerConfigurations | A name-value list of server configuration variables to override the server defaults. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UseDatabricksUploadApi | This option specifies whether the Databricks Upload API will be use when executing batch insert. |
| UseDescTableQuery | This option specifies whether the columns will be retrieved using a DESC TABLE query or the GetColumns Thrift API.The GetColumns Thrift API works for the SparkSQL 3.0.0 or later. |
| UseInsertSelectSyntax | Specifies whether to use an INSERT INTO SELECT statement. |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| UseSSL | Specifies whether to use SSL Encryption when connecting to Hive. |