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

زمانی که سند خوانده شد. این ممکن است به طور یکنواخت در حال افزایش باشد، در این مورد اسناد قبلی در جریان نتیجه تضمین می‌شوند که بین زمان خواندنشان و این یکی تغییر نکرده باشند.

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-ام با نوشتن i-ام در درخواست مطابقت دارد.

string

ضروری. نام پایگاه داده در قالب: projects/{project_id}/databases/{database_id} .

TransactionOptions

گزینه های معامله پیش‌فرض تراکنش خواندن و نوشتن.

bytes

معامله ای که شروع شد.

bytes

بایت هایی که دنباله بیت را رمزگذاری می کنند. ممکن است طولی برابر با صفر داشته باشد.

int32

تعداد بیت های آخرین بایت در bitmap که به عنوان "padding" نادیده گرفته می شود. اگر طول bitmap صفر باشد، این مقدار باید 0 باشد. در غیر این صورت، این مقدار باید بین 0 تا 7 باشد.

BitSequence

داده های فیلتر شکوفه

int32

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

string

ضروری. نام پایگاه داده در قالب: projects/{project_id}/databases/{database_id} .

Write

می نویسد برای اعمال.

همیشه به صورت اتمی و به ترتیب اجرا می شود.

bytes

در صورت تنظیم، تمام نوشته های این تراکنش را اعمال می کند و آن را انجام می دهد.

WriteResult

نتیجه اعمال نوشته ها.

این نتیجه نوشتن i-ام با نوشتن i-ام در درخواست مطابقت دارد.

Timestamp

زمانی که ارتکاب در آن اتفاق افتاد. هر خواندنی با read_time مساوی یا بیشتر تضمین می شود که اثرات commit را مشاهده کند.

string

ضروری. منبع والد برای مثال: projects/{project_id}/databases/{database_id}/documents or 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 است. اگر ورودی حاوی چندین مقدار معادل باشد، تنها مقدار اول در نظر گرفته می شود.

transform_result مربوطه مقدار تهی خواهد بود.

ArrayValue

تمام عناصر داده شده را از آرایه موجود در فیلد حذف کنید. اگر فیلد یک آرایه نباشد، یا اگر فیلد هنوز وجود نداشته باشد، روی آرایه خالی تنظیم می شود.

اعداد معادل انواع مختلف (مانند 3L و 3.0) هنگام تصمیم گیری در مورد حذف یک عنصر برابر در نظر گرفته می شوند. NaN برابر با NaN و Null برابر با Null است. اگر موارد تکراری وجود داشته باشد، تمام مقادیر معادل حذف می شود.

transform_result مربوطه مقدار تهی خواهد بود.

int64

تعداد کل نتایج بازگردانده شده، از جمله اسناد، پیش بینی ها، نتایج تجمیع، کلیدها.

Duration

کل زمان برای اجرای پرس و جو در باطن.

int64

کل عملیات خواندن قابل پرداخت

Struct

اشکال زدایی آمار از اجرای پرس و جو. توجه داشته باشید که با تکامل Firestore، آمار اشکال زدایی در معرض تغییر است. ممکن است شامل موارد زیر باشد: { "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 (پیش‌فرض)، پرس‌وجو برنامه‌ریزی می‌شود و تنها معیارهای مربوط به مراحل برنامه‌ریزی را برمی‌گرداند.

وقتی درست باشد، پرس و جو برنامه ریزی و اجرا می شود و نتایج کامل پرس و جو را به همراه معیارهای مرحله برنامه ریزی و اجرا برمی گرداند.

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 or 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

اگر لیست باید اسناد گم شده را نشان دهد.

اگر سندی وجود نداشته باشد، وجود ندارد، اما اسناد فرعی در زیر آن وجود دارد. در صورت درست بودن، چنین اسناد گمشده با یک کلید بازگردانده می‌شوند، اما فیلدها، create_time ، یا update_time set ندارند.

درخواست‌های دارای 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 نشان داده می شوند، نباید بیش از 1500 بایت باشند و نمی توانند خالی باشند.

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 حداکثر 2 پارتیشن را برمی گرداند تا مجموع 10 پارتیشن مشخص شده در partition_count را تکمیل کند.

StructuredQuery

یک پرس و جو ساختار یافته پرس و جو باید مجموعه ای را با همه فرزندان مشخص کند و بر اساس نام صعودی مرتب شود. سایر فیلترها، تعداد دفعات سفارش، محدودیت‌ها، افست‌ها و نشانگرهای شروع/پایان پشتیبانی نمی‌شوند.

Timestamp

اسناد را همانطور که در زمان معین بودند می خواند.

این باید یک مهر زمانی دقیق میکروثانیه در یک ساعت گذشته باشد، یا اگر بازیابی نقطه در زمان فعال باشد، می‌تواند یک مهر زمانی کامل در 7 روز گذشته باشد.

Cursor

نتایج پارتیشن هر پارتیشن یک نقطه تقسیم است که می تواند توسط RunQuery به عنوان نقطه شروع یا پایان برای نتایج پرس و جو استفاده شود. درخواست های RunQuery باید با همان پرس و جوی ارائه شده به این درخواست PartitionQuery انجام شود. نشانگرهای پارتیشن مطابق با همان ترتیبی که نتایج پرس و جو ارائه شده به PartitionQuery ترتیب داده می شود.

به عنوان مثال، اگر یک درخواست PartitionQuery نشانگرهای پارتیشن A و B را برمی گرداند، اجرای سه پرس و جو زیر کل مجموعه نتایج پرس و جو اصلی را برمی گرداند:

• query، end_at A
• پرس و جو، start_at A، end_at B
• پرس و جو، start_at B

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

string

نشانه صفحه ای که ممکن است برای درخواست مجموعه ای اضافی از نتایج، حداکثر تا تعداد مشخص شده توسط partition_count در درخواست PartitionQuery استفاده شود. اگر خالی باشد، نتیجه دیگری وجود ندارد.

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

تجمع را در یک معامله از قبل فعال اجرا کنید.

مقدار در اینجا شناسه معامله مات برای اجرای پرس و جو در است.

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 یک نام پیش فرض را به دنبال Format 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__ مشخص نشده باشد ، به طور پیش فرض ضمیمه می شود.

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

• 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

هنگامی که نادرست است ، فقط مجموعه هایی را انتخاب می کند که فرزندان فوری parent هستند که در RunQueryRequest حاوی مشخص شده اند. هنگامی که درست است ، همه مجموعه های فرزندان را انتخاب می کند.

Operator

اپراتور برای ترکیب چندین فیلتر.

Filter

لیست فیلترها برای ترکیب.

نیاز دارد:

• حداقل یک فیلتر موجود است.

FieldReference

فیلد فیلتر شده توسط.

Operator

اپراتور برای فیلتر کردن توسط.

Value

مقدار مقایسه با.

string

اشاره به یک زمینه در یک سند.

نیاز دارد:

• باید یک بخش از بخش های Dot-Delimited ( . ) باشد ، جایی که هر بخش با محدودیت های document field name مطابقت دارد.

CompositeFilter

یک فیلتر کامپوزیت.

FieldFilter

یک فیلتر در یک زمینه سند.

UnaryFilter

فیلتر که دقیقاً یک آرگومان را می گیرد.

FieldReference

ضروری. یک قسمت بردار ایندکس برای جستجو. فقط اسنادی که حاوی بردارهایی هستند که ابعاد آنها با query_veector مطابقت دارد می توانند برگردانده شوند.

Value

ضروری. وکتور پرس و جو مورد نظر ما. باید یک بردار بیش از 2048 ابعاد باشد.

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

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

این مقدار فقط در صورت ارائه 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_ids در یک عکس فوری سازگار نیستند حذف شده اند).

این جریان تضمین می شود که هر زمان که کل جریان به یک عکس فوری جدید برسد ، یک read_time با target_ids خالی ارسال کنید. پیام های اضافه شده ، فعلی و تنظیم مجدد تضمین می شوند تا (در نهایت) در یک عکس فوری سازگار جدید (در حالی که no_change و حذف پیام ها نیستند) تضمین می شوند.

برای یک جریان معین ، read_time تضمین می شود که به صورت یکنواخت افزایش می یابد.

ReadOnly

معامله فقط برای عملیات خواندن قابل استفاده است.

ReadWrite

معامله می تواند برای هر دو عملیات خواندن و نوشتن استفاده شود.

Timestamp

اسناد را در زمان معین می خواند.

این باید یک زمان سنجی دقیق میکرو ثانیه در طی یک ساعت گذشته باشد ، یا اگر بازیابی نقطه به موقع فعال شود ، علاوه بر این می تواند در 7 روز گذشته یک جدول زمانی کامل باشد.

bytes

یک معامله اختیاری برای امتحان کردن.

Document

ضروری. سند به روز شده اگر قبلاً وجود نداشته باشد ، سند را ایجاد می کند.

DocumentMask

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

اگر این سند روی سرور وجود داشته باشد و زمینه هایی را در ماسک ارجاع ندهد ، بدون تغییر باقی می مانند. زمینه های ارجاع شده در ماسک ، اما در سند ورودی موجود نیست ، از سند موجود در سرور حذف می شوند.

DocumentMask

زمینه های بازگشت. اگر تنظیم نشده باشد ، همه زمینه ها را برمی گرداند.

اگر این سند زمینه ای داشته باشد که در این ماسک وجود ندارد ، آن قسمت در پاسخ بازگردانده نمی شود.

Precondition

پیش شرط اختیاری در سند. در صورت تنظیم این درخواست ، درخواست شکست خواهد خورد و توسط سند هدف برآورده نمی شود.

NullValue

یک مقدار تهی

bool

یک مقدار بولی

int64

یک مقدار عدد صحیح

double

یک مقدار دو برابر

Timestamp

یک مقدار Timestamp.

دقیق فقط به میکرو ثانیه. هنگام ذخیره ، هرگونه دقت اضافی گرد می شود.

string

یک مقدار رشته

رشته ، به عنوان UTF -8 ، نباید از 1 MIB - 89 بایت تجاوز کند. فقط 1500 بایت اول نمایندگی UTF-8 توسط نمایش داده شد.

bytes

مقدار بایت

نباید بیش از 1 MIB - 89 بایت باشد. فقط 1500 بایت اول توسط نمایش داده شد.

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-Th مربوط به نوشتن I-Th در درخواست است.

Timestamp

زمان وقوع تعهد. هر خواندن با یک read_time برابر یا بیشتر برای دیدن اثرات نوشتن تضمین شده است.

Timestamp

آخرین زمان به روزرسانی سند پس از استفاده از نوشتن. بعد از delete تنظیم نشده است.

اگر نوشتن در واقع سند را تغییر نداد ، این به روزرسانی قبلی خواهد بود.

Value

نتایج استفاده از هر DocumentTransform.FieldTransform ، به همان ترتیب.