Parameters (Connect-GoogleBigQuery 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 | Google BigQuery に接続する際に使用する認証の種類。 |
| ProjectId | 非修飾テーブルを解決し、ジョブを実行するために使用するProjectId。 |
| DatasetId | The DatasetId used to resolve unqualified tables. |
| BillingProjectId | ジョブを実行する課金プロジェクトのProjectId。 |
| Property | Description |
| AllowLargeResultSets | 大きなデータセットの場合に、大きなデータセットをテンポラリーテーブルに格納するかしないか。 |
| DestinationTable | This property determines where query results are stored in Google BigQuery. |
| UseQueryCache | Google BigQuery のビルトインクエリキャッシュを使用するかどうかを指定します。 |
| PageSize | Google BigQuery から返されるページあたりの結果数。 |
| PollingInterval | ジョブが完了したかどうかを確認するためのチェックの間隔を秒単位で決定します。 |
| AllowUpdatesWithoutKey | 主キーなしで更新を許可するかどうか。 |
| FilterColumns | このプロパティを使用する前に、`AllowUpdatesWithoutKey` をtrue に設定してください。 |
| UseLegacySQL | このクエリにBigQuery のレガシーSQL を使用するかどうかを指定します。デフォルトでは、Standard SQL が使われます。 |
| PrivateEndpointName | When connecting over Private Access, this property specifies the name of the custom endpoint. |
| Property | Description |
| UseStorageAPI | バルクデータ読み出しにBigQuery のStorage API を使用するかどうかを指定します。 |
| UseArrowFormat | BigQuery のStorage API でArrow 形式を使用するかどうかを指定します。 |
| StorageThreshold | Storage API を呼び出すためにクエリが返す必要がある最小行数。 |
| StoragePageSize | Storage API クエリに使用するページサイズを指定します。 |
| Property | Description |
| InsertMode | データを挿入する際に使用する方法を指定します。デフォルトでは、ストリーミングINSERT が使用されます。 |
| WaitForBatchResults | バルクアップロードAPI を使用するときにジョブの完了を待つかどうか。 InsertMode がUpload に設定されている場合のみ有効です。 |
| GCSBucket | Specifies the name of a GCS bucket to upload bulk data for staging. |
| GCSBucketFolder | Specifies the name of the folder in GCSBucket to upload bulk data for staging. |
| TempTableDataset | The prefix of the dataset that will contain temporary tables when performing bulk UPDATE or DELETE operations. |
| Property | Description |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
| DelegatedServiceAccounts | 委任されたリクエストのためのサービスアカウントE メールのスペース区切りのリスト。 |
| RequestingServiceAccount | 委任されたリクエストを行うためのサービスアカウントのE メール。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| Scope | アプリケーションがリクエストしているGoogle API アクセスを識別します。スコープはスペースで区切られます。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期限（秒単位）。 |
| OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ（ミリ秒）。 |
| Property | Description |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| Property | Description |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| Property | Description |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| Property | Description |
| ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | プロキシサーバー（ ProxyServer 接続プロパティで指定）が起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
| 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 です。 |
| RefreshViewSchemas | provider が自動的に最新のビュースキーマを決定することを許可します。 |
| ShowTableDescriptions | プラットフォームのメタデータAPI とsys_tables / sys_views を介してテーブルの説明を返すかどうかを制御します。 |
| PrimaryKeyIdentifiers | Set this property to define primary keys. |
| AllowedTableTypes | Specifies what kinds of tables will be visible. |
| FlattenObjects | Determines whether the provider flattens STRUCT fields into top-level columns. |
| Property | Description |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| Property | Description |
| StorageTimeout | How long a Storage API connection must remain idle before the provider reconnects. |
| EmptyArraysAsNull | Whether empty arrays are represented as 'null' or as '[]' |
| HidePartitionColumns | Whether partition tables will show the columns _PARTITIONDATE and _PARTITIONTIME. |
| AllowAggregateParameters | QueryPassthrough が有効になっているときに、パラメータで生の集計を使用できるようにします。 |
| ApplicationName | An application name in the form application/version. For example, AcmeReporting/1.0. |
| AuditLimit | 監査テーブル内に保存される行の最大数。 |
| AuditMode | 監査テーブルに記録するprovider アクション。 |
| AWSWorkloadIdentityConfig | AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。 |
| BigQueryOptions | BigQuery オプションのカンマ区切りのリスト。 |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| MaximumBillingTier | MaximumBillingTier はTB あたりの基本料金の乗数となる正の整数です。例えばMaximumBillingTier を2 に設定すると、そのクエリの最大費用はTB あたり2x 基本価格になります。 |
| MaximumBytesBilled | BigQuery がジョブがキャンセルされる前に消費を許容するバイト数を制限します。 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
| QueryPassthrough | このオプションは、クエリをGoogle BigQuery サーバーにas-is で渡します。 |
| Readonly | このプロパティを使用して、provider からGoogle BigQuery へのアクセスを読み取り専用に設定できます。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| TableSamplePercent | This determines what percent of a table is sampled with the TABLESAMPLE operator. |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
| WorkloadPoolId | Workload Identity Federation プールのID。 |
| WorkloadProjectId | Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。 |
| WorkloadProviderId | Workload Identity Federation プールプロバイダーのID。 |