Package google.firestore.v1

map<string, Value>

匯總函式的結果，例如 COUNT(*) AS total_docs。

鍵是指派給輸入匯總函式的 alias，而這個對應的大小等於查詢中的匯總函式數量。

Value

陣列中的值。

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{project_id}/databases/{database_id}。

string

要擷取的文件名稱。請採用下列格式：projects/{project_id}/databases/{database_id}/documents/{document_path}。如果文件有任何文件不是指定 database 的子項資源，要求就會失敗。系統會省略重複的名稱。

DocumentMask

要傳回的欄位。如未設定，則會傳回所有欄位。

如果文件含有不在這個遮罩中的欄位，回應中就不會傳回該欄位。

bytes

這個外掛程式能在交易中讀取文件。

TransactionOptions

開始新的交易並讀取文件。預設為唯讀交易。系統會傳回新的交易 ID，做為串流中的第一個回應。

Timestamp

讀取特定時間的文件。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

bytes

依此要求啟動的交易。只會在第一個回應中設定，且必須在要求中設定 BatchGetDocumentsRequest.new_transaction。

Timestamp

讀取文件的時間。這可能是單純增加的，在這種情況下，結果串流中的舊有文件保證在 read_time 和此檔案之間保持不變。

Document

要求的文件。

string

要求但不存在的文件名稱。請採用下列格式：projects/{project_id}/databases/{database_id}/documents/{document_path}。

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{project_id}/databases/{database_id}。

Write

要套用的寫入作業。

方法不會以不可分割的形式套用寫入，亦不保證排序。每項寫入作業成功或失敗。每次要求只能寫入同一份文件一次。

map<string, string>

與這個批次寫入作業相關聯的標籤。

WriteResult

套用寫入的結果。

這項 i-th 寫入結果與要求中的 i-th 寫入對應。

Status

套用寫入的狀態。

此 i-th 寫入狀態與要求中的 i-th 寫入對應。

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{project_id}/databases/{database_id}。

TransactionOptions

交易的選項。預設為讀寫交易。

bytes

啟動的交易。

bytes

為位元序列編碼的位元組。長度可能是 0。

int32

bitmap 中最後一個位元組要忽略為「邊框間距」的位元數。如果 bitmap 的長度為 0，這個值必須為 0。否則這個值必須介於 0 到 7 (含) 之間。

BitSequence

花卉篩選器資料。

int32

演算法使用的雜湊數量。

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{project_id}/databases/{database_id}。

Write

要套用的寫入作業。

一律以不可分割的形式，依序執行。

bytes

如果已設定，則會套用並修訂此交易中的所有寫入作業。

WriteResult

套用寫入的結果。

這項 i-th 寫入結果與要求中的 i-th 寫入對應。

Timestamp

修訂版本發生的時間。只要 read_time 等於或大於此值，就保證能看到修訂版本的效果。

string

執行個體類型，父項資源。例如 projects/{project_id}/databases/{database_id}/documents 或 projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

執行個體類型，要清單的集合 ID (相對於 parent)。例如：chatrooms。

string

要用於這份文件的用戶端指派文件 ID。

選用設定。如未指定，服務會指派 ID。

Document

執行個體類型，要建立的文件。無法設定「name」。

DocumentMask

要傳回的欄位。如未設定，則會傳回所有欄位。

如果文件的某個欄位不在這個遮罩中，則不會在回應中傳回該欄位。

Value

代表位置的值，按照查詢子句排序的順序排列。

可以包含的值數量少於使用子子句指定的順序。

bool

如果位置緊接在指定值之前或之後 (相對於查詢所定義的排序順序)。

string

執行個體類型，要刪除的文件的資源名稱。請採用下列格式：projects/{project_id}/databases/{database_id}/documents/{document_path}。

Precondition

文件的選用先決條件。如果已設定這個值，且不符合目標文件，要求就會失敗。

string

文件的資源名稱，例如 projects/{project_id}/databases/{database_id}/documents/{document_path}。

map<string, Value>

Timestamp

僅供輸出。建立文件的時間。

如果系統刪除文件並重新建立文件時，這個值會單調遞增。您也可以使用其他文件的值和查詢的 read_time 進行比較。

Timestamp

僅供輸出。上次變更文件的時間。

這個值一開始會設為 create_time，然後在每次變更文件時單調遞增。您也可以使用其他文件的值和查詢的 read_time 進行比較。

Document

Document 的新狀態。

如果已設定 mask，則僅包含更新或新增的欄位。

int32

與這份文件相符的目標 ID 組合。

int32

與這份文件不再相符的目標 ID 組合。

string

刪除的 Document 資源名稱。

int32

先前與這個實體相符的目標 ID 組合。

Timestamp

偵測到刪除作業的讀取時間戳記。

大於或等於刪除項目的 commit_time。

string

遮罩中的欄位路徑清單。如需欄位路徑語法參考資料，請參閱 Document.fields。

string

已從檢視畫面中出現的 Document 資源名稱。

int32

先前與這份文件相符的目標 ID 組合。

Timestamp

偵測到移除作業的讀取時間戳記。

大於或等於變更/刪除/移除的 commit_time。

string

要轉換的文件名稱。

FieldTransform

要依序套用至文件欄位的轉換清單。不得留空。

string

欄位路徑。如需欄位路徑語法參考資料，請參閱 Document.fields。

ServerValue

將欄位設為指定的伺服器值。

Value

將指定值加到欄位目前的值。

必須是整數或雙精度浮點值。如果欄位不是整數或雙精度浮點值，或是欄位不存在，轉換會將欄位設為指定值。如果指定值或目前欄位值是雙精度浮點值，兩個值都會解讀為雙精度浮點值。雙精度浮點數和雙精度表示法依 IEEE 754 語意。如果有正/負整數溢位，該欄位會解析為最大的正/負整數。

Value

將欄位設為目前值和指定值的最大值。

必須是整數或雙精度浮點值。如果欄位不是整數或雙精度浮點值，或是欄位不存在，轉換會將欄位設為指定值。如果套用最大運算值，且欄位和輸入值屬於混合型別 (例如 - 一個為整數，而 1 為雙精度)，欄位就會採用較大運算元的類型。如果運算元相等 (例如 3 和 3.0)，欄位就不會變更。0、0.0 和 -0.0 都是零。儲存值上限零或輸入值一律為儲存的值。x 和 NaN 的任何數值上限為 NaN。

Value

將欄位設為目前值和指定值的最小值。

必須是整數或雙精度浮點值。如果欄位不是整數或雙精度浮點值，或是欄位不存在，轉換會將欄位設為輸入值。如果套用最小運算值，且欄位和輸入值屬於混合型別 (也就是 - 一個為整數，而 1 為雙精度浮點值)，欄位就會採用較小的運算元類型。如果運算元相等 (例如 3 和 3.0)，欄位就不會變更。0、0.0 和 -0.0 都是零。儲存值下限為 0 且輸入值為 0 的最小值一律為儲存的值。任何數值 x 及 NaN 的最小值為 NaN。

ArrayValue

如果指定元素目前未出現在目前的欄位值中，請依序附加這些元素。如果欄位不是陣列，或欄位尚不存在，則會先設為空陣列。

檢查是否缺少值時，系統會將不同型別的數量 (例如 3L 和 3.0) 視為相等。NaN 等於 NaN，而空值等於空值。如果輸入值包含多個相等的值，系統只會採用第一個值。

對應的 transform_result 將為空值。

ArrayValue

移除欄位陣列中的所有特定元素。如果欄位不是陣列，或是欄位不存在，則會設為空白陣列。

在決定是否應移除元素時，系統會將各種類型的相等數量 (例如 3L 和 3.0) 視為相等。NaN 等於 NaN，而空值等於空值。如有重複的值，系統就會移除所有相等的值。

對應的 transform_result 將為空值。

int64

傳回的結果總數，包括文件、投影、匯總結果和鍵。

Duration

在後端執行查詢的總時間長度。

int64

計費讀取作業總數。

Struct

對執行查詢的統計資料進行偵錯。請注意，由於 Firestore 不斷發展，偵錯統計資料可能會有所變動。其中可能包含：{ "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details"：{ "documents_可計費": "20", "index_entries_可計費": "1000", "min_query_cost": "0"} }

int32

要套用此篩選器的目標 ID。

int32

符合 target_id 的文件總數。

如果用戶端中的文件數量不同，用戶端必須手動判斷哪些文件不再符合目標。

用戶端可以使用 unchanged_names 花卉篩選器，根據篩選器測試所有文件名稱，以判斷結果。如果文件名稱不在篩選器中，則表示文件不再與目標相符。

BloomFilter

這個 Bloom 篩選器包含符合 target_id 的「所有」文件資源名稱的 UTF-8 位元組編碼，格式為 projects/{project_id}/databases/{database_id}/documents/{document_path}。

伺服器可自行斟酌是否要省略這個 Bloom 篩選器，例如判定用戶端不會使用，或是計算或傳輸的運算成本過高。用戶端必須改回使用此欄位前使用的邏輯，以便妥善處理缺少這個欄位的情況；也就是說，在不使用履歷符記的情況下重新加入目標，藉此找出用戶端快取中哪些文件未保持同步。

PlanSummary

查詢的規劃階段資訊。

ExecutionStats

執行查詢的匯總統計資料。只有在 ExplainOptions.analyze 設為 true 時才會顯示。

bool

選用設定。是否執行這項查詢。

設為 false (預設值) 時，系統將針對查詢進行規劃，只傳回規劃階段的指標。

如果為 true，系統會規劃並執行查詢，傳回完整的查詢結果，以及規劃和執行階段指標。

string

執行個體類型，要取得之文件的資源名稱。請採用下列格式：projects/{project_id}/databases/{database_id}/documents/{document_path}。

DocumentMask

要傳回的欄位。如未設定，則會傳回所有欄位。

如果文件的某個欄位不在這個遮罩中，則不會在回應中傳回該欄位。

bytes

在交易中讀取文件。

Timestamp

讀取指定時間的文件版本。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

string

執行個體類型，父項文件。請採用下列格式：projects/{project_id}/databases/{database_id}/documents/{document_path}。例如：projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

要傳回的結果數上限。

string

網頁權杖。必須是 ListCollectionIdsResponse 的值。

Timestamp

讀取特定時間的文件。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

string

集合 ID。

string

網頁權杖可用於繼續清單。

string

執行個體類型，父項資源名稱。格式：projects/{project_id}/databases/{database_id}/documents 或 projects/{project_id}/databases/{database_id}/documents/{document_path}。

例如 projects/my-project/databases/my-database/documents 或 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

選用設定。要清單的集合 ID (相對於 parent)。

例如 chatrooms 或 messages。

這是選用項目，如未提供，Firestore 會在指定 parent 下列出所有集合的文件。

int32

選用設定。單次回應中傳回的文件數量上限。

Firestore 傳回的值可能會小於這個值。

string

選用設定。屬於接收自前一個 ListDocuments 回應的網頁權杖。

提供此項目即可擷取後續網頁。進行分頁時，所有其他參數 (page_size 除外) 都必須與產生網頁權杖的要求中設定的值相符。

string

選用設定。要傳回文件的選用順序。

例如 priority desc, __name__ desc。

這與 Firestore 查詢中使用的 ORDER BY 一模一樣，但是以字串表示。如果找不到，系統會根據 __name__ ASC 排序文件。

DocumentMask

選用設定。要傳回的欄位。如未設定，則會傳回所有欄位。

如果文件含有不在這個遮罩中的欄位，回應中就不會傳回該欄位。

bool

如果清單應顯示缺漏的文件，

如果文件不存在，但文件底下有子文件，則不會顯示。如果設為 True，這類遺漏文件會以鍵的形式傳回，但不會設定欄位、create_time 或 update_time。

含有 show_missing 的要求不得指定 where 或 order_by。

bytes

在運作中的交易中執行讀取作業。

Timestamp

於指定時間執行讀取作業。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

Document

找到的文件。

string

用於擷取下一頁文件的憑證。

如果省略這個欄位，就不會有後續頁面。

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{project_id}/databases/{database_id}。

map<string, string>

與這個目標變更相關聯的標籤。

Target

要新增至這個串流的目標。

int32

要從這個串流中移除的目標 ID。

TargetChange

目標已變更。

DocumentChange

Document 已變更。

DocumentDelete

已刪除Document。

DocumentRemove

Document 已從目標中移除 (因為不再與目標無關)。

ExistenceFilter

篩選器，套用至先前針對特定目標傳回的文件集。

在文件可能已從指定目標中移除，但確切文件不明時，系統會傳回這個錯誤代碼。

map<string, Value>

地圖的欄位。

對應鍵代表欄位名稱。系統會保留與規則運算式 __.*__ 相符的欄位名稱。除非在特定記錄的情況下，否則禁止使用保留的欄位名稱。對應鍵 (以 UTF-8 表示) 不得超過 1,500 個位元組，且不得留空。

string

執行個體類型，父項資源名稱。請採用下列格式：projects/{project_id}/databases/{database_id}/documents。不支援文件資源名稱；只能指定資料庫資源名稱。

int64

所需的分區點數量上限。多個結果頁面可能會傳回分區。數字必須是正數。實際傳回的分區數量可能較少。

舉例來說，設定可以設為只執行平行查詢數量的一個，或是執行資料管道工作中的數量少於可用的工作站或運算執行個體數量。

string

之前對 PartitionQuery 的呼叫傳回的 next_page_token 值，可用於取得另一組結果。結果組合之間沒有排序保證。因此，使用多組結果時，就需要合併不同的結果集。

舉例來說，使用 page_token 的後續呼叫可能會傳回：

• 遊標 B、遊標 M、遊標 Q
• 遊標 A，遊標 U，遊標 W

為了取得與提供給 PartitionQuery 的查詢結果排序的完整結果集，結果集必須合併：遊標 A、遊標 B、遊標 M、遊標 Q、遊標 U、遊標 W

int32

此呼叫中要傳回的分區數量上限，以 partition_count 為準。

舉例來說，如果 partition_count = 10 且 page_size = 8，第一次對 PartitionQuery 的呼叫會傳回最多 8 個分區，如果存在更多結果，則傳回 next_page_token。第二次對 PartitionQuery 的呼叫將傳回最多 2 個分區，以完成 partition_count 中指定的 10 個分區。

StructuredQuery

結構化查詢。查詢必須指定所有子系的集合，並依照名稱遞增排序。不支援其他篩選器、排序依據、限制、偏移和開始/結束遊標。

Timestamp

讀取特定時間的文件。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

Cursor

分區結果。每個分區都是分割點，可讓 RunQuery 做為查詢結果的開始或終點。RunQuery 要求必須透過提供給此 PartitionQuery 要求的相同查詢進行。系統會按照提供給 PartitionQuery 的查詢結果排序分區遊標。

例如，如果 PartitionQuery 要求傳回分區遊標 A 和 B，執行下列三個查詢將會傳回原始查詢的完整結果集：

• 查詢，end_at A
• 查詢，start_at A、end_at B
• 查詢, start_at B

空白結果可能表示該查詢沒有可分區的結果，或是查詢尚未支援分區。

string

頁面權杖，可用於要求其他一組結果，上限為 PartitionQuery 要求中的 partition_count 指定的數字。如果留空，表示沒有其他結果。

Struct

為查詢選取的索引。例如：[ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

設為 true 時，目標文件必須存在。設為 false 時，不可存在目標文件。

Timestamp

設定時，目標文件必須存在，且在此時已更新。時間戳記必須以微秒為單位對齊。

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{project_id}/databases/{database_id}。

bytes

執行個體類型，要復原的交易。

string

執行個體類型，父項資源名稱。格式：projects/{project_id}/databases/{database_id}/documents 或 projects/{project_id}/databases/{database_id}/documents/{document_path}。例如 projects/my-project/databases/my-database/documents 或 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

選用設定。說明查詢的選項。設定後，系統就會傳回其他查詢統計資料。否則，系統只會傳回查詢結果。

StructuredAggregationQuery

匯總查詢。

bytes

在現有交易中執行匯總。

此處的值是執行查詢的不透明交易 ID。

TransactionOptions

在查詢中開始新的交易，預設為唯讀。

系統會傳回新的交易 ID，做為串流中的第一個回應。

Timestamp

在指定時間戳記執行查詢。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

AggregationResult

單一匯總結果。

回報部分進度時不會顯示。

bytes

依此要求啟動的交易。

只有在要求展開新交易時，才會顯示在第一個回應中。

Timestamp

計算匯總結果的時間。每次增加在這個情況下，結果串流中先前的 AggregationResult 保證在 read_time 和此結果之間不會有所變更。

如果查詢未傳回任何結果，系統就不會傳送包含 read_time 的回應，不會傳送任何 result，而是代表查詢的執行時間。

ExplainMetrics

查詢說明指標。只有在提供 RunAggregationQueryRequest.explain_options 時才會顯示，且只會與串流中的最後一個回應一起傳送一次。

string

執行個體類型，父項資源名稱。格式：projects/{project_id}/databases/{database_id}/documents 或 projects/{project_id}/databases/{database_id}/documents/{document_path}。例如 projects/my-project/databases/my-database/documents 或 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

選用設定。說明查詢的選項。設定後，系統就會傳回其他查詢統計資料。否則，系統只會傳回查詢結果。

StructuredQuery

結構化查詢。

bytes

在有效交易內執行查詢。

此處的值是執行查詢的不透明交易 ID。

TransactionOptions

開始新的交易並讀取文件。預設為唯讀交易。系統會傳回新的交易 ID，做為串流中的第一個回應。

Timestamp

讀取特定時間的文件。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

bytes

依此要求啟動的交易。只能在第一個回應中設定，且必須在要求中設定 RunQueryRequest.new_transaction。如已設定，則此回應中不會設定其他欄位。

Document

回報部分進度時未設定查詢結果。

Timestamp

讀取文件的時間。這可能是單調增加在這種情況下，結果串流中的舊有文件保證在 read_time 和此文件之間不會變更。

如果查詢未傳回任何結果，系統就不會傳送包含 read_time 的回應，不會傳送任何 document，而是代表查詢的執行時間。

int32

因上一個回應與目前回應之間的偏移，而略過的結果數。

ExplainMetrics

查詢說明指標。只有在提供 RunQueryRequest.explain_options 時才會顯示，且只會與串流中的最後一個回應一起傳送一次。

bool

如果存在，Firestore 已完成要求，就不會再傳回其他文件。

Aggregation

選用設定。要套用至 structured_query 結果的一系列匯總。

需求條件：

• 每項查詢至少一項和最多五個匯總。

StructuredQuery

巢狀結構化查詢。

string

選用設定。用來儲存匯總結果的欄位名稱。

如未提供，Firestore 將按照 field_<incremental_id++> 格式選擇預設名稱。例如：

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

會變成：

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

需求條件：

• 所有匯總別名的名稱不得重複。
• 遵循 document field name 的限制。

Count

計數匯總器。

Sum

加總。

Avg

一般集結網站。

FieldReference

要匯總的欄位。

Int64Value

選用設定。(選用) 限制要計算的文件數量上限。

這樣就能設定要掃描的文件數量上限、限制延遲時間和費用。

如未指定，會解譯為無界限。

高階範例：

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

需求條件：

• 存在時必須大於零。

FieldReference

要匯總的欄位。

Projection

可傳回欄位的選用子集合。

就像 DocumentMask 一樣，適用於查詢傳回的文件。如未設定，則假設呼叫端希望傳回所有欄位。

CollectionSelector

要查詢的集合。

Filter

要套用的篩選器。

Order

要套用至查詢結果的順序。

Firestore 可讓呼叫端提供完整訂購、部分排序或完全不排序。在所有情況下，Firestore 都會透過下列規則確保以穩定的方式排序：

• 必須使用 order_by 才能參照使用不等式篩選器的所有欄位。
• 所有必填欄位都必須位於 order_by 中，但目前並未填寫的欄位，都會依照欄位名稱的字母順序排列。
• 如未指定 __name__ 的訂單，系統會依預設附加訂單。

欄位的排序方向會與最後指定的順序相同，或「ASCENDING」(如果未指定順序)。例如：

• ORDER BY a 變成 ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC 變成 ORDER BY a DESC, __name__ DESC
• WHERE a > 1 變成 WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 變成 WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Cursor

結果集內可能開始查詢的位置前置字元。

結果集的排序依據原始查詢的 ORDER BY 子句。

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

這項查詢的結果是按 (b ASC, __name__ ASC) 排序。

遊標可以參照完整順序或位置的前置字串，但參照的欄位數量不能超過提供的 ORDER BY 值。

延續上述範例，附加以下起始遊標會產生不同的影響：

• START BEFORE (2, /k/123)：在 a = 1 AND b > 2 AND __name__ > /k/123 之前開始查詢。
• START AFTER (10)：在 a = 1 AND b > 10 之後開始查詢。

需要掃描前 N 個結果才能略過，但 OFFSET 不同，起始遊標可讓查詢從邏輯位置開始。這個位置不需要與實際結果相符，系統就會從這個位置往前掃描，尋找下一份文件。

需求條件：

• 值的數量不得大於 ORDER BY 子句中指定的欄位數量。

Cursor

結果集中位置的可能前置字串，查詢結束位置。

這與 START_AT 類似，但前者會控制結束位置，而非起始位置。

需求條件：

• 值的數量不得大於 ORDER BY 子句中指定的欄位數量。

int32

傳回第一個結果前略過的文件數量。

此情況會在 WHERE、START AT 和END AT，但在 LIMIT 子句之前。

需求條件：

• 指定的值必須大於或等於零 (如有)。

Int32Value

要傳回的結果數上限。

在所有其他限制後方套用。

需求條件：

• 指定的值必須大於或等於零 (如有)。

FindNearest

選用設定。可能的鄰近地區搜尋。

系統會先套用所有其他篩選器和排序，再套用這項設定。

找出最接近指定查詢向量的向量嵌入。

string

集合 ID。設定後，請只選取具備這個 ID 的集合。

bool

設為 false 時，僅選取所屬 RunQueryRequest 所含 parent 直系子項的集合。如果為 true，系統會選取所有子集合。

Operator

用於合併多個篩選器的運算子。

Filter

要合併的篩選器清單。

需求條件：

• 至少有一個篩選器。

FieldReference

篩選依據的欄位。

Operator

要做為篩選依據的運算子。

Value

要比較的值。

string

文件中欄位的參照。

需求條件：

• 必須是以點分隔的區隔字串 (.)，且每個區隔都符合 document field name 限制。

CompositeFilter

複合篩選器。

FieldFilter

文件欄位的篩選器。

UnaryFilter

僅使用一個引數的篩選器。

FieldReference

執行個體類型，要搜尋的已建立索引向量欄位。文件必須包含維度與 query_vector 相符的向量。

Value

執行個體類型，我們所搜尋的查詢向量。必須是不超過 2048 個尺寸的向量。

DistanceMeasure

執行個體類型，要使用的距離量，必要項目。

Int32Value

執行個體類型，要傳回的最鄰點數量。必須是不超過 1000 的正整數。

FieldReference

要排序的欄位。

Direction

排序依據。預設值為 ASCENDING。

FieldReference

要傳回的欄位。

如果留空，系統會傳回所有欄位。如果只要傳回文件名稱，請使用 ['__name__']。

Operator

要套用的一元運算子。

FieldReference

要套用運算子的欄位。

int32

用來在串流中識別目標的目標 ID。必須是正數，且不得為零。

如果 target_id 為 0 (或未指定)，伺服器會為這個目標指派 ID，並在 TargetChange::ADD 事件中傳回。新增含有 target_id=0 的目標後，所有後續目標也必須同時具備 target_id=0。如果在新增含有 target_id=0 的目標後，傳送含有 target_id != 0 的 AddTarget 要求至伺服器，伺服器會立即傳送包含 TargetChange::Remove 事件的回應。

請注意，如果用戶端傳送多個沒有 ID 的 AddTarget 要求，則 TargetChage.target_ids 中傳回的 ID 順序為未定義。因此，客戶應提供目標 ID，而不是依賴伺服器來指派。

如果 target_id 不是零，則這個串流中不得有相同 ID 的有效目標。

bool

如果目標在當前且一致的狀態後就應移除。

Int32Value

上次在履歷符記或讀取時間與查詢相符的文件數量。

只有在提供 resume_type 時，這個值才有關聯性。此值存在，且大於用戶端想在回應中加入 ExistenceFilter.unchanged_names 的信號。

QueryTarget

查詢所指定的目標。

DocumentsTarget

由一組文件名稱指定的目標。

bytes

來自相同目標的舊版 TargetChange 重新啟用權杖。

系統不支援使用其他目標的履歷權杖，因此可能會失敗。

Timestamp

特定read_time後開始聆聽。

用戶端必須目前知道相符文件的狀態。

string

要擷取的文件名稱。請採用下列格式：projects/{project_id}/databases/{database_id}/documents/{document_path}。如果文件有任何文件不是指定 database 的子項資源，要求就會失敗。系統會省略重複的名稱。

string

父項資源名稱。格式：projects/{project_id}/databases/{database_id}/documents 或 projects/{project_id}/databases/{database_id}/documents/{document_path}。例如 projects/my-project/databases/my-database/documents 或 projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

結構化查詢。

TargetChangeType

發生的變更類型。

int32

已變更指定目標的目標 ID。

如果留空，變更會套用到所有指定目標。

未定義目標 ID 的順序。

Status

促成這項變更的錯誤 (如適用)。

bytes

可用來針對指定 target_ids 繼續執行串流的權杖，如果 target_ids 為空白，則適用於所有目標。

並非每次目標變更時都要設定。

Timestamp

指定 target_ids 的 read_time 版本一致 (當 target_ids 的快照不穩定時，就會省略)。

當整個串流達到新的一致快照時，串流保證會傳送 target_ids 空白的 read_time。系統保證 ADD、CURRENT 和 RESET 訊息一定會 (最後) 產生一致的快照，但不能有 NO_CHANGE 和 REMOVE 訊息。

針對特定串流，read_time 保證只會單調遞增。

ReadOnly

交易只能用於讀取作業。

ReadWrite

此交易可用於讀取和寫入作業。

Timestamp

在指定時間讀取文件。

這個時間戳記須為過去 1 小時內的微秒精確度，或者如果已啟用時間點復原，也可以是過去 7 天內的整分鐘時間戳記。

bytes

要重試的選用交易。

Document

執行個體類型，更新的文件。如果沒有文件，則會建立文件。

DocumentMask

要更新的欄位。遮罩中的所有欄位路徑均不得包含保留名稱。

如果文件存在於伺服器上，且遮罩中未參照的欄位，這些欄位就不會變更。遮罩中參照但未出現在輸入文件中的欄位，會從伺服器上刪除。

DocumentMask

要傳回的欄位。如未設定，則會傳回所有欄位。

如果文件的某個欄位不在這個遮罩中，則不會在回應中傳回該欄位。

Precondition

文件的選用先決條件。如果已設定這個值，且不符合目標文件，要求就會失敗。

NullValue

空值。

bool

布林值。

int64

整數值。

double

雙精度浮點值。

Timestamp

時間戳記值。

精準至微秒。儲存時，其他所有精確度都會無條件捨去。

string

字串值。

字串 (以 UTF-8 表示) 不得超過 1 MiB 至 89 個位元組。查詢只會考慮 UTF-8 表示法的前 1,500 個位元組。

bytes

位元組值。

不得超過 1 MiB 至 89 個位元組。查詢只會考慮前 1,500 個位元組。

string

文件的參照。例如 projects/{project_id}/databases/{database_id}/documents/{document_path}。

LatLng

代表地球表面上點的地理點值。

ArrayValue

陣列值。

無法直接包含另一個陣列值，但可以包含包含其他陣列的地圖。

MapValue

對應值。

DocumentMask

在這項寫入作業中要更新的欄位。

只有在作業為 update 時，才能設定這個欄位。如果未設定 update 的遮罩，且文件已存在，則系統會覆寫任何現有資料。如果已設定遮罩，但伺服器上的文件含有未涵蓋遮罩的欄位，這些欄位就不會變更。遮罩中參照但未出現在輸入文件中的欄位，會從伺服器上刪除。這個遮罩中的欄位路徑不得包含保留的欄位名稱。

FieldTransform

更新後要執行的轉換。

只有在作業為 update 時，才能設定這個欄位。如果存在，則此寫入程序等同於以不可分割的形式，在同一份文件上執行 update 和 transform。

Precondition

文件的選用先決條件。

如果設定值且不符合目標文件，寫入作業就會失敗。

Document

要寫入的文件。

string

要刪除的文件名稱。請採用下列格式：projects/{project_id}/databases/{database_id}/documents/{document_path}。

DocumentTransform

將轉換套用至文件。

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{project_id}/databases/{database_id}。這只需要在第一則訊息中填寫。

string

要重新啟用的寫入串流 ID。這可能只能在第一則訊息中設定。如果留空，系統會建立新的寫入串流。

Write

要套用的寫入作業。

一律以不可分割的形式，依序執行。第一個要求中必須留空。在最後一個要求中，這個項目可能空白。所有其他要求均不得留空。

bytes

伺服器先前傳送的串流權杖。

用戶端應將這個欄位設為最近收到的 WriteResponse 中的權杖。確認用戶端已收到此權杖的回應。傳送這個權杖後，先前的權杖就無法再使用。

如果未確認的回應過多，伺服器就可能會關閉串流。

建立新串流時，不必設定這個欄位。如要在特定時間點繼續串流，請設定這個欄位和 stream_id 欄位。

建立新串流時，不必設定這個欄位。

map<string, string>

與這項寫入要求相關聯的標籤。

string

串流 ID。只在建立新直播時，於第一則訊息中設定。

bytes

代表此回應在串流中位置的符記。用戶端可使用此 ID 繼續進行串流作業。

系統會一律設定這個欄位。

WriteResult

套用寫入的結果。

這項 i-th 寫入結果與要求中的 i-th 寫入對應。

Timestamp

修訂版本發生的時間。只要 read_time 等於或大於此值，就保證能看到寫入的效果。

Timestamp

套用寫入後，文件上次更新的時間。未在 delete 之後設定。

如果寫入內容實際上並未變更文件，那麼這將會是之前的 update_time。

Value

以相同的順序套用每個 DocumentTransform.FieldTransform 的結果。