StructuredQuery

{
  "select": {
    object (Projection)
  },
  "from": [
    {
      object (CollectionSelector)
    }
  ],
  "where": {
    object (Filter)
  },
  "orderBy": [
    {
      object (Order)
    }
  ],
  "startAt": {
    object (Cursor)
  },
  "endAt": {
    object (Cursor)
  },
  "offset": integer,
  "limit": integer,
  "findNearest": {
    object (FindNearest)
  }
}

object (Projection)

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

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

object (CollectionSelector)

האוספים שיש להריץ עליהם שאילתות.

object (Filter)

המסנן שצריך להחיל.

object (Order)

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

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

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

object (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.

object (Cursor)

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

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

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

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

integer

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

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

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

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

integer

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

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

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

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

object (FindNearest)

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

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

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