ツール: get_table_info
BigQuery テーブルに関するメタデータ情報を取得します。
次のサンプルは、curl を使用して get_table_info MCP ツールを呼び出す方法を示しています。
| Curl リクエスト |
|---|
curl --location 'https://bigquery.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_table_info", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
入力スキーマ
テーブルの要求。
| JSON 表現 |
|---|
{ "projectId": string, "datasetId": string, "tableId": string } |
| フィールド | |
|---|---|
projectId |
必須。テーブル リクエストのプロジェクト ID。 |
datasetId |
必須。テーブル リクエストのデータセット ID。 |
tableId |
必須。テーブル リクエストのテーブル ID。 |
出力スキーマ
| JSON 表現 |
|---|
{ "kind": string, "etag": string, "id": string, "selfLink": string, "tableReference": { object ( |
| フィールド | |
|---|---|
kind |
リソース ID の型。 |
etag |
出力専用。このリソースのハッシュ。 |
id |
出力専用。テーブルを一意に識別する不透明な ID。 |
selfLink |
出力専用。このリソースに再度アクセスするために使用できる URL。 |
tableReference |
必須。このテーブルの ID を説明するリファレンス。 |
friendlyName |
省略可。このテーブルのわかりやすい名前。 |
description |
省略可。このテーブルのわかりやすい説明。 |
labels |
このテーブルに関連付けられているラベル。これらを使用して、テーブルを整理してグループ化できます。ラベルのキーと値は 63 文字以内にする必要があります。使用できるのは、英小文字、数字、アンダースコア、ダッシュのみです。国際文字も使用できます。ラベル値は省略可能です。ラベルキーの先頭は文字にする必要があります。リスト内の各ラベルには異なるキーが必要です。
|
schema |
省略可。このテーブルのスキーマを説明します。 |
timePartitioning |
指定すると、このテーブルの時間ベースのパーティショニングが構成されます。 |
rangePartitioning |
指定すると、このテーブルの範囲パーティショニングが構成されます。 |
clustering |
テーブルのクラスタリング仕様。時間ベースのパーティショニングで指定する必要があります。テーブル内のデータは最初にパーティション分割され、その後クラスタ化されます。 |
requirePartitionFilter |
省略可。true に設定すると、このテーブルに対するクエリでは、パーティションの除外に使用できるパーティション フィルタを指定する必要があります。 |
numBytes |
出力専用。このテーブルのサイズ(論理バイト単位)。ストリーミング バッファ内のデータは除外されます。 |
numPhysicalBytes |
出力専用。このテーブルの物理サイズ(バイト単位)。これには、タイムトラベルに使用されるストレージが含まれます。 |
numLongTermBytes |
出力専用。テーブル内の論理バイトのうち、「長期保存」と見なされるバイト数。 |
numRows |
出力専用。このテーブルのデータ行数(ストリーミング バッファ内のデータを除く)。 |
creationTime |
出力専用。エポックからのミリ秒で示した、このテーブルの作成時刻。 |
expirationTime |
省略可。このテーブルの有効期限(エポックからのミリ秒単位)。存在しない場合、テーブルは永遠に保持されます。期限切れのテーブルは削除され、ストレージが再利用されます。カプセル化されたデータセットの defaultTableExpirationMs プロパティを使用して、新しく作成されたテーブルにデフォルトの expirationTime を設定できます。 |
lastModifiedTime |
出力専用。このテーブルが最後に変更された時刻(エポックからのミリ秒単位)。 |
type |
出力専用。テーブルタイプを記述します。次の値を使用できます。
デフォルト値は |
view |
省略可。ビュー定義。 |
materializedView |
省略可。マテリアライズド ビューの定義。 |
materializedViewStatus |
出力専用。マテリアライズド ビューのステータス。 |
externalDataConfiguration |
省略可。BigQuery の外部に保存されているテーブルのデータ形式、ロケーション、その他のプロパティを記述します。これらのプロパティを定義すると、データソースは標準の BigQuery テーブルと同じようにクエリできるようになります。 |
biglakeConfiguration |
省略可。Apache Iceberg 用の BigQuery テーブルの構成を指定します。 |
managedTableType |
省略可。設定すると、データセットで構成されているデフォルトの管理テーブル タイプがオーバーライドされます。 |
location |
出力専用。テーブルが存在する地理的位置。この値はデータセットから継承されます。 |
streamingBuffer |
出力専用。このテーブルのストリーミング バッファに関する情報が含まれます(存在する場合)。テーブルがストリーミングされていない場合、またはストリーミング バッファにデータがない場合、このフィールドは存在しません。 |
encryptionConfiguration |
カスタム暗号化構成(Cloud KMS 鍵)。 |
snapshotDefinition |
出力専用。スナップショットに関する情報が含まれています。この値は、スナップショットの作成時に設定されます。 |
defaultCollation |
省略可。テーブル内の新しい STRING フィールドのデフォルトの照合仕様を定義します。テーブルの作成または更新時に、明示的な照合順序を指定せずに STRING フィールドがこのテーブルに追加されると、テーブルはテーブルのデフォルトの照合順序を継承します。このフィールドを変更すると、変更後に新たに追加されたフィールドにのみ影響し、既存のフィールドは変更されません。次の値を使用できます。
|
defaultRoundingMode |
省略可。テーブル内の新しい decimal フィールド(NUMERIC または BIGNUMERIC)のデフォルトの丸めモードの仕様を定義します。テーブルの作成または更新時に、明示的な丸めモードを指定せずにこのテーブルに小数フィールドを追加すると、フィールドはテーブルのデフォルトの丸めモードを継承します。このフィールドを変更しても、既存のフィールドには影響しません。 |
cloneDefinition |
出力専用。クローンに関する情報が含まれます。この値はクローン オペレーションで設定されます。 |
numTimeTravelPhysicalBytes |
出力専用。タイムトラベル ストレージで使用される物理バイト数(削除または変更されたデータ)。このデータはリアルタイムで保持されるのではなく、数秒から数分遅れることがあります。 |
numTotalLogicalBytes |
出力専用。テーブルまたはマテリアライズド ビューの論理バイトの合計数。 |
numActiveLogicalBytes |
出力専用。作成後 90 日未満の論理バイト数。 |
numLongTermLogicalBytes |
出力専用。作成後 90 日以上経過した論理バイト数。 |
numCurrentPhysicalBytes |
出力専用。現在のライブデータ ストレージで使用される物理バイト数。このデータはリアルタイムで保持されるのではなく、数秒から数分遅れることがあります。 |
numTotalPhysicalBytes |
出力専用。このテーブルの物理サイズ(バイト単位)。これには、タイムトラベルに使用されるストレージも含まれます。このデータはリアルタイムで保持されるのではなく、数秒から数分遅れることがあります。 |
numActivePhysicalBytes |
出力専用。作成後 90 日未満の物理バイト数。このデータはリアルタイムで保持されるのではなく、数秒から数分遅れることがあります。 |
numLongTermPhysicalBytes |
出力専用。作成後 90 日以上経過した物理バイト数。このデータはリアルタイムで保持されるのではなく、数秒から数分遅れることがあります。 |
numPartitions |
出力専用。テーブルまたはマテリアライズド ビューに存在するパーティションの数。このデータはリアルタイムで保持されるのではなく、数秒から数分遅れることがあります。 |
maxStaleness |
省略可。テーブル(または古いマテリアライズド ビュー)がクエリされたときに返されるデータの最大未更新。古さは、sql IntervalValue 型の文字列エンコードとしてエンコードされます。 |
restrictions |
省略可。出力専用。テーブルの制限構成。設定されている場合、構成に基づいてテーブルに対する特定のアクセスを制限します。詳細については、データの下り(外向き)をご覧ください。 |
tableConstraints |
省略可。テーブルの主キーと外部キーの情報 |
resourceTags |
省略可。このテーブルに適用されているタグ。タグキーはグローバルに一意です。タグキーは、名前空間形式(例: 「123456789012/environment」)で指定する必要があります。ここで、123456789012 は、このタグキーの親組織またはプロジェクト リソースの ID です。タグ値は略称(「Production」など)である必要があります。詳しくは、タグの定義をご覧ください。
|
tableReplicationInfo |
省略可。 |
replicas[] |
省略可。出力専用。テーブルで現在アクティブなすべてのレプリカのテーブル参照。 |
externalCatalogTableOptions |
省略可。オープンソース互換テーブルを定義するオプション。 |
共用体フィールド
|
|
partitionDefinition |
省略可。マネージド パーティション分割テーブル、Hive パーティション分割テーブル、Iceberg パーティション分割テーブル、Metastore パーティション分割テーブルなど、すべてのテーブル形式のパーティション情報。このフィールドは、メタストアのパーティション分割テーブルに対してのみ入力されます。他のテーブル形式の場合、これは出力専用のフィールドです。 |
| JSON 表現 |
|---|
{ "projectId": string, "datasetId": string, "tableId": string, "projectIdAlternative": [ string ], "datasetIdAlternative": [ string ], "tableIdAlternative": [ string ] } |
| フィールド | |
|---|---|
projectId |
必須。このテーブルを含むプロジェクトの ID。 |
datasetId |
必須。このテーブルを含むデータセットの ID。 |
tableId |
必須。テーブルの ID。ID には、カテゴリ L(文字)、M(マーク)、N(数字)、Pc(コネクタ、アンダースコアを含む)、Pd(ダッシュ)、Zs(スペース)の Unicode 文字を使用できます。詳しくは、一般カテゴリをご覧ください。最大文字数は 1,024 文字です。特定のオペレーションでは、 |
projectIdAlternative[] |
このフィールドは使用しないでください。 |
datasetIdAlternative[] |
このフィールドは使用しないでください。 |
tableIdAlternative[] |
このフィールドは使用しないでください。 |
| JSON 表現 |
|---|
{ "value": string } |
| フィールド | |
|---|---|
value |
文字列値。 |
| JSON 表現 |
|---|
{ "key": string, "value": string } |
| フィールド | |
|---|---|
key |
|
value |
|
| JSON 表現 |
|---|
{ "fields": [ { object ( |
| フィールド | |
|---|---|
fields[] |
テーブルのフィールドを記述します。 |
foreignTypeInfo |
省略可。フィールド スキーマ( |
| JSON 表現 |
|---|
{ "name": string, "type": string, "mode": string, "fields": [ { object ( |
| フィールド | |
|---|---|
name |
必須。フィールド名。名前には、英字(a ~ z、A ~ Z)、数字(0 ~ 9)、アンダースコア(_)のみを使用できます。先頭文字は英字またはアンダースコアにする必要があります。最大文字数は 300 文字です。 |
type |
必須。フィールドのデータ型。値は次のとおりです。
RECORD/STRUCT を使用すると、フィールドにネストされたスキーマが含まれていることを示します。 |
mode |
省略可。フィールド モード。可能な値は、NULLABLE、REQUIRED、REPEATED です。デフォルト値は NULLABLE です。 |
fields[] |
省略可。type プロパティが RECORD に設定されている場合、ネストされたスキーマ フィールドを記述します。 |
description |
省略可。フィールドの説明。最大長は 1,024 文字です。 |
policyTags |
省略可。フィールド レベルのアクセス制御に使用される、このフィールドに付加されたポリシータグ。設定しない場合、デフォルトは空の policy_tags になります。 |
dataPolicies[] |
省略可。このフィールドに適用されるデータポリシー。フィールド レベルのアクセス制御に使用されます。 |
nameAlternative[] |
このフィールドは使用しないでください。 |
maxLength |
省略可。STRING または BYTES のこのフィールドの値の最大長。 max_length が指定されていない場合、このフィールドに最大長の制約は課されません。 type = "STRING" の場合、max_length はこのフィールドの文字列の最大 UTF-8 長を表します。 type = "BYTES" の場合、max_length はこのフィールドの最大バイト数を表します。 type が「STRING」でも「BYTES」でもない場合、このフィールドを設定することは無効です。 |
precision |
省略可。NUMERIC または BIGNUMERIC のこのフィールドの値の精度(10 進数の合計桁数の最大値)とスケール(10 進数の小数部の桁数の最大値)の制約。 type ≠ 「NUMERIC」かつ ≠ 「BIGNUMERIC」の場合、精度またはスケールを設定することは無効です。 精度とスケールが指定されていない場合、値が型で許可されている限り、このフィールドに値の範囲の制約は課されません。 この NUMERIC フィールドまたは BIGNUMERIC フィールドの値は、次の条件を満たす場合にこの範囲内である必要があります。
精度とスケールの両方が指定されている場合に許容される値は次のとおりです。
精度のみが指定され、スケールが指定されていない(したがって、スケールは 0 と解釈される)場合の精度の許容値:
スケールは指定されているが精度が指定されていない場合は無効です。 |
scale |
省略可。精度については、ドキュメントをご覧ください。 |
timestampPrecision |
省略可。TIMESTAMP 型の秒の精度(10 進数の合計桁数の最大値)。 有効な値は次のとおりです。* 6(デフォルト、マイクロ秒精度の TIMESTAMP 型の場合)* 12(ピコ秒精度の TIMESTAMP 型の場合) |
roundingMode |
省略可。NUMERIC 型と BIGNUMERIC 型の値を保存するときに使用する丸めモードを指定します。 |
collation |
省略可。フィールド照合順序は、フィールドのタイプが STRING の場合にのみ設定できます。次の値を使用できます。
|
defaultValueExpression |
省略可。このフィールドのデフォルト値を指定する SQL 式。 |
rangeElementType |
省略可。このフィールドのタイプが RANGE の場合、RANGE のサブタイプ。タイプが RANGE の場合、このフィールドは必須です。フィールド要素のタイプの値は次のいずれかになります。
|
foreignTypeDefinition |
省略可。外部データ型の定義。最上位のスキーマ フィールド(ネストされたフィールドではない)でのみ有効です。タイプが FOREIGN の場合、このフィールドは必須です。 |
| JSON 表現 |
|---|
{ "names": [ string ] } |
| フィールド | |
|---|---|
names[] |
ポリシータグのリソース名のリスト。例: 「projects/1/locations/eu/taxonomies/2/policyTags/3」。現在、指定できるポリシータグは 1 つまでです。 |
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド
|
|
name |
データポリシーのリソース名。形式は projects/project_id/locations/location_id/dataPolicies/data_policy_id です。 |
| JSON 表現 |
|---|
{ "value": string } |
| フィールド | |
|---|---|
value |
int64 値。 |
| JSON 表現 |
|---|
{ "type": string } |
| フィールド | |
|---|---|
type |
必須。フィールド要素の型。詳しくは、 |
| JSON 表現 |
|---|
{
"typeSystem": enum ( |
| フィールド | |
|---|---|
typeSystem |
必須。外部データ型を定義するシステムを指定します。 |
| JSON 表現 |
|---|
{ "type": string, "expirationMs": string, "field": string, "requirePartitionFilter": boolean } |
| フィールド | |
|---|---|
type |
必須。サポートされているタイプは DAY、HOUR、MONTH、YEAR です。それぞれ、日単位、時間単位、月単位、年単位で 1 つずつパーティションが生成されます。 |
expirationMs |
省略可。パーティションのストレージを保持する時間(ミリ秒)。ここでは 0 が無効な値であるため、ラッパーが使用されています。 |
field |
省略可。設定されていない場合、テーブルは疑似列「_PARTITIONTIME」でパーティショニングされます。設定されている場合、テーブルはこのフィールドでパーティショニングされます。このフィールドは、トップレベルの TIMESTAMP フィールドまたは DATE フィールドである必要があります。モードは NULLABLE または REQUIRED である必要があります。ここでは、空の文字列は無効な値であるため、ラッパーが使用されています。 |
requirePartitionFilter |
true に設定すると、このテーブルに対するクエリでは、パーティションの除外に使用できるパーティション フィルタを指定する必要があります。このフィールドは非推奨です。代わりに、テーブル自体で同じ名前のフィールドを設定してください。このフィールドには、ユーザーが明示的に設定した場合にデフォルト値の false を出力するために、ラッパーが必要です。 |
| JSON 表現 |
|---|
{ "value": boolean } |
| フィールド | |
|---|---|
value |
ブール値。 |
| JSON 表現 |
|---|
{
"field": string,
"range": {
object ( |
| フィールド | |
|---|---|
field |
必須。テーブルをパーティショニングする列の名前。最上位の INT64 列で、モードが NULLABLE または REQUIRED である必要があります。 |
range |
範囲パーティショニングの範囲を定義します。 |
| JSON 表現 |
|---|
{ "start": string, "end": string, "interval": string } |
| フィールド | |
|---|---|
start |
必須。範囲パーティショニングの開始値(この値を含む)。このフィールドは、文字列として表される INT64 値です。 |
end |
必須。範囲パーティショニングの終了値(この値を含まない)。このフィールドは、文字列として表される INT64 値です。 |
interval |
必須。各間隔の幅。このフィールドは、文字列として表される INT64 値です。 |
| JSON 表現 |
|---|
{ "fields": [ string ] } |
| フィールド | |
|---|---|
fields[] |
データをクラスタリングする 1 つ以上のフィールド。最上位の非繰り返し型の単純型フィールドのみがサポートされています。クラスタリング フィールドの順序は、フィルタリングの目的で最も重要なものから最も重要でないものまで優先順位を付ける必要があります。 詳細については、クラスタ化テーブルの概要をご覧ください。 |
| JSON 表現 |
|---|
{
"partitionedColumn": [
{
object ( |
| フィールド | |
|---|---|
partitionedColumn[] |
省略可。各パーティショニング列の詳細。このフィールドは、メタストア パーティション分割テーブル以外のすべてのパーティショニング タイプで出力専用です。BigQuery ネイティブ テーブルは、1 つのパーティショニング列のみをサポートします。他のテーブルタイプでは、0 個以上のパーティショニング列がサポートされる場合があります。メタストアのパーティション分割テーブルの場合、順序は Hive Metastore の定義順序と一致している必要があります。ここで、テーブルの物理レイアウトと一致している必要があります。たとえば CREATE TABLE a_table(id BIGINT, name STRING) PARTITIONED BY (city STRING, state STRING). この場合、値は ['city', 'state'] の順序で指定する必要があります。 |
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド
|
|
field |
必須。パーティション列の名前。 |
| JSON 表現 |
|---|
{ "value": string } |
| フィールド | |
|---|---|
value |
uint64 値。 |
| JSON 表現 |
|---|
{ "query": string, "userDefinedFunctionResources": [ { object ( |
| フィールド | |
|---|---|
query |
必須。ビューが参照されたときに BigQuery が実行するクエリ。 |
userDefinedFunctionResources[] |
クエリで使用されるユーザー定義関数リソースについて説明します。 |
useLegacySql |
このビューに BigQuery のレガシー SQL を使用するかどうかを指定します。デフォルト値は true です。false に設定すると、ビューは BigQuery の GoogleSQL(https://cloud.google.com/bigquery/sql-reference/)を使用します。 このビューを参照するクエリとビューは、同じフラグ値を使用する必要があります。デフォルト値が True であるため、ここではラッパーが使用されています。 |
useExplicitColumnNames |
列名が明示的に指定されている場合は true。たとえば、'CREATE VIEW v(c1, c2) AS ...' 構文を使用します。GoogleSQL ビューにのみ設定できます。 |
privacyPolicy |
省略可。ビューのプライバシー ポリシーを指定します。 |
foreignDefinitions[] |
省略可。外部ビューの表現。 |
| JSON 表現 |
|---|
{ "resourceUri": string, "inlineCode": string, "inlineCodeAlternative": [ string ] } |
| フィールド | |
|---|---|
resourceUri |
[いずれか 1 つを選択] Google Cloud Storage URI(gs://bucket/path)から読み込むコードリソース。 |
inlineCode |
[いずれか 1 つを選択] ユーザー定義関数(UDF)のコードが含まれたインライン リソース。インライン コードリソースを指定することは、同じコードを含むファイルの URI を指定することと同じです。 |
inlineCodeAlternative[] |
|
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド privacy_policy。この要件仕様に関連付けられたプライバシー ポリシー。データソース オブジェクトごとに許可されるプライバシー メソッドは 1 つのみです。privacy_policy は次のいずれかになります。 |
|
aggregationThresholdPolicy |
省略可。集計しきい値に使用されるポリシー。 |
differentialPrivacyPolicy |
省略可。差分プライバシーに使用されるポリシー。 |
共用体フィールド
|
|
joinRestrictionPolicy |
省略可。結合制限ポリシーは、他のポリシーとともに設定できるため、ポリシーの 1 つではありません。このポリシーにより、データ プロバイダは、プライバシー保護ビューからデータがクエリされたときに、join_allowed_columns で結合を適用できます。 |
| JSON 表現 |
|---|
{ "privacyUnitColumns": [ string ], // Union field |
| フィールド | |
|---|---|
privacyUnitColumns[] |
省略可。このポリシーに関連付けられているプライバシー ユニット列。現時点では、データソース オブジェクト(テーブル、ビュー)ごとに 1 つの列のみをプライバシー ユニット列として使用できます。将来的に複数の列に拡張できるように、メタデータで繰り返しフィールドとして表します。重複する構造体フィールドは使用できません。ネストされたフィールドにはドット表記(「outer.inner」)を使用します。 |
共用体フィールド
|
|
threshold |
省略可。「集計しきい値」ポリシーのしきい値。 |
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド
|
|
maxEpsilonPerQuery |
省略可。クエリが消費できる最大イプシロン値。サブスクライバーが SELECT クエリでイプシロンをパラメータとして指定する場合、この値以下にする必要があります。イプシロン パラメータは、グループに追加されるノイズの量を制御します。イプシロンが大きいほど、ノイズが少なくなります。 |
共用体フィールド
|
|
deltaPerQuery |
省略可。クエリごとに使用されるデルタ値。デルタは、いずれかの行がイプシロン差分プライベートにならない確率を表します。クエリの結果で集計行を公開することに関連するリスクを示します。 |
共用体フィールド
|
|
maxGroupsContributed |
省略可。クエリごとに使用されるグループの最大貢献値。各保護エンティティが関係するグループの最大数を表します。この値を変更しても、プライバシーが強化されたり、低下したりすることはありません。精度と有用性の最適な値は、クエリとデータによって異なります。 |
共用体フィールド
|
|
privacyUnitColumn |
省略可。このポリシーに関連付けられたプライバシー ユニット列。差分プライバシー ポリシーでは、データソース オブジェクト(テーブル、ビュー)ごとにプライバシー ユニット列を 1 つだけ指定できます。 |
共用体フィールド
|
|
epsilonBudget |
省略可。プライバシー保護ビューに対するすべてのクエリのイプシロン予算の合計。このビューに対する各サブスクライバー クエリでは、クエリでリクエストされたイプシロンの量が課金されます。十分な予算がある場合、サブスクライバー クエリは完了を試みます。他の理由で失敗する可能性もあります。その場合は、請求は払い戻されます。予算が不足している場合、クエリは拒否されます。1 つのクエリが複数のビューを参照している場合、複数の課金試行が行われることがあります。この場合、すべての請求に十分な予算が必要です。予算が不足している場合は、クエリが拒否され、請求はベスト エフォートで払い戻されます。予算には更新ポリシーがなく、ALTER VIEW でのみ更新できます。または、新しい予算でクエリできる新しいビューを作成することで回避できます。 |
共用体フィールド
|
|
deltaBudget |
省略可。プライバシー保護ビューに対するすべてのクエリのデルタ予算の合計。このビューに対する各サブスクライバー クエリでは、プライバシー ポリシーの delta_per_query フィールドでコントリビューターによって事前に定義されたデルタの金額が請求されます。十分な予算がある場合、サブスクライバー クエリは完了を試みます。他の理由で失敗する可能性もあります。その場合は、請求は払い戻されます。予算が不足している場合、クエリは拒否されます。1 つのクエリが複数のビューを参照している場合、複数の課金試行が行われることがあります。この場合、すべての請求に十分な予算が必要です。予算が不足している場合は、クエリが拒否され、請求はベスト エフォートで払い戻されます。予算には更新ポリシーがなく、ALTER VIEW でのみ更新できます。または、新しい予算でクエリできる新しいビューを作成することで回避できます。 |
共用体フィールド
|
|
epsilonBudgetRemaining |
出力専用。残りのイプシロン予算。予算がなくなると、クエリは許可されなくなります。進行中のクエリの予算は、クエリの実行前に差し引かれます。クエリが失敗またはキャンセルされた場合、予算は払い戻されます。この場合、残りの予算額が増えることがあります。 |
共用体フィールド
|
|
deltaBudgetRemaining |
出力専用。残りのデルタ予算。予算がなくなると、クエリは許可されなくなります。進行中のクエリの予算は、クエリの実行前に差し引かれます。クエリが失敗またはキャンセルされた場合、予算は払い戻されます。この場合、残りの予算額が増えることがあります。 |
| JSON 表現 |
|---|
{ "joinAllowedColumns": [ string ], // Union field |
| フィールド | |
|---|---|
joinAllowedColumns[] |
省略可。結合が許可されているのは、次の列のみです。このフィールドは、join_conditions JOIN_ANY と JOIN_ALL で指定する必要があります。JOIN_BLOCKED に設定することはできません。 |
共用体フィールド
|
|
joinCondition |
省略可。ビューのクエリで結合が必要かどうかを指定します。デフォルトは JOIN_CONDITION_UNSPECIFIED です。 |
| JSON 表現 |
|---|
{ "query": string, "dialect": string } |
| フィールド | |
|---|---|
query |
必須。ビューを定義するクエリ。 |
dialect |
省略可。クエリの言語を表します。 |
| JSON 表現 |
|---|
{ "query": string, "lastRefreshTime": string, "enableRefresh": boolean, "refreshIntervalMs": string, "allowNonIncrementalDefinition": boolean } |
| フィールド | |
|---|---|
query |
必須。結果が永続化されるクエリ。 |
lastRefreshTime |
出力専用。このマテリアライズド ビューが最後に更新された時刻(エポックからのミリ秒単位)。 |
enableRefresh |
省略可。ベーステーブルが更新されたときにマテリアライズド ビューの自動更新を有効にします。デフォルト値は「true」です。 |
refreshIntervalMs |
省略可。このマテリアライズド ビューが更新される最大頻度。デフォルト値は「1800000」(30 分)です。 |
allowNonIncrementalDefinition |
省略可。このオプションは、増分更新されないマテリアライズド ビューを作成する意図を宣言します。非増分マテリアライズド ビューは、拡張された範囲の SQL クエリをサポートしています。マテリアライズド ビューの作成後に |
| JSON 表現 |
|---|
{
"refreshWatermark": string,
"lastRefreshStatus": {
object ( |
| フィールド | |
|---|---|
refreshWatermark |
出力専用。マテリアライズド ビューの更新ウォーターマーク。この時点まで、ベーステーブルのデータがマテリアライズド ビューのキャッシュに収集されました。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
lastRefreshStatus |
出力専用。最後の自動更新のエラー結果。これが存在する場合は、最後の自動更新が失敗したことを示します。 |
| JSON 表現 |
|---|
{ "seconds": string, "nanos": integer } |
| フィールド | |
|---|---|
seconds |
UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800 ~ 253402300799 の範囲(両端を含む)にする必要があります(これは 0001-01-01T00:00:00Z ~ 9999-12-31T23:59:59Z に対応します)。 |
nanos |
ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは期間のナノ秒部分であり、秒の代替ではありません。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0 ~ 999,999,999 の範囲(境界を含む)になります。 |
| JSON 表現 |
|---|
{ "reason": string, "location": string, "debugInfo": string, "message": string } |
| フィールド | |
|---|---|
reason |
エラーを要約した短いエラーコード。 |
location |
エラーが発生した場合に、その発生場所を示します。 |
debugInfo |
デバッグ情報。このプロパティは Google 内部で使用されるものであり、使用しないでください。 |
message |
エラーの説明(人が読める形式)。 |
| JSON 表現 |
|---|
{ "sourceUris": [ string ], "fileSetSpecType": enum ( |
| フィールド | |
|---|---|
sourceUris[] |
[必須] Google Cloud のデータを指す完全修飾 URI。Google Cloud Storage URI の場合: 各 URI に '*' ワイルドカード文字を 1 つ含めることができますが、バケット名の後に付ける必要があります。読み込みジョブに関連するサイズ上限は、外部データソースに適用されます。Google Cloud Bigtable URI の場合: 指定できる URI は 1 つだけです。これは、Google Cloud Bigtable テーブルに対する完全かつ有効な HTTPS URL でなければなりません。Google Cloud Datastore のバックアップで指定できる URI は 1 つだけです。また、ワイルドカード文字「*」は使用できません。 |
fileSetSpecType |
省略可。読み込むファイルセットを構築するためのソース URI の解釈方法を指定します。デフォルトでは、ソース URI は基盤となるストレージに対して展開されます。マニフェスト ファイルを指定するなどのオプションもあります。オブジェクト ストレージ システムにのみ適用されます。 |
schema |
省略可。データのスキーマ。自動検出がオンになっていない場合、CSV 形式と JSON 形式にはスキーマが必要です。Google Cloud Bigtable、Cloud Datastore バックアップ、Avro、ORC、Parquet 形式ではスキーマは許可されません。 |
sourceFormat |
[必須] データ形式。CSV ファイルの場合は、「CSV」を指定します。Google スプレッドシートの場合は、「GOOGLE_SHEETS」を指定します。改行区切りの JSON の場合は、「NEWLINE_DELIMITED_JSON」を指定します。Avro ファイルの場合は、「AVRO」を指定します。Google Cloud Datastore バックアップの場合は、「DATASTORE_BACKUP」を指定します。Apache Iceberg テーブルの場合は、「ICEBERG」を指定します。ORC ファイルの場合は、「ORC」を指定します。Parquet ファイルの場合は、「PARQUET」を指定します。[ベータ版] Google Cloud Bigtable の場合は、「BIGTABLE」を指定します。 |
maxBadRecords |
省略可。BigQuery がデータの読み取り時に無視できる不良レコードの最大数。不良レコードの数がこの値を超えると、ジョブ結果で「無効」エラーが返されます。デフォルト値は 0 で、すべてのレコードが有効である必要があります。この設定は、Google Cloud Bigtable、Google Cloud Datastore バックアップ、Avro、ORC、Parquet 形式では無視されます。 |
autodetect |
スキーマと形式のオプションを自動的に検出しようとします。明示的に指定されたオプションは優先されます。 |
ignoreUnknownValues |
省略可。テーブル スキーマで示されていない余分な値を許可するかどうかを指定します。true の場合、余分な値は無視されます。false の場合、余分な列を含むレコードは不良レコードとして処理され、不良レコードが多すぎる場合はジョブの結果内で無効なエラーが返されます。デフォルト値は false です。何が余分な値として扱われるかは、sourceFormat プロパティによって決まります。CSV: 末尾の列。JSON: 列名と一致しない名前付きの値。Google Cloud Bigtable: この設定は無視されます。Google Cloud Datastore のバックアップ: この設定は無視されます。Avro: この設定は無視されます。ORC: この設定は無視されます。Parquet: この設定は無視されます。 |
compression |
省略可。データソースの圧縮タイプ。有効な値は GZIP と NONE です。デフォルト値は NONE です。この設定は、Google Cloud Bigtable、Google Cloud Datastore バックアップ、Avro、ORC、Parquet 形式では無視されます。空の文字列は無効な値です。 |
csvOptions |
省略可。sourceFormat が CSV に設定されている場合に設定する追加のプロパティ。 |
jsonOptions |
省略可。sourceFormat が JSON に設定されている場合に設定する追加のプロパティ。 |
bigtableOptions |
省略可。sourceFormat が BIGTABLE に設定されている場合の追加オプション。 |
googleSheetsOptions |
省略可。sourceFormat が GOOGLE_SHEETS に設定されている場合の追加オプション。 |
maxBadRecordsAlternative[] |
このフィールドは使用しないでください。 |
hivePartitioningOptions |
省略可。設定すると、Hive パーティショニングのサポートが構成されます。すべてのストレージ形式が Hive パーティショニングをサポートしているわけではありません。サポートされていない形式で Hive パーティショニングをリクエストすると、無効な仕様が提供された場合と同様にエラーが発生します。 |
connectionId |
省略可。Azure Blob、Cloud Storage、S3 などの外部ストレージの読み取りに使用する認証情報を指定する接続。connection_id の形式は |
decimalTargetTypes[] |
ソースの 10 進数値を変換できる SQL データ型のリストを定義します。このリストと、10 進数フィールドの精度とスケールのパラメータによって、ターゲット型が決まります。型が指定されたリストに含まれていて、精度とスケールをサポートしている場合に、NUMERIC、BIGNUMERIC、STRING の順序で型が選択されます。STRING では、すべての精度とスケールの値がサポートされています。リストされた型のいずれも精度とスケールをサポートしていない場合は、指定されたリストで最も広い範囲をサポートする型が選択されます。データの読み取り時に値がサポートされている範囲を超えると、エラーがスローされます。 例: このフィールドの値が ["NUMERIC", "BIGNUMERIC"] の場合。(精度、スケール)が次の場合は:
このフィールドに重複する型を含めることはできません。このフィールドの型の順序は無視されます。たとえば、["BIGNUMERIC", "NUMERIC"] は ["NUMERIC", "BIGNUMERIC"] と同じです。NUMERIC は常に BIGNUMERIC よりも優先されます。 ORC ではデフォルトは ["NUMERIC", "STRING"]、その他のファイル形式では ["NUMERIC"] です。 |
avroOptions |
省略可。sourceFormat が AVRO に設定されている場合に設定する追加のプロパティ。 |
jsonExtension |
省略可。source_format の改行区切りの JSON とともに使用して、JSON のバリアントが読み込まれていることを示す読み込みオプション。改行区切りの GeoJSON を読み込むには、GEOJSON を指定します(source_format は NEWLINE_DELIMITED_JSON に設定する必要があります)。 |
parquetOptions |
省略可。sourceFormat が PARQUET に設定されている場合に設定する追加のプロパティ。 |
referenceFileSchemaUri |
省略可。外部テーブルを作成するときに、テーブル スキーマを含む参照ファイルを指定できます。これは、AVRO、PARQUET、ORC の形式で有効になります。 |
metadataCacheMode |
省略可。テーブルのメタデータ キャッシュ モード。外部データソースからのメタデータのキャッシュ保存を有効にするには、この値を設定します。 |
timestampTargetPrecision[] |
自動検出モードで宛先テーブルに許可される TIMESTAMP 型の秒の精度(10 進数の合計桁数の最大値)。 利用可能な形式: CSV。 CSV 形式の場合、指定可能な値は次のとおりです。Not Specified、[]、[6]: 自動検出されたすべての TIMESTAMP 列の timestamp(6)。[6, 12]: 6 桁未満のサブ秒を持つ自動検出されたすべての TIMESTAMP 列の timestamp(6)。6 桁を超えるサブ秒を含む自動検出されたすべての TIMESTAMP 列の timestamp(12)。[12]: 自動検出されたすべての TIMESTAMP 列の timestamp(12)。 この配列内の要素の順序は無視されます。この配列の最大目標精度よりも高い精度を持つ入力は切り捨てられます。 |
共用体フィールド
|
|
objectMetadata |
省略可。ObjectMetadata は、オブジェクト テーブルの作成に使用されます。オブジェクト テーブルには、source_uris にあるオブジェクト(メタデータを含む)のリストが含まれます。ObjectMetadata が設定されている場合は、source_format を省略する必要があります。 現在、サポートされているオブジェクト メタデータ タイプは SIMPLE のみです。 |
共用体フィールド
|
|
timeZone |
省略可。特定のタイムゾーン情報(2024-04-20 12:34:56 など)がないタイムスタンプ値を解析するときに使用されるタイムゾーン。想定される形式は IANA タイムゾーン文字列(例: America/Los_Angeles)です。 |
共用体フィールド
|
|
dateFormat |
省略可。DATE 値の解析に使用される形式。C スタイルと SQL スタイルの値をサポートします。 |
共用体フィールド
|
|
datetimeFormat |
省略可。DATETIME 値の解析に使用される形式。C スタイルと SQL スタイルの値をサポートします。 |
共用体フィールド
|
|
timeFormat |
省略可。TIME 値の解析に使用される形式。C スタイルと SQL スタイルの値をサポートします。 |
共用体フィールド
|
|
timestampFormat |
省略可。TIMESTAMP 値の解析に使用される形式。C スタイルと SQL スタイルの値をサポートします。 |
| JSON 表現 |
|---|
{ "value": integer } |
| フィールド | |
|---|---|
value |
int32 値。 |
| JSON 表現 |
|---|
{ "fieldDelimiter": string, "skipLeadingRows": string, "quote": string, "allowQuotedNewlines": boolean, "allowJaggedRows": boolean, "encoding": string, "preserveAsciiControlCharacters": boolean, "nullMarker": string, "nullMarkers": [ string ], "sourceColumnMatch": string } |
| フィールド | |
|---|---|
fieldDelimiter |
省略可。CSV ファイル内のフィールド区切り文字。区切り文字は単一バイトとして解釈されます。ISO-8859-1 でエンコードされたファイルの場合、任意の 1 文字を区切り文字として使用できます。UTF-8 でエンコードされたファイルの場合、10 進数の範囲 1 ~ 127(U+0001 ~ U+007F)で表される文字は変更せずに使用できます。複数バイトでエンコードされた UTF-8 文字(U+0080 以上)では、フィールドの区切り文字として最初のバイトのみが使用されます。残りのバイトはフィールドの一部として扱われます。また、BigQuery はタブ区切りを示すエスケープ シーケンス「\t」(U+0009)もサポートしています。デフォルト値はカンマ(「,」、U+002C)です。 |
skipLeadingRows |
省略可。BigQuery がデータを読み取る際にスキップする CSV ファイルの先頭行の数。デフォルト値は 0 です。このプロパティは、スキップする必要があるヘッダー行がファイルに含まれている場合に便利です。自動検出がオンの場合の動作は次のとおりです。
|
quote |
省略可。CSV ファイル内のデータ セクションを囲む引用符として使用される値。BigQuery は文字列を ISO-8859-1 エンコードに変換し、エンコードされた文字列の先頭バイトを使用してデータを未加工のバイナリ状態で分割します。デフォルト値は二重引用符(")です。データに引用符で囲まれたセクションが含まれていない場合は、このプロパティの値を空の文字列に設定します。データに引用符で囲まれた改行文字が含まれている場合は、allowQuotedNewlines プロパティの値を true に設定する必要もあります。引用符で囲まれた値の中に特定の引用符を含めるには、その前に引用符を追加します。たとえば、デフォルトの「"」をエスケープするには、「""」を使用します。 |
allowQuotedNewlines |
省略可。BigQuery で、改行文字を含む引用符で囲まれたデータ セクションを CSV ファイルで許可するかどうかを示します。デフォルト値は false です。 |
allowJaggedRows |
省略可。末尾のオプションの列が欠落している行を BigQuery で受け入れるかどうかを指定します。true の場合、BigQuery は末尾の欠落した列を null 値として扱います。false の場合、末尾の列が欠落しているレコードは不良レコードとして処理され、不良レコードが多すぎる場合はジョブの結果内で無効なエラーが返されます。デフォルト値は false です。 |
encoding |
省略可。データの文字エンコード。サポートされている値は UTF-8、ISO-8859-1、UTF-16BE、UTF-16LE、UTF-32BE、UTF-32LE です。デフォルト値は UTF-8 です。BigQuery は、quote プロパティと fieldDelimiter プロパティの値を使用して未加工のバイナリデータを分割してからデータをデコードします。 |
preserveAsciiControlCharacters |
省略可。埋め込みの ASCII 制御文字(ASCII テーブルの最初の 32 文字、「\x00」から「\x1F」まで)が保持されるかどうかを示します。 |
nullMarker |
省略可。CSV ファイル内で null 値を表す文字列を指定します。たとえば、「\N」を指定すると、BigQuery は CSV ファイルのクエリ時に「\N」を null 値として解釈します。デフォルト値は空の文字列です。このプロパティにカスタム値を設定すると、STRING と BYTE を除くすべてのデータ型で、空の文字列がある場合にエラーがスローされます。STRING 列と BYTE 列では、空の文字列は空の値として解釈されます。 |
nullMarkers[] |
省略可。CSV ファイルで SQL NULL 値として表される文字列のリスト。 null_marker と null_markers を同時に設定することはできません。null_marker が設定されている場合、null_markers は設定できません。null_markers が設定されている場合、null_marker は設定されていません。null_marker と null_markers の両方が同時に設定されている場合は、ユーザー エラーがスローされます。null_markers にリストされている文字列(空の文字列を含む)は、SQL NULL として解釈されます。これはすべての列の型に適用されます。 |
sourceColumnMatch |
省略可。読み込んだ列をスキーマにマッチングするために使用する戦略を制御します。設定されていない場合、スキーマの提供方法に基づいて適切なデフォルトが選択されます。自動検出を使用すると、列は名前で照合されます。それ以外の場合、列は位置で照合されます。これは、動作の下位互換性を維持するために行われます。有効な値は POSITION(位置で照合)です。このオプションでは、列がスキーマと同じ順序で並んでいることを前提としています。NAME - 名前で照合します。ヘッダー行を列名として読み取り、スキーマのフィールド名と一致するように列の順序を変更します。 |
| JSON 表現 |
|---|
{ "encoding": string } |
| フィールド | |
|---|---|
encoding |
省略可。データの文字エンコード。サポートされている値は UTF-8、UTF-16BE、UTF-16LE、UTF-32BE、UTF-32LE です。デフォルト値は UTF-8 です。 |
| JSON 表現 |
|---|
{
"columnFamilies": [
{
object ( |
| フィールド | |
|---|---|
columnFamilies[] |
省略可。テーブル スキーマで公開する列ファミリーのリストとその型。このリストにより、クエリで参照可能な列ファミリーが制限され、値の型が指定されます。このリストを使用して型変換を行うことができます。詳しくは、「type」フィールドをご覧ください。このリストを空のままにした場合、すべての列ファミリーがテーブル スキーマに存在し、それらの値が BYTES として読み取られます。クエリの実行中、そのクエリで参照されている列ファミリーのみが Bigtable から読み取られます。 |
ignoreUnspecifiedColumnFamilies |
省略可。フィールドが true の場合、columnFamilies リストで指定されていない列ファミリーはテーブル スキーマに公開されません。それ以外の場合、rowkey 列ファミリーは BYTES 型の値として読み取られます。デフォルト値は false です。 |
readRowkeyAsString |
省略可。フィールドが true の場合、rowkey 列ファミリーが読み取られ、文字列に変換されます。それ以外の場合、rowkey 列ファミリーは BYTES 型の値として読み取られます。必要に応じて、ユーザーは CAST を使用して手動でキャストする必要があります。デフォルト値は false です。 |
outputColumnFamiliesAsJson |
省略可。フィールドが true の場合、各列ファミリーは単一の JSON 列として読み取られます。それ以外の場合、タイムスタンプと値のタプルを含む繰り返しセル構造として読み取られます。デフォルト値は false です。 |
| JSON 表現 |
|---|
{ "familyId": string, "type": string, "encoding": string, "columns": [ { object ( |
| フィールド | |
|---|---|
familyId |
列ファミリーの識別子。 |
type |
省略可。この列ファミリーのセルの値を変換する型。BINARY エンコード値を使用する場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。次の BigQuery 型を使用できます(大文字と小文字が区別されます)。
デフォルトのタイプは BYTES です。これは、[columns] に列を一覧表示して、型を指定することによって、特定の列に対してオーバーライドできます。 |
encoding |
省略可。型が STRING でない場合の値のエンコード。使用できるエンコード値は次のとおりです。TEXT - 値が英数字のテキスト文字列であることを示します。BINARY - 値が HBase Bytes.toBytes ファミリーの関数を使用してエンコードされていることを示します。PROTO_BINARY - 値がシリアル化されたプロト メッセージを使用してエンコードされていることを示します。これは、JSON 型と組み合わせてのみ使用できます。これは、[columns] に列を一覧表示して、エンコードを指定することによって、特定の列に対してオーバーライドできます。 |
columns[] |
省略可。(列名、値)ペアのリストではなく、個々のフィールドとして公開する必要がある列のリスト。修飾子がこのリスト内の修飾子と一致するすべての列は、 |
onlyReadLatest |
省略可。この設定を行うと、この列ファミリーのすべての列で値の最新バージョンのみが公開されます。これは、'columns' に列を一覧表示して、その列に別の設定を指定することによって、特定の列に対してオーバーライドできます。 |
protoConfig |
省略可。Protobuf 固有の構成。エンコードが PROTO_BINARY の場合にのみ有効になります。 |
| JSON 表現 |
|---|
{
"qualifierEncoded": string,
"qualifierString": string,
"fieldName": string,
"type": string,
"encoding": string,
"onlyReadLatest": boolean,
"protoConfig": {
object ( |
| フィールド | |
|---|---|
qualifierEncoded |
[必須] 列の修飾子。この修飾子と完全に一致する親列ファミリーの列は、 |
qualifierString |
修飾子文字列。 |
fieldName |
省略可。修飾子が有効な BigQuery フィールド識別子([a-zA-Z][a-zA-Z0-9_]* と一致しない)でない場合、有効な識別子を列フィールド名として指定する必要があります。これはクエリでフィールド名として使用されます。 |
type |
省略可。この列のセルの値を変換する型。BINARY エンコード値を使用する場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。次の BigQuery 型を使用できます(大文字と小文字が区別されます)。
デフォルトのタイプは BYTES です。'type' は列ファミリー レベルで設定することもできます。ただし、両方のレベルで「type」が設定されている場合は、このレベルの設定が優先されます。 |
encoding |
省略可。型が STRING でない場合の値のエンコード。使用できるエンコード値は次のとおりです。TEXT - 値が英数字のテキスト文字列であることを示します。BINARY - 値が HBase Bytes.toBytes ファミリーの関数を使用してエンコードされていることを示します。PROTO_BINARY - 値がシリアル化されたプロト メッセージを使用してエンコードされていることを示します。これは、JSON 型と組み合わせてのみ使用できます。'encoding' は列ファミリー レベルで設定することもできます。ただし、両方のレベルで「encoding」が設定されている場合は、このレベルの設定が優先されます。 |
onlyReadLatest |
省略可。この設定を行うと、この列の最新バージョンの値のみが公開されます。'onlyReadLatest' は列ファミリー レベルで設定することもできます。ただし、両方のレベルで「onlyReadLatest」が設定されている場合は、このレベルの設定が優先されます。 |
protoConfig |
省略可。Protobuf 固有の構成。エンコードが PROTO_BINARY の場合にのみ有効になります。 |
| JSON 表現 |
|---|
{ "value": string } |
| フィールド | |
|---|---|
value |
バイト値。 Base64 でエンコードされた文字列。 |
| JSON 表現 |
|---|
{ "schemaBundleId": string, "protoMessageName": string } |
| フィールド | |
|---|---|
schemaBundleId |
省略可。この protobuf に関連付けられている Bigtable SchemaBundle リソースの ID。ID は親テーブル内で参照する必要があります(例: |
protoMessageName |
省略可。protobuf の完全修飾 proto メッセージ名。「foo.bar.Message」形式。 |
| JSON 表現 |
|---|
{ "skipLeadingRows": string, "range": string } |
| フィールド | |
|---|---|
skipLeadingRows |
省略可。BigQuery がデータを読み取る際にスキップするシートの先頭行の数。デフォルト値は 0 です。このプロパティは、スキップする必要があるヘッダー行がある場合に便利です。自動検出がオンの場合、次のような動作になります。* skipLeadingRows が未指定 - 自動検出で最初の行のヘッダーの検出が試行されます。検出されない場合、行はデータとして読み取られます。それ以外の場合は、2 行目からデータが読み取られます。* skipLeadingRows が 0 - ヘッダーがなく、最初の行からデータを読み取る必要があることを自動検出に指示します。* skipLeadingRows = N > 0 - 自動検出では、N-1 行をスキップし、N 行のヘッダーを検出します。ヘッダーが検出されない場合、行 N はスキップされます。それ以外の場合は、行 N を使用して、検出されたスキーマの列名を抽出します。 |
range |
省略可。クエリの対象となるシートの範囲。空でない場合にのみ使用されます。一般的な形式: sheet_name!top_left_cell_id:bottom_right_cell_id 例: sheet1!A1:B20 |
| JSON 表現 |
|---|
{ "mode": string, "sourceUriPrefix": string, "requirePartitionFilter": boolean, "fields": [ string ] } |
| フィールド | |
|---|---|
mode |
省略可。設定されている場合、データを読み取るときに使用する Hive パーティショニングのモード。次のモードがサポートされています。
すべてのストレージ形式で Hive パーティショニングがサポートされているわけではありません。サポートされていない形式で Hive パーティショニングをリクエストすると、エラーが発生します。現在サポートされている形式は、JSON、CSV、ORC、Avro、Parquet です。 |
sourceUriPrefix |
省略可。Hive パーティションの検出がリクエストされた場合は、すべてのソース URI の共通プレフィックスが必要です。プレフィックスは、パーティション キーのエンコードが始まる直前で終わる必要があります。たとえば、次のデータ レイアウトに従ったファイルがあるとします。 gs://bucket/path_to_table/dt=2019-06-01/country=USA/id=7/file.avro gs://bucket/path_to_table/dt=2019-05-31/country=CA/id=3/file.avro AUTO または STRINGS 検出で Hive パーティショニングがリクエストされる場合、共通プレフィックスは gs://bucket/path_to_table または gs://bucket/path_to_table/ のいずれかになります。 CUSTOM 検出では、共通プレフィックスの直後にパーティショニング スキーマをエンコードする必要があります。CUSTOM の場合は、次のいずれか
は、すべて有効なソース URI 接頭辞になります。 |
requirePartitionFilter |
省略可。true に設定すると、このテーブルに対するクエリでは、パーティションの除外に使用できるパーティション フィルタを指定する必要があります。 このフィールドは、永続外部テーブルを作成する場合、または一時外部テーブルをクエリする場合にのみ true にする必要があります。 require_partition_filter が明示的に true に設定されている Hive パーティション分割ロードは失敗します。 |
fields[] |
出力専用。永続外部テーブルの場合、このフィールドには、推論された順序で Hive パーティション キーが入力されます。パーティション キーの型は、テーブル スキーマ(パーティション キーを含む)を確認することで推測できます。すべての API が出力でこのフィールドに入力するわけではありません。たとえば、Tables.Get はこのフィールドに入力しますが、Tables.List にはこのフィールドは含まれません。 |
| JSON 表現 |
|---|
{ "useAvroLogicalTypes": boolean } |
| フィールド | |
|---|---|
useAvroLogicalTypes |
省略可。sourceFormat が「AVRO」に設定されている場合、未加工の型(INTEGER など)を使用する代わりに、論理型を対応する BigQuery データ型(TIMESTAMP など)として解釈するかどうかを示します。 |
| JSON 表現 |
|---|
{
"enumAsString": boolean,
"enableListInference": boolean,
"mapTargetType": enum ( |
| フィールド | |
|---|---|
enumAsString |
省略可。Parquet ENUM 論理型をデフォルトで BYTES ではなく STRING として推測するかどうかを示します。 |
enableListInference |
省略可。Parquet LIST 論理型専用のスキーマ推定を使用するかどうかを示します。 |
mapTargetType |
省略可。Parquet マップが存在する場合の表現方法を示します。 |
| JSON 表現 |
|---|
{ "connectionId": string, "storageUri": string, "fileFormat": enum ( |
| フィールド | |
|---|---|
connectionId |
省略可。Cloud Storage などの外部ストレージへの読み取りと書き込みに使用する認証情報を指定する接続。connection_id の形式は、 |
storageUri |
省略可。テーブルデータが保存されている外部フォルダの完全修飾ロケーション接頭辞。ワイルドカード文字「*」は使用できません。URI は |
fileFormat |
省略可。テーブルデータが保存されるファイル形式。 |
tableFormat |
省略可。メタデータのみのスナップショットが保存されるテーブル形式。 |
| JSON 表現 |
|---|
{ "estimatedBytes": string, "estimatedRows": string, "oldestEntryTime": string } |
| フィールド | |
|---|---|
estimatedBytes |
出力専用。ストリーミング バッファに現在あるバイト数の下限見積もり。 |
estimatedRows |
出力専用。ストリーミング バッファに現在ある行数の下限の見積もり。 |
oldestEntryTime |
出力専用。ストリーミング バッファが使用可能な場合、ストリーミング バッファ内の最も古いエントリのタイムスタンプ(エポックからの経過時間、ミリ秒単位)が含まれます。 |
| JSON 表現 |
|---|
{ "kmsKeyName": string } |
| フィールド | |
|---|---|
kmsKeyName |
省略可。宛先 BigQuery テーブルの保護に使用される Cloud KMS 暗号鍵について説明します。プロジェクトに関連付けられている BigQuery サービス アカウントには、この暗号鍵へのアクセス権が必要です。 |
| JSON 表現 |
|---|
{
"baseTableReference": {
object ( |
| フィールド | |
|---|---|
baseTableReference |
必須。スナップショットが作成されたテーブルの ID を説明するリファレンス。 |
snapshotTime |
必須。ベーステーブルのスナップショットが作成された時刻。この値は、RFC3339 形式を使用して JSON レスポンスで報告されます。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
| JSON 表現 |
|---|
{
"baseTableReference": {
object ( |
| フィールド | |
|---|---|
baseTableReference |
必須。クローンされたテーブルの ID を説明するリファレンス。 |
cloneTime |
必須。ベーステーブルがクローンされた時刻。この値は、RFC3339 形式を使用して JSON レスポンスで報告されます。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
| JSON 表現 |
|---|
{
"type": enum ( |
| フィールド | |
|---|---|
type |
出力専用。データセット/テーブルの制限の種類を指定します。 |
| JSON 表現 |
|---|
{ "primaryKey": { object ( |
| フィールド | |
|---|---|
primaryKey |
省略可。テーブルの列に対する主キー制約を表します。テーブルに主キーがある場合にのみ表示されます。主キーは適用されません。 |
foreignKeys[] |
省略可。テーブルに外部キーがある場合にのみ表示されます。外部キーは適用されません。 |
| JSON 表現 |
|---|
{ "columns": [ string ] } |
| フィールド | |
|---|---|
columns[] |
必須。主キー制約で構成される列。 |
| JSON 表現 |
|---|
{ "name": string, "referencedTable": { object ( |
| フィールド | |
|---|---|
name |
省略可。外部キー制約に名前が付けられている場合にのみ設定します。 |
referencedTable |
必須。主キーを保持し、この外部キーで参照されるテーブル。 |
columnReferences[] |
必須。外部キーを構成する列。 |
| JSON 表現 |
|---|
{ "referencingColumn": string, "referencedColumn": string } |
| フィールド | |
|---|---|
referencingColumn |
必須。外部キーを構成する列。 |
referencedColumn |
必須。referencing_column によって参照される主キーの列。 |
| JSON 表現 |
|---|
{ "key": string, "value": string } |
| フィールド | |
|---|---|
key |
|
value |
|
| JSON 表現 |
|---|
{ "sourceTable": { object ( |
| フィールド | |
|---|---|
sourceTable |
必須。複製されるソーステーブル参照。 |
replicationIntervalMs |
省略可。ソーステーブルで更新をポーリングする間隔を指定します。省略可。指定しない場合は、デフォルトのレプリケーション間隔が適用されます。 |
replicatedSourceLastRefreshTime |
省略可。出力専用。ソースがマテリアライズド ビューの場合、このフィールドはソースの最終更新時刻を示します。 |
replicationStatus |
省略可。出力専用。構成されたレプリケーションのレプリケーション ステータス。 |
replicationError |
省略可。出力専用。テーブル レプリケーションが完全に停止するレプリケーション エラー。 |
| JSON 表現 |
|---|
{
"parameters": {
string: string,
...
},
"storageDescriptor": {
object ( |
| フィールド | |
|---|---|
parameters |
省略可。オープンソース テーブルのパラメータとプロパティを定義する Key-Value ペアのマップ。Hive メタストア テーブル パラメータに対応します。最大サイズは 4 MiB。
|
storageDescriptor |
省略可。このテーブルの物理ストレージに関する情報を含むストレージ記述子。 |
connectionId |
省略可。Azure Blob、Cloud Storage、Amazon S3 などの外部ストレージの読み取りに使用する認証情報を指定する接続 ID。この接続は、BigQuery からオープンソース テーブルを読み取るために必要です。connection_id の形式は |
| JSON 表現 |
|---|
{ "key": string, "value": string } |
| フィールド | |
|---|---|
key |
|
value |
|
| JSON 表現 |
|---|
{
"locationUri": string,
"inputFormat": string,
"outputFormat": string,
"serdeInfo": {
object ( |
| フィールド | |
|---|---|
locationUri |
省略可。テーブルの物理的な場所( |
inputFormat |
省略可。InputFormat の完全修飾クラス名(例: 「org.apache.hadoop.hive.ql.io.orc.OrcInputFormat」)を指定します。最大長は 128 文字です。 |
outputFormat |
省略可。OutputFormat の完全修飾クラス名(例: 「org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat」)を指定します。最大長は 128 文字です。 |
serdeInfo |
省略可。シリアライザとデシリアライザの情報。 |
| JSON 表現 |
|---|
{ "name": string, "serializationLibrary": string, "parameters": { string: string, ... } } |
| フィールド | |
|---|---|
name |
省略可。SerDe の名前。最大文字数は 256 文字です。 |
serializationLibrary |
必須。テーブル表現と基盤となる低レベルの入出力形式構造間のデータの変換を担当するシリアル化ライブラリの完全修飾クラス名を指定します。最大文字数は 256 文字です。 |
parameters |
省略可。シリアル化ライブラリの初期化パラメータを定義する Key-Value ペア。最大サイズは 10 Kib です。
|
| JSON 表現 |
|---|
{ "key": string, "value": string } |
| フィールド | |
|---|---|
key |
|
value |
|
ツールのアノテーション
破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌