فهرست مطالب
-
FirestoreAdmin
(رابط) -
CreateIndexRequest
(پیام) -
DeleteIndexRequest
(پیام) -
ExportDocumentsMetadata
(پیام) -
ExportDocumentsRequest
(پیام) -
ExportDocumentsResponse
(پیام) -
Field
(پیام) -
Field.IndexConfig
(پیام) -
FieldOperationMetadata
(پیام) -
FieldOperationMetadata.IndexConfigDelta
(پیام) -
FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum) -
GetFieldRequest
(پیام) -
GetIndexRequest
(پیام) -
ImportDocumentsMetadata
(پیام) -
ImportDocumentsRequest
(پیام) -
Index
(پیام) -
Index.IndexField
(پیام) -
Index.IndexField.ArrayConfig
(enum) -
Index.IndexField.Order
(enum) -
Index.QueryScope
(enum) -
Index.State
(تعدادی) -
IndexOperationMetadata
(پیام) -
ListFieldsRequest
(پیام) -
ListFieldsResponse
(پیام) -
ListIndexesRequest
(پیام) -
ListIndexesResponse
(پیام) -
OperationState
(تعدادی) -
Progress
(پیام) -
UpdateFieldRequest
(پیام)
Firestore Admin
عملیات توسط سرویس FirestoreAdmin
ایجاد می شود، اما از طریق سرویس google.longrunning.Operations
قابل دسترسی است.
CreateIndex |
---|
یک شاخص ترکیبی ایجاد می کند. این یک
|
حذف ایندکس |
---|
یک شاخص ترکیبی را حذف می کند.
|
صادرات اسناد |
---|
یک کپی از همه یا زیر مجموعه ای از اسناد را از Google Cloud Firestore به سیستم ذخیره سازی دیگری مانند Google Cloud Storage صادر می کند. بهروزرسانیهای اخیر اسناد ممکن است در صادرات منعکس نشود. صادرات در پسزمینه اتفاق میافتد و میتوان پیشرفت آن را از طریق منبع عملیاتی ایجاد شده کنترل و مدیریت کرد. خروجی یک صادرات فقط زمانی می تواند مورد استفاده قرار گیرد که عملیات مربوطه انجام شود. اگر عملیات صادرات قبل از تکمیل لغو شود، ممکن است دادههای جزئی در Google Cloud Storage باقی بماند.
|
GetField |
---|
فراداده و پیکربندی یک فیلد را دریافت می کند.
|
GetIndex |
---|
یک شاخص ترکیبی می گیرد.
|
Import Documents |
---|
اسناد را به Google Cloud Firestore وارد می کند. اسناد موجود با همین نام رونویسی می شوند. واردات در پسزمینه اتفاق میافتد و میتوان پیشرفت آن را از طریق منبع عملیاتی که ایجاد میشود، نظارت و مدیریت کرد. اگر عملیات ImportDocuments لغو شود، ممکن است زیر مجموعه ای از داده ها قبلاً به Cloud Firestore وارد شده باشد.
|
ListFields |
---|
پیکربندی فیلد و ابرداده را برای این پایگاه داده فهرست می کند. در حال حاضر،
|
فهرست ایندکس ها |
---|
فهرست های ترکیبی را فهرست می کند.
|
UpdateField |
---|
پیکربندی فیلد را به روز می کند. در حال حاضر، بهروزرسانیهای فیلد فقط برای پیکربندی فهرست یک فیلد اعمال میشود. با این حال، فراخوانی به این تماس یک برای پیکربندی تنظیمات فیلد پیشفرض برای پایگاه داده، از
|
CreateIndexRequest
درخواست FirestoreAdmin.CreateIndex
.
زمینه های | |
---|---|
parent | نام والد فرم |
index | شاخص ترکیبی برای ایجاد. |
DeleteIndexRequest
درخواست FirestoreAdmin.DeleteIndex
.
زمینه های | |
---|---|
name | نامی از |
ExportDocumentsMetadata
فراداده برای google.longrunning.Operation
نتایج عملیات از FirestoreAdmin.ExportDocuments
.
زمینه های | |
---|---|
start_time | زمانی که این عملیات شروع شد. |
end_time | زمان تکمیل این عملیات اگر عملیات هنوز در حال انجام باشد، تنظیم نخواهد شد. |
operation_state | وضعیت عملیات صادرات. |
progress_documents | پیشرفت، در اسناد، این عملیات. |
progress_bytes | پیشرفت این عملیات بر حسب بایت. |
collection_ids[] | کدام شناسه های مجموعه در حال صادرات هستند. |
output_uri_prefix | جایی که نهادها به آن صادر می شوند. |
ExportDocumentsRequest
درخواست FirestoreAdmin.ExportDocuments
.
زمینه های | |
---|---|
name | پایگاه داده برای صادرات باید به این شکل باشد: |
collection_ids[] | کدام شناسه مجموعه را صادر کنیم. نامشخص یعنی همه مجموعه ها. |
output_uri_prefix | URI خروجی در حال حاضر فقط از URIهای Google Cloud Storage به شکل: |
ExportDocumentsResponse
در فیلد پاسخ google.longrunning.Operation
بازگردانده شد.
زمینه های | |
---|---|
output_uri_prefix | محل قرارگیری فایل های خروجی این می تواند برای شروع وارد کردن به Cloud Firestore (این پروژه یا پروژه دیگر) پس از تکمیل موفقیت آمیز عملیات استفاده شود. |
رشته
نشان دهنده یک فیلد واحد در پایگاه داده است.
فیلدها توسط "گروه مجموعه" خود گروه بندی می شوند، که همه مجموعه های موجود در پایگاه داده را با شناسه یکسان نشان می دهد.
زمینه های | |
---|---|
name | نام فیلد یک مسیر فیلد ممکن است یک نام فیلد ساده، به عنوان مثال مسیرهای فیلد ممکن است با استفاده از مثالها: (توجه: نظرات در اینجا با نحو علامتگذاری نوشته میشوند، بنابراین یک لایه بکتیک اضافی برای نمایش یک بلوک کد وجود دارد) یک |
index_config | پیکربندی شاخص برای این فیلد. اگر تنظیم نشود، نمایه سازی فیلد به پیکربندی تعریف شده توسط |
IndexConfig
پیکربندی شاخص برای این فیلد.
زمینه های | |
---|---|
indexes[] | شاخص های پشتیبانی شده برای این زمینه |
uses_ancestor_config | فقط خروجی وقتی درست است، پیکربندی نمایه |
ancestor_field | فقط خروجی نام منبع |
reverting | فقط خروجی وقتی درست است، پیکربندی نمایه |
FieldOperationMetadata
فراداده برای نتایج google.longrunning.Operation
از FirestoreAdmin.UpdateField
.
زمینه های | |
---|---|
start_time | زمانی که این عملیات شروع شد. |
end_time | زمان تکمیل این عملیات اگر عملیات هنوز در حال انجام باشد، تنظیم نخواهد شد. |
field | منبع میدانی که این عملیات روی آن عمل می کند. برای مثال: |
index_config_deltas[] | فهرستی از |
state | وضعیت عملیات. |
document_progress | پیشرفت، در اسناد، این عملیات. |
bytes_progress | پیشرفت این عملیات بر حسب بایت. |
IndexConfigDelta
اطلاعات مربوط به تغییر پیکربندی شاخص
زمینه های | |
---|---|
change_type | نحوه تغییر شاخص را مشخص می کند. |
index | شاخص در حال تغییر است. |
تغییر نوع
نحوه تغییر شاخص را مشخص می کند.
Enums | |
---|---|
CHANGE_TYPE_UNSPECIFIED | نوع تغییر مشخص یا مشخص نیست. |
ADD | فهرست تک فیلد در حال اضافه شدن است. |
REMOVE | فهرست تک فیلد در حال حذف شدن است. |
GetFieldRequest
درخواست FirestoreAdmin.GetField
.
زمینه های | |
---|---|
name | نام |
GetIndexRequest
درخواست FirestoreAdmin.GetIndex
.
زمینه های | |
---|---|
name | نامی از |
ImportDocumentsMetadata
فراداده برای google.longrunning.Operation
نتایج عملیات از FirestoreAdmin.ImportDocuments
.
زمینه های | |
---|---|
start_time | زمانی که این عملیات شروع شد. |
end_time | زمان تکمیل این عملیات اگر عملیات هنوز در حال انجام باشد، تنظیم نخواهد شد. |
operation_state | وضعیت عملیات واردات. |
progress_documents | پیشرفت، در اسناد، این عملیات. |
progress_bytes | پیشرفت این عملیات بر حسب بایت. |
collection_ids[] | کدام شناسه های مجموعه در حال وارد شدن هستند. |
input_uri_prefix | محل اسناد وارد شده |
ImportDocumentsRequest
درخواست FirestoreAdmin.ImportDocuments
.
زمینه های | |
---|---|
name | پایگاه داده برای وارد کردن باید به این شکل باشد: |
collection_ids[] | کدام شناسه مجموعه را وارد کنید. نامشخص به معنای تمام مجموعه های موجود در واردات است. |
input_uri_prefix | محل فایل های صادر شده این باید با output_uri_prefix یک ExportDocumentsResponse از صادراتی که با موفقیت انجام شده است مطابقت داشته باشد. ببینید: |
فهرست مطالب
نمایه های Cloud Firestore پرس و جوهای ساده و پیچیده را در برابر اسناد موجود در پایگاه داده فعال می کنند.
زمینه های | |
---|---|
name | فقط خروجی یک نام سرور برای این فهرست تعریف شده است. شکل این نام برای نمایه های ترکیبی به این صورت خواهد بود: |
query_scope | نمایههایی با محدوده جستجوی مجموعه مشخص شده، درخواستهایی را در برابر مجموعهای که فرزند یک سند خاص است، مشخص شده در زمان پرس و جو، و دارای همان شناسه مجموعه است، اجازه میدهند. نمایههایی با محدوده پرس و جوی گروه مجموعه مشخص شده، درخواستهایی را در برابر همه مجموعههایی که از یک سند خاص، مشخص شده در زمان پرسوجو مشخص شدهاند، اجازه میدهند که همان شناسه مجموعه را با این فهرست دارند. |
fields[] | فیلدهای پشتیبانی شده توسط این شاخص برای شاخص های ترکیبی، این همیشه 2 یا بیشتر فیلد است. آخرین ورودی فیلد همیشه برای مسیر فیلد برای فهرست های تک فیلد، این همیشه دقیقاً یک ورودی با مسیر فیلد برابر با مسیر فیلد مربوطه خواهد بود. |
state | فقط خروجی وضعیت خدمات شاخص. |
IndexField
یک فیلد در یک شاخص field_path توضیح می دهد که کدام فیلد ایندکس شده است، value_mode نحوه نمایه شدن مقدار فیلد را توضیح می دهد.
زمینه های | |
---|---|
field_path | می تواند نام باشد. برای فهرست های تک فیلد، این باید با نام فیلد مطابقت داشته باشد یا ممکن است حذف شود. |
فیلد اتحادیه value_mode . چگونه مقدار فیلد ایندکس می شود. value_mode فقط می تواند یکی از موارد زیر باشد: | |
order | نشان می دهد که این فیلد از ترتیب با ترتیب مشخص شده یا مقایسه با استفاده از =، <، <=، >، >= پشتیبانی می کند. |
array_config | نشان می دهد که این فیلد از عملیات روی |
ArrayConfig
تنظیمات ارزش آرایه پشتیبانی شده
Enums | |
---|---|
ARRAY_CONFIG_UNSPECIFIED | این فهرست از پرس و جوهای آرایه اضافی پشتیبانی نمی کند. |
CONTAINS | ایندکس از پرس و جوهای مربوط به آرایه پشتیبانی می کند. |
سفارش
سفارشات پشتیبانی شده
Enums | |
---|---|
ORDER_UNSPECIFIED | سفارش مشخص نیست گزینه معتبری نیست |
ASCENDING | فیلد بر اساس مقدار فیلد صعودی مرتب می شود. |
DESCENDING | فیلد بر اساس مقدار فیلد نزولی مرتب می شود. |
QueryScope
Query Scope محدوده ای را که یک پرس و جو در آن اجرا می شود را تعریف می کند. این در یک فیلد StructuredQuery from
مشخص شده است.
Enums | |
---|---|
QUERY_SCOPE_UNSPECIFIED | محدوده پرس و جو مشخص نشده است. گزینه معتبری نیست |
COLLECTION | نمایههایی با محدوده جستجوی مجموعه مشخص شده، درخواستهایی را در برابر مجموعهای که فرزند یک سند خاص است، مشخص شده در زمان پرس و جو، و دارای شناسه مجموعه مشخص شده توسط ایندکس است، اجازه میدهند. |
COLLECTION_GROUP | نمایههایی با محدوده پرس و جوی گروه مجموعه مشخص شده، درخواستهایی را در برابر همه مجموعههایی که دارای شناسه مجموعه مشخص شده توسط ایندکس هستند، اجازه میدهند. |
حالت
وضعیت یک شاخص در طول ایجاد ایندکس، یک نمایه در حالت CREATING
خواهد بود. اگر نمایه با موفقیت ایجاد شود، به حالت READY
منتقل می شود. اگر ایجاد ایندکس با مشکل مواجه شود، ایندکس به حالت NEEDS_REPAIR
منتقل میشود.
Enums | |
---|---|
STATE_UNSPECIFIED | ایالت نامشخص است. |
CREATING | شاخص در حال ایجاد است. یک عملیات طولانی مدت فعال برای شاخص وجود دارد. نمایه هنگام نوشتن یک سند به روز می شود. برخی از داده های شاخص ممکن است وجود داشته باشد. |
READY | شاخص آماده استفاده است. نمایه هنگام نوشتن یک سند به روز می شود. فهرست به طور کامل از تمام اسناد ذخیره شده ای که برای آنها اعمال می شود پر شده است. |
NEEDS_REPAIR | شاخص در حال ایجاد بود، اما مشکلی پیش آمد. هیچ عملیات بلندمدت فعالی برای شاخص وجود ندارد و آخرین عملیات بلندمدت به پایان رسیده با شکست مواجه شد. هنگام نوشتن یک سند، ایندکس به روز نمی شود. برخی از داده های شاخص ممکن است وجود داشته باشد. از google.longrunning.Operations API استفاده کنید تا مشخص کنید چرا عملیاتی که آخرین بار برای ایجاد این نمایه انجام شد شکست خورده است، سپس فهرست را دوباره ایجاد کنید. |
IndexOperationMetadata
فراداده برای google.longrunning.Operation
نتایج عملیات از FirestoreAdmin.CreateIndex
.
زمینه های | |
---|---|
start_time | زمانی که این عملیات شروع شد. |
end_time | زمان تکمیل این عملیات اگر عملیات هنوز در حال انجام باشد، تنظیم نخواهد شد. |
index | منبع شاخصی که این عملیات روی آن عمل می کند. برای مثال: |
state | وضعیت عملیات. |
progress_documents | پیشرفت، در اسناد، این عملیات. |
progress_bytes | پیشرفت این عملیات بر حسب بایت. |
ListFieldsRequest
درخواست FirestoreAdmin.ListFields
.
زمینه های | |
---|---|
parent | نام والد فرم |
filter | فیلتری که باید در نتایج فهرست اعمال شود. در حال حاضر، |
page_size | تعداد نتایج برای بازگشت. |
page_token | یک نشانه صفحه، که از تماس قبلی به |
ListFieldsResponse
پاسخ برای FirestoreAdmin.ListFields
.
زمینه های | |
---|---|
fields[] | فیلدهای درخواستی |
next_page_token | نشانه صفحه ای که ممکن است برای درخواست صفحه دیگری از نتایج استفاده شود. اگر خالی باشد، این آخرین صفحه است. |
ListIndexesRequest
درخواست FirestoreAdmin.ListIndexes
.
زمینه های | |
---|---|
parent | نام والد فرم |
filter | فیلتری که باید در نتایج فهرست اعمال شود. |
page_size | تعداد نتایج برای بازگشت. |
page_token | یک نشانه صفحه، که از تماس قبلی با |
ListIndexesResponse
پاسخ برای FirestoreAdmin.ListIndexes
.
زمینه های | |
---|---|
indexes[] | شاخص های درخواستی |
next_page_token | نشانه صفحه ای که ممکن است برای درخواست صفحه دیگری از نتایج استفاده شود. اگر خالی باشد، این آخرین صفحه است. |
حالت عملیاتی
وضعیت عملیات را شرح می دهد.
Enums | |
---|---|
OPERATION_STATE_UNSPECIFIED | نامشخص |
INITIALIZING | درخواست در حال آماده سازی برای پردازش است. |
PROCESSING | درخواست به طور فعال در حال پردازش است. |
CANCELLING | پس از اینکه کاربر google.longrunning.Operations.CancelOperation را در عملیات نامید، درخواست در حال لغو شدن است. |
FINALIZING | درخواست رسیدگی شده و در مرحله نهایی شدن است. |
SUCCESSFUL | درخواست با موفقیت انجام شد. |
FAILED | پردازش درخواست به پایان رسید، اما با خطا مواجه شد. |
CANCELLED | پس از اینکه کاربر google.longrunning.Operations.CancelOperation را نامید، درخواست لغو شد. |
پیش رفتن
پیشرفت عملیات را شرح می دهد. واحد کار عمومی است و باید بر اساس جایی که Progress
استفاده می شود تفسیر شود.
زمینه های | |
---|---|
estimated_work | میزان کار برآورد شده |
completed_work | مقدار کار انجام شده. |
UpdateFieldRequest
درخواست FirestoreAdmin.UpdateField
.
زمینه های | |
---|---|
field | زمینه به روز رسانی |
update_mask | یک ماسک، نسبت به میدان. در صورت مشخص شدن، فقط پیکربندی مشخص شده توسط این field_mask در فیلد به روز می شود. |