Package google.firestore.v1beta1

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

מתחיל עסקה חדשה וקורא את המסמכים. ברירת המחדל היא עסקה לקריאה בלבד. מזהה העסקה החדש יוחזר כתגובה הראשונה בשידור.

Timestamp

קריאת מסמכים כפי שהם היו בזמן הנתון.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-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 תואמת לכתיבה ה-i שבבקשה.

Status

הסטטוס של החלת כתבי היד.

סטטוס הכתיבה ה-i-th תואם לכתיבה ה-i-th שבבקשה.

string

חובה. שם מסד הנתונים. בפורמט: projects/{project_id}/databases/{database_id}.

TransactionOptions

האפשרויות לעסקה. ברירת המחדל היא טרנזקציית קריאה-כתיבה.

bytes

העסקה שהתחילה.

bytes

הבייטים שמקודדים את רצף הביטים. יכול להיות שהאורך שלו הוא אפס.

int32

מספר הביטים בבייט האחרון ב-bitmap שיש להתעלם מהם בתור 'מרווח פנימי'. אם האורך של bitmap הוא אפס, הערך הזה חייב להיות 0. אחרת, הערך הזה חייב להיות בין 0 ל-7, כולל.

BitSequence

נתוני סינון הפריחה.

int32

מספר הגיבובים שהאלגוריתם משתמש בהם.

string

חובה. שם מסד הנתונים. בפורמט: projects/{project_id}/databases/{database_id}.

Write

הכתיבה שצריך להחיל.

מופעל תמיד באופן אטומי ובסדר.

bytes

אם המדיניות מוגדרת, המערכת תחיל את כל מה שכתוב בעסקה הזו ותחיל אותה.

WriteResult

התוצאה של החלת הכתיבה.

תוצאת הכתיבה ה-i תואמת לכתיבה ה-i שבבקשה.

Timestamp

השעה שבה התרחשה ההתחייבות. לכל קריאה עם ערך read_time שווה או גדול יותר מובטח לראות את ההשפעה של ההתחייבות.

string

חובה. משאב ההורה. לדוגמה: projects/{project_id}/databases/{database_id}/documents או projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

חובה. מזהה הקולקציה, ביחס ל-parent, לרשימה. לדוגמה: chatrooms.

string

מזהה המסמך שהוקצה על ידי הלקוח וצריך להשתמש בו במסמך הזה.

זה שינוי אופציונלי. אם לא מציינים זאת, השירות יקצה מזהה.

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

קבוצה של מזהי יעדים של יעדים שתואמים למסמך הזה.

int32

קבוצה של מזהי יעדים של יעדים שכבר לא תואמים למסמך הזה.

string

שם המשאב של Document שנמחק.

int32

קבוצה של מזהי יעדים של יעדים שתאמו בעבר לישות הזו.

Timestamp

חותמת הזמן של הקריאה שבה זוהתה פעולת המחיקה.

גדול או שווה ל-commit_time של המחיקה.

string

רשימה של נתיבי השדות במסכה. אפשר לראות הסבר על תחביר של נתיבי שדות בכתובת Document.fields.

string

שם המשאב של Document שלא נמצא בתצוגה.

int32

קבוצה של מזהי יעדים של יעדים שתאמו בעבר למסמך הזה.

Timestamp

חותמת הזמן של הקריאה שבה נצפתה ההסרה.

גדול או שווה ל-commit_time של השינוי/מחיקה/הסרה.

string

שם המסמך להמרה.

FieldTransform

רשימת הטרנספורמציות שיש להחיל על השדות של המסמך, לפי סדר. חובה למלא את השדה הזה.

string

הנתיב של השדה. מידע על תחביר של נתיבי שדות מופיע בכתובת Document.fields.

ServerValue

מגדיר את השדה לערך הנתון של השרת.

Value

הפונקציה מוסיפה את הערך הנתון לערך הנוכחי בשדה.

חייב להיות מספר שלם או ערך כפול. אם השדה אינו מספר שלם או כפול, או אם השדה עדיין לא קיים, הטרנספורמציה תגדיר את השדה לערך הנתון. אם הערך הנתון או הערך הנוכחי בשדה כפול, שני הערכים יפורשו ככפולים. חשבון כפול וייצוג של ערכים כפולים פועלים לפי הסמנטיקה של IEEE 754. במקרה של גלישת מספרים שלמים חיוביים/שליליים, המערכת תפתור את השדה 'מספר שלם חיובי/שלילי' הגדול ביותר.

Value

מגדיר את השדה למקסימום של הערך הנוכחי שלו ושל הערך הנתון.

חייב להיות מספר שלם או ערך כפול. אם השדה אינו מספר שלם או כפול, או אם השדה עדיין לא קיים, הטרנספורמציה תגדיר את השדה לערך הנתון. אם פעולה מקסימלית מיושמת כאשר השדה וערך הקלט הם מסוגים מעורבים (כלומר: אחד הוא מספר שלם ואחד הוא כפול), השדה הזה יקבל את סוג האופרנד הגדול יותר. אם האופרנדים הם שווי ערך (למשל 3 ו-3.0), השדה לא משתנה. הערכים 0, 0.0 ו-0.0 הם אפס. הערך המקסימלי של ערך מאוחסן של אפס וערך קלט של אפס הוא תמיד הערך שמאוחסן. הערך המקסימלי של כל ערך מספרי x ו-NaN הוא NaN.

Value

מגדיר את השדה למינימום של הערך הנוכחי שלו ושל הערך הנתון.

חייב להיות מספר שלם או ערך כפול. אם השדה אינו מספר שלם או כפול, או אם השדה עדיין לא קיים, הטרנספורמציה תגדיר את השדה לערך הקלט. אם פעולה מינימלית מיושמת כאשר השדה וערך הקלט הם מסוגים מעורבים (כלומר, אחד הוא מספר שלם ואחד הוא כפול), השדה קטן יותר לפי סוג האופרנד הקטן יותר. אם האופרנדים הם שווי ערך (למשל 3 ו-3.0), השדה לא משתנה. הערכים 0, 0.0 ו-0.0 הם אפס. הערך המינימלי של ערך מאוחסן של אפס וערך קלט של אפס הוא תמיד הערך שמאוחסן. המינימום של כל ערך מספרי x ו-NaN הוא NaN.

ArrayValue

מוסיפים את הרכיבים הנתונים לפי הסדר, אם הם עדיין לא קיימים בערך הנוכחי בשדה. אם השדה אינו מערך, או אם השדה עדיין לא קיים, הוא יוגדר תחילה למערך הריק.

מספרים שווים מסוגים שונים (למשל 3L ו-3.0) נחשבים שווים כשבודקים אם חסר ערך. NaN שווה ל-NaN, ו-Null שווה ל-Null. אם הקלט מכיל כמה ערכים שווים, רק הערך הראשון ייכלל.

תוצאת הטרנספורמציה המתאימה תהיה הערך null.

ArrayValue

מסירים את כל הרכיבים הנתונים מהמערך שבשדה. אם השדה אינו מערך או אם השדה עדיין לא קיים, הוא יוגדר למערך הריק.

מספרים שווים מהסוגים השונים (למשל 3L ו-3.0) נחשבים שווים כשמחליטים אם להסיר רכיב. NaN שווה ל-NaN, ו-Null שווה ל-Null. פעולה זו תסיר את כל הערכים המקבילים אם יש כפילויות.

תוצאת הטרנספורמציה המתאימה תהיה הערך null.

int64

המספר הכולל של התוצאות שהוחזרו, כולל מסמכים, תחזיות, תוצאות צבירת נתונים ומפתחות.

Duration

הזמן הכולל לביצוע השאילתה בקצה העורפי.

int64

סך כל פעולות הקריאה הניתנות לחיוב.

Struct

ניפוי באגים של נתונים סטטיסטיים מהפעלת השאילתה. שימו לב שהנתונים הסטטיסטיים של ניפוי הבאגים עשויים להשתנות עם ההתפתחות של Firestore. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

מזהה היעד שעליו המסנן חל.

int32

המספר הכולל של מסמכים שתואמים ל-target_id.

אם מספר המסמכים בלקוח שתואמים שונה ממספר המסמכים, הלקוח צריך לקבוע באופן ידני אילו מסמכים כבר לא תואמים ליעד.

הלקוח יכול להשתמש במסנן הפריחה unchanged_names כדי לקבוע את הקביעה הזו על ידי בדיקה של כל שמות המסמכים בהשוואה למסנן. אם שם המסמך לא נכלל במסנן, המשמעות היא שהמסמך כבר לא תואם ליעד.

BloomFilter

מסנן פריחה שלמרות השם שלו, מכיל קידודים מסוג UTF-8 בייטים של שמות המשאבים של כל המסמכים שתואמים ל-target_id, בצורה projects/{project_id}/databases/{database_id}/documents/{document_path}.

ניתן להשמיט את מסנן הפריחה לפי שיקול דעתו של השרת, למשל במקרה שהלקוח לא ישתמש בו או אם הוא יקר מדי לחישוב או לשידור. לקוחות חייבים לטפל בשדה הזה בצורה חלקה על ידי חזרה ללוגיקה שבה נעשה שימוש לפני שהשדה הזה היה קיים. כלומר, להוסיף מחדש את היעד ללא אסימון המשך כדי לברר אילו מסמכים במטמון הלקוח לא מסונכרנים.

PlanSummary

מידע על שלב התכנון עבור השאילתה.

ExecutionStats

נתונים סטטיסטיים מצטברים מביצוע השאילתה. מוצג רק אם המדיניות ExplainOptions.analyze מוגדרת כ-True.

bool

זה שינוי אופציונלי. האם להפעיל את השאילתה הזו.

כשהערך הוא False (ברירת המחדל), השאילתה תתוזמן ויוצגו רק המדדים משלבי התכנון.

אם הערך הוא True, השאילתה תתוכננו ותבוצע, והיא תחזיר את תוצאות השאילתה המלאות יחד עם המדדים של שלב התכנון ושל הביצוע.

string

חובה. שם המשאב שיש לקבל במסמך. בפורמט: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

השדות שיש להחזיר. אם המדיניות לא מוגדרת, כל השדות מוחזרים.

אם המסמך כולל שדה שלא נמצא במסכה הזו, השדה הזה לא יוחזר.

bytes

קורא את המסמך בעסקה.

Timestamp

קורא את גרסת המסמך בזמן הנתון.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-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

קריאת מסמכים כפי שהם היו בזמן הנתון.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-7 הימים האחרונים.

string

מזהי הקולקציות

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

זה שינוי אופציונלי. מזהה הקולקציה, ביחס ל-parent, לרשימה.

לדוגמה: chatrooms או messages.

הפעולה הזו היא אופציונלית, ואם לא צוין אחרת, Firestore יציג מסמכים מכל האוספים בהתאם לparent שצוין.

int32

זה שינוי אופציונלי. המספר המקסימלי של מסמכים שיש להחזיר בתגובה אחת.

Firestore עשוי להחזיר פחות מהערך הזה.

string

זה שינוי אופציונלי. אסימון דף שהתקבל מתגובה קודמת של ListDocuments.

ספקו אותו כדי לאחזר את הדף הבא. במהלך העימוד, כל הפרמטרים האחרים (למעט page_size) חייבים להתאים לערכים שהוגדרו בבקשה שיצרה את אסימון הדף.

string

זה שינוי אופציונלי. הסדר האופציונלי של המסמכים שיש להחזיר.

לדוגמה: priority desc, __name__ desc.

הפעולה הזו משקפת את ORDER BY שנעשה בו שימוש בשאילתות של Firestore אבל בייצוג מחרוזות. אם חסר מידע, המסמכים יסודרו לפי __name__ ASC.

DocumentMask

זה שינוי אופציונלי. השדות שיש להחזיר. אם המדיניות לא מוגדרת, כל השדות מוחזרים.

אם מסמך כולל שדה שלא נמצא במסכה הזו, השדה הזה לא יוחזר.

bool

אם ברשימה אמורים להופיע מסמכים חסרים.

אם מסמך חסר, הוא לא קיים, אבל יש מסמכי משנה שמוצבים מתחתיו. אם הערך הוא True, מסמכים חסרים כאלה יוחזרו עם מפתח אבל לא יוגדרו בהם שדות, create_time או update_time.

בבקשות עם show_missing אסור לציין where או order_by.

bytes

מבצעים את הקריאה כחלק מעסקה שכבר פעילה.

Timestamp

ביצוע הקריאה בזמן המתאים.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-7 הימים האחרונים.

Document

המסמכים שנמצאו.

string

אסימון לאחזור דף המסמכים הבא.

אם השדה הזה יושמט, לא יהיו דפים עוקבים.

string

חובה. שם מסד הנתונים. בפורמט: projects/{project_id}/databases/{database_id}.

map<string, string>

תוויות שמשויכות ליעד הזה השתנו.

Target

יעד שאפשר להוסיף לשידור הזה.

int32

המזהה של היעד שיש להסיר ממקור הנתונים הזה.

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

הערך next_page_token שהוחזר מקריאה קודמת ל-partitionQuery ויכול לשמש לקבלת קבוצה נוספת של תוצאות. אין ערובה לסדר מסוים בין קבוצות של תוצאות. לכן, שימוש בכמה קבוצות של תוצאות יחייב מיזוג של קבוצות התוצאות השונות.

לדוגמה, שתי קריאות עוקבות באמצעות 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 תחזיר עד שתי מחיצות, ותשלים את ה-10 שצוינו ב-partition_count.

StructuredQuery

שאילתה מובנית. השאילתה צריכה לציין אוסף עם כל הצאצאים ולהיות מסודרת לפי שם בסדר עולה. אין תמיכה במסננים אחרים, בסדר לפי סדר מסוים, במגבלות, בהיסט ובסמני התחלה/סיום.

Timestamp

קריאת מסמכים כפי שהם היו בזמן הנתון.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-7 הימים האחרונים.

Cursor

תוצאות החלוקה. כל מחיצה היא נקודת פיצול שיכולה לשמש את RunQuery כנקודת התחלה או יעד של תוצאות השאילתה. בקשות RunQuery חייבות להתבצע עם אותה שאילתה שסופקה לבקשת ה-partitionQuery הזו. סמני המחיצות מסודרים לפי אותו סדר כמו תוצאות השאילתה שסופקו ל-partitionQuery.

לדוגמה, אם בקשתpartitionQuery מחזירה את סמני המחיצות A ו-B, הרצת שלוש השאילתות הבאות תחזיר את כל קבוצת התוצאות של השאילתה המקורית:

• שאילתה, end_at A
• שאילתה, start_at A, end_at B
• שאילתה, start_at B

תוצאה ריקה עשויה להעיד על כך שבשאילתה יש מעט מדי תוצאות מכדי לחלק אותה למחיצות, או שהשאילתה עדיין לא נתמכת לחלוקה למחיצות.

string

אסימון דף שיכול לשמש לבקשת קבוצה נוספת של תוצאות, עד למספר שצוין על ידי partition_count בבקשת ה-partitionQuery. אם השדה יישאר ריק, לא יהיו תוצאות נוספות.

Struct

האינדקסים שנבחרו לשאילתה. For example: [ {"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

הפעל את הצבירה בתוך עסקה שכבר פעילה.

הערך כאן הוא מזהה העסקה השקוף שבו צריך לבצע את השאילתה.

TransactionOptions

מפעיל עסקה חדשה כחלק מהשאילתה, וברירת המחדל היא לקריאה בלבד.

מזהה העסקה החדש יוחזר כתגובה הראשונה בשידור.

Timestamp

מפעיל את השאילתה בחותמת הזמן הנתונה.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-7 הימים האחרונים.

AggregationResult

תוצאת צבירה אחת.

לא קיים בדיווח על התקדמות חלקית.

bytes

העסקה שהתחילה כחלק מהבקשה הזו.

מוצג רק בתגובה הראשונה כשנשלחה בקשה להתחלת עסקה חדשה.

Timestamp

המועד שבו חושבה התוצאה המצטברת. הערך הזה תמיד גדל באופן מונוטוני. במקרה הזה, מובטח שתוצאת הצבירה הקודמת בזרם התוצאות לא תשתנה בין 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

מריצים את השאילתה בעסקה שכבר פעילה.

הערך כאן הוא מזהה העסקה השקוף שבו צריך לבצע את השאילתה.

TransactionOptions

מתחיל עסקה חדשה וקורא את המסמכים. ברירת המחדל היא עסקה לקריאה בלבד. מזהה העסקה החדש יוחזר כתגובה הראשונה בשידור.

Timestamp

קריאת מסמכים כפי שהם היו בזמן הנתון.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-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.

בניגוד ל-OFFSET שבו יש צורך לסרוק את N התוצאות הראשונות כדי לדלג עליהן, סמן התחלה מאפשר לשאילתה להתחיל במיקום לוגי. המיקום הזה לא נדרש כדי להתאים לתוצאה בפועל. יש לסרוק קדימה מהמיקום הזה כדי למצוא את המסמך הבא.

אלה הדרישות שצריך לעמוד בהן:

• מספר הערכים לא יכול להיות גדול ממספר השדות שצוין בסעיף ORDER BY.

Cursor

קידומת פוטנציאלית למיקום בתוצאה שהוגדרה לסיום השאילתה.

היא דומה ל-START_AT אבל היא שולטת במיקום הסיום ולא במיקום ההתחלה.

אלה הדרישות שצריך לעמוד בהן:

• מספר הערכים לא יכול להיות גדול ממספר השדות שצוין בסעיף ORDER BY.

int32

מספר המסמכים שיש לדלג עליהם לפני החזרת התוצאה הראשונה.

הכלל הזה חל אחרי המגבלות שצוינו בסעיפים WHERE, START AT ו-END AT, אבל לפני הסעיף LIMIT.

אלה הדרישות שצריך לעמוד בהן:

• אם צוין ערך, הערך צריך להיות גדול מאפס או שווה לו.

Int32Value

המספר המקסימלי של תוצאות שיש להחזיר.

המדיניות חלה אחרי כל שאר המגבלות.

אלה הדרישות שצריך לעמוד בהן:

• אם צוין ערך, הערך צריך להיות גדול מאפס או שווה לו.

FindNearest

זה שינוי אופציונלי. חיפוש 'שכנים קרובים ביותר' פוטנציאלי.

ההגדרה חלה אחרי כל שאר המסננים והסידור.

מוצאת את הטמעות הווקטור הקרובות ביותר לווקטור השאילתה.

string

מזהה הקולקציה. כשההגדרה מוגדרת, היא בוחרת רק קולקציות עם המזהה הזה.

bool

אם הערך הוא False, נבחרים רק אוספים שהם צאצאים מיידיים של parent שצוין ב-RunQueryRequest המכיל. אם הערך הוא True, המערכת בוחרת את כל אוספים הצאצאים.

Operator

האופרטור לשילוב מסננים מרובים.

Filter

רשימת המסננים לשילוב.

אלה הדרישות שצריך לעמוד בהן:

• קיים מסנן אחד לפחות.

FieldReference

השדה שלפיו רוצים לסנן.

Operator

האופרטור שלפיו רוצים לסנן.

Value

הערך שאליו רוצים להשוות.

string

הפניה לשדה במסמך.

אלה הדרישות שצריך לעמוד בהן:

• מחרוזת קטעים מופרדת באמצעות נקודות (.), שבה כל מקטע עומד במגבלות של document field name.

CompositeFilter

מסנן מורכב.

FieldFilter

מסנן בשדה של מסמך.

UnaryFilter

מסנן שלוקח רק ארגומנט אחד.

FieldReference

חובה. שדה וקטורי שנוסף לאינדקס. אפשר להחזיר רק מסמכים שמכילים וקטורים שהמידות שלהם תואמות את וקטור ה-query.

Value

חובה. וקטור השאילתה שאנחנו מחפשים. חייב להיות וקטור של עד 2,048 מאפיינים.

DistanceMeasure

חובה. מידת המרחק שבה יש להשתמש, חובה.

Int32Value

חובה. מספר השכנים הקרובים ביותר שיש להחזיר. מספר שלם חיובי שאינו עולה על 1000.

FieldReference

השדה שלפיו רוצים לסדר.

Direction

הכיוון שלפיו יש לסדר. ברירת המחדל היא ASCENDING.

FieldReference

השדות שיש להחזיר.

אם השדה יישאר ריק, יוחזרו כל השדות. כדי להחזיר רק את שם המסמך, יש להשתמש בפונקציה ['__name__'].

Operator

האופרטור Unary יש להחיל.

FieldReference

השדה שעליו יש להחיל את האופרטור.

int32

מזהה היעד שמזהה את היעד במקור הנתונים. חייב להיות מספר חיובי ולא אפס.

אם הערך של target_id הוא 0 (או שלא צוין), השרת יקצה מזהה ליעד הזה ויחזיר אותו באירוע TargetChange::ADD. לאחר הוספת יעד עם target_id=0, כל היעדים הבאים חייבים לכלול גם target_id=0. אם בקשת AddTarget עם target_id != 0 נשלחת לשרת לאחר שנוסף יעד עם target_id=0, השרת ישלח באופן מיידי תגובה עם אירוע TargetChange::Remove.

הערה: אם הלקוח שולח כמה בקשות AddTarget בלי מזהה, לא מוגדר סדר המזהים שמוחזרים ב-TargetChage.target_ids. לכן, הלקוחות צריכים לספק מזהה יעד במקום להסתמך על השרת כדי להקצות מזהה.

אם הערך של target_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

מזהי היעדים של היעדים שהשתנו.

אם השדה ריק, השינוי יחול על כל היעדים.

לא הוגדר הסדר של מזהי היעדים.

Status

השגיאה שגרמה לשינוי הזה, אם רלוונטי.

bytes

אסימון שניתן להשתמש בו כדי להמשיך את השידור עבור target_ids הנתון, או עבור כל היעדים אם target_ids ריק.

לא מוגדר בכל שינוי ביעד.

Timestamp

הערך העקבי read_time עבור target_ids הנתון (מושמט כשמזהי target_id לא נמצאים בתמונת מצב עקבית).

השידור מבטיח לשלוח read_time עם target_ids ריק בכל פעם שכל השידור מגיע לתמונת מצב עקבית חדשה. הודעות ADD , CURRENT ו-RESET מובטחות (בסופו של דבר) יובילו ליצירת תמונת מצב חדשה ועקבית (בעוד שהודעות NO_CHANGE ו-REMOVE אינן פועלות).

בשידור נתון, הערך של read_time צפוי לעלות באופן מונוטוני.

ReadOnly

ניתן להשתמש בעסקה רק לפעולות קריאה.

ReadWrite

ניתן להשתמש בעסקה גם לפעולות קריאה וגם כתיבה.

Timestamp

קריאת מסמכים בזמן הנתון.

זו צריכה להיות חותמת זמן ברמת דיוק של מיקרו-שנייה בשעה האחרונה. אם האפשרות 'שחזור נקודת זמן' מופעלת, היא יכולה להיות גם חותמת זמן של דקה שלמה מ-7 הימים האחרונים.

bytes

טרנזקציה אופציונלית שיש לנסות שוב.

Document

חובה. המסמך המעודכן. יצירת המסמך אם הוא עדיין לא קיים.

DocumentMask

השדות שצריך לעדכן. אף אחד מנתיבי השדות במסכה לא יכול להכיל שם שמור.

אם המסמך קיים בשרת ויש בו שדות שלא הפניה אליהם במסכה, הם יישארו ללא שינוי. שדות שיש אליהם הפניה במסכה אבל לא נמצאים במסמך הקלט, יימחקו מהמסמך בשרת.

DocumentMask

השדות שיש להחזיר. אם המדיניות לא מוגדרת, כל השדות מוחזרים.

אם המסמך כולל שדה שלא נמצא במסכה הזו, השדה הזה לא יוחזר.

Precondition

תנאי מוקדם אופציונלי במסמך. הבקשה תיכשל אם ההגדרה הזו לא תעמוד בדרישות מסמך היעד.

NullValue

ערך null.

bool

ערך בוליאני.

int64

ערך מסוג מספר שלם.

double

ערך כפול.

Timestamp

ערך של חותמת זמן.

מדויק רק למיליוניות השנייה. אחרי השמירה, כל רמת דיוק נוספת תעוגל כלפי מטה.

string

ערך מחרוזת.

המחרוזת, שמיוצגת כ-UTF-8, לא יכולה לחרוג מ- 1MiB – 89 בייטים. רק 1,500 הבייטים הראשונים של הייצוג UTF-8 מובאים בחשבון על ידי שאילתות.

bytes

ערך בייטים.

מקסימום 1MiB עד 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

המזהה של זרם הכתיבה כדי להמשיך. אפשר להגדיר את האפשרות הזו רק בהודעה הראשונה. אם תשאירו את השדה ריק, המערכת תיצור שידור חדש לכתיבה.

Write

הכתיבה שצריך להחיל.

מופעל תמיד באופן אטומי ובסדר. השדה הזה חייב להיות ריק בבקשה הראשונה. השדה הזה עשוי להיות ריק בבקשה האחרונה. חובה למלא את השדה הזה בכל הבקשות האחרות.

bytes

אסימון שידור שנשלח בעבר על ידי השרת.

הלקוח צריך להגדיר את השדה הזה כאסימון מה-WriteResponse האחרון שהוא קיבל. הפעולה הזאת מאשרת שהלקוח קיבל תגובות עד לאסימון הזה. אחרי שליחת האסימון הזה, לא ניתן יהיה להשתמש יותר באסימונים קודמים.

אם יש יותר מדי תגובות שאינן מאושרות, השרת עשוי לסגור את הסטרימינג.

כשיוצרים שידור חדש, משאירים את השדה הזה לא מוגדר. כדי להמשיך את הסטרימינג בנקודה מסוימת, צריך להגדיר את השדה הזה ואת השדה stream_id.

כשיוצרים שידור חדש, משאירים את השדה הזה לא מוגדר.

map<string, string>

תוויות שמשויכות לבקשת הכתיבה הזו.

string

מזהה מקור הנתונים. מוגדר רק בהודעה הראשונה, כאשר נוצר שידור חדש.

bytes

אסימון שמייצג את המיקום של התגובה הזו בזרם. הלקוח יכול להשתמש באפשרות הזו כדי להמשיך את הסטרימינג בשלב הזה.

השדה הזה תמיד מוגדר.

WriteResult

התוצאה של החלת הכתיבה.

תוצאת הכתיבה ה-i תואמת לכתיבה ה-i שבבקשה.

Timestamp

השעה שבה התרחשה ההתחייבות. לכל קריאה עם ערך read_time שווה או גדול יותר מובטח לראות את השפעת הכתיבה.

Timestamp

שעת העדכון האחרונה של המסמך לאחר החלת הכתיבה. לא מוגדרת אחרי delete.

אם הכתיבה לא שינתה את המסמך בפועל, יהיה הערך הקודם של update_time.

Value

התוצאות של החלת כל DocumentTransform.FieldTransform, באותו סדר.