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 به تماس‌گیرندگان اجازه می‌دهد تا سفارش کامل، سفارش جزئی یا اصلاً سفارشی را نداشته باشند. در همه موارد، Firestor یک سفارش پایدار را از طریق قوانین زیر تضمین می کند:

• orderBy برای ارجاع به تمام فیلدهای استفاده شده با فیلتر نابرابری مورد نیاز است.
• تمام فیلدهایی که باید به orderBy باشند اما قبلاً وجود ندارند به ترتیب واژگانی نام فیلد اضافه می شوند.
• اگر سفارشی در __name__ مشخص نشده باشد، به طور پیش‌فرض اضافه می‌شود.

فیلدها با همان جهت مرتب‌سازی آخرین مرتبه مشخص شده، یا اگر ترتیبی مشخص نشده باشد، "صعودی" اضافه می‌شوند. مثلا:

• 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 )

اختیاری. جستجوی بالقوه نزدیکترین همسایگان

بعد از تمام فیلترهای دیگر و سفارش اعمال می شود.

نزدیکترین جاسازی های برداری را به بردار پرس و جو داده شده پیدا می کند.