אינדקס
-
FirestoreAdmin
(ממשק) -
CreateIndexRequest
(הודעה) -
DeleteIndexRequest
(הודעה) -
ExportDocumentsMetadata
(הודעה) -
ExportDocumentsRequest
(הודעה) -
ExportDocumentsResponse
(הודעה) -
GetIndexRequest
(הודעה) -
ImportDocumentsMetadata
(הודעה) -
ImportDocumentsRequest
(הודעה) -
Index
(הודעה) -
Index.State
(enum) -
IndexField
(הודעה) -
IndexField.Mode
(enum) -
IndexOperationMetadata
(הודעה) -
IndexOperationMetadata.OperationType
(enum) -
ListIndexesRequest
(הודעה) -
ListIndexesResponse
(הודעה) -
LocationMetadata
(הודעה) -
OperationState
(enum) -
Progress
(הודעה)
FirestoreAdmin
ממשק ה-API של Cloud Firestore Admin.
ממשק API זה מספק מספר שירותי ניהול עבור Cloud Firestore.
מושגים
פרויקט, מסד נתונים, מרחב שמות, אוסף ומסמך משמשים כפי שהוגדרו ב-Google Cloud Firestore API.
פעולה: פעולה מייצגת עבודה שמתבצעת ברקע.
שירותים
אינדקס
שירות האינדקס מנהל אינדקסים של Cloud Firestore.
יצירת האינדקס מתבצעת באופן אסינכרוני. נוצר משאב פעולה עבור כל פעולה אסינכרונית כזו. ניתן לשאול את מצב הפעולה (כולל שגיאות כלשהן) דרך משאב הפעולה.
מטא נתונים
מספק מטא נתונים ומידע סטטיסטי על נתונים ב-Cloud Firestore. הנתונים שסופקו כחלק מ-API זה עשויים להיות מיושנים.
מבצע
אוסף הפעולות מספק תיעוד של פעולות שבוצעו עבור הפרויקט שצוין (כולל פעולות כלשהן בתהליך). פעולות לא נוצרות ישירות אלא באמצעות קריאות לאוספים או משאבים אחרים.
פעולה שעדיין לא בוצעה עשויה להתבטל. הבקשה לביטול היא אסינכרונית והפעולה עשויה להמשיך לפעול במשך זמן מה לאחר הגשת הבקשה לביטול.
פעולה שנעשתה עשויה להימחק כך שהיא לא רשומה עוד כחלק מאוסף הפעולה.
הפעולות נוצרות על ידי השירות FirestoreAdmin
, אך הגישה אליהן מתבצעת דרך השירות google.longrunning.Operations
.
CreateIndex |
---|
יוצר את האינדקס שצוין. המצב ההתחלתי של אינדקס חדש הוא במהלך היצירה, התהליך עלול לגרום לשגיאה, ובמקרה זה האינדקס יעבור למצב לא ניתן ליצור אינדקסים עם שדה בודד.
|
מחק אינדקס |
---|
מוחק אינדקס.
|
ייצא מסמכים |
---|
מייצא עותק של כל המסמכים או חלק מהם מ-Google Cloud Firestore למערכת אחסון אחרת, כגון Google Cloud Storage. ייתכן שעדכונים אחרונים למסמכים לא ישתקפו בייצוא. הייצוא מתרחש ברקע וניתן לעקוב אחר התקדמותו ולנהל אותו באמצעות משאב התפעול שנוצר. ניתן להשתמש בפלט של ייצוא רק לאחר ביצוע הפעולה הקשורה. אם פעולת ייצוא תבוטל לפני השלמתה, היא עלולה להשאיר נתונים חלקיים מאחור ב-Google Cloud Storage.
|
GetIndex |
---|
מקבל מדד.
|
ייבוא מסמכים |
---|
מייבא מסמכים ל-Google Cloud Firestore. מסמכים קיימים בעלי אותו שם נמחקים. הייבוא מתרחש ברקע וניתן לעקוב אחר התקדמותו ולנהל אותו באמצעות משאב התפעול שנוצר. אם פעולת ImportDocuments מבוטלת, ייתכן שקבוצת משנה של הנתונים כבר יובאה ל-Cloud Firestore.
|
רשימה אינדקסים |
---|
מפרט את האינדקסים התואמים את המסננים שצוינו.
|
CreateIndexRequest
הבקשה עבור FirestoreAdmin.CreateIndex
.
שדות | |
---|---|
parent | שם מסד הנתונים שהאינדקס הזה יחול עליו. לדוגמה: |
index | האינדקס ליצירת. שדות השם והמצב הם פלט בלבד ויתעלמו מהם. לא ניתן ליצור או למחוק אינדקסים מסוימים של שדות בודדים. |
DeleteIndexRequest
הבקשה עבור FirestoreAdmin.DeleteIndex
.
שדות | |
---|---|
name | שם האינדקס. לדוגמה: |
ExportDocumentsMetadata
מטא נתונים עבור פעולות 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 (פרויקט זה או פרויקט אחר) לאחר שהפעולה תסתיים בהצלחה. |
GetIndexRequest
הבקשה עבור FirestoreAdmin.GetIndex
.
שדות | |
---|---|
name | שם האינדקס. לדוגמה: |
ImportDocumentsMetadata
מטא נתונים עבור פעולות 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_ של ExportDocumentsResponse מיצוא שהסתיים בהצלחה. ראה: |
אינדקס
הגדרה של אינדקס.
שדות | |
---|---|
name | שם המשאב של האינדקס. פלט בלבד. |
collection_id | מזהה האוסף עליו חל אינדקס זה. נדרש. |
fields[] | השדות לאינדקס. |
state | מצב המדד. פלט בלבד. |
מדינה
מצבו של מדד. במהלך יצירת האינדקס, אינדקס יהיה במצב CREATING
. אם האינדקס נוצר בהצלחה, הוא יעבור למצב READY
. אם לא ניתן ליצור את האינדקס, הוא יעבור למצב ERROR
.
תקצירים | |
---|---|
STATE_UNSPECIFIED | המדינה לא מוגדרת. |
CREATING | האינדקס מתבצע. ישנה פעולה פעילה לטווח ארוך עבור המדד. האינדקס מתעדכן בעת כתיבת מסמך. ייתכן שקיימים נתוני אינדקס מסוימים. |
READY | האינדקס מוכן לשימוש. האינדקס מתעדכן בעת כתיבת מסמך. האינדקס מאוכלס במלואו מכל המסמכים המאוחסנים שהוא חל עליהם. |
ERROR | האינדקס נוצר, אבל משהו השתבש. לא קיימת פעולה פעילה ארוכת טווח עבור האינדקס, והפעולה הארוכה שהסתיימה לאחרונה נכשלה. האינדקס לא מתעדכן בעת כתיבת מסמך. ייתכן שקיימים נתוני אינדקס מסוימים. |
IndexField
שדה של אינדקס.
שדות | |
---|---|
field_path | דרך השדה. חייב להתאים למפרט נתיב השדה המתואר על ידי [google.firestore.v1beta1.Document.fields][fields]. נתיב שדה מיוחד |
mode | מצב השדה. |
מצב
המצב קובע כיצד שדה מתווסף לאינדקס.
תקצירים | |
---|---|
MODE_UNSPECIFIED | המצב אינו מוגדר. |
ASCENDING | ערכי השדה מתווספים לאינדקס כדי לתמוך ברצף בסדר עולה וגם בשאילתה לפי <, >, <=, >= ו-=. |
DESCENDING | ערכי השדה מתווספים לאינדקס כדי לתמוך ברצף בסדר יורד וגם בשאילתה לפי <, >, <=, >= ו-=. |
ARRAY_CONTAINS | ערכי המערך של השדה מתווספים לאינדקס כדי לתמוך בחברות באמצעות שאילתות ARRAY_CONTAINS. |
IndexOperationMetadata
מטא נתונים עבור פעולות אינדקס. מטא נתונים אלה מאכלסים את שדה המטא נתונים של google.longrunning.Operation
.
שדות | |
---|---|
start_time | הזמן שבו החלה העבודה על המבצע. |
end_time | הזמן שבו הסתיימה הפעולה, בהצלחה או אחרת. בטל אם הפעולה עדיין פעילה. |
index | משאב האינדקס שעליו פועלת פעולה זו. לדוגמה: |
operation_type | סוג פעולת המדד. |
cancelled | נכון אם |
document_progress | התקדמות הפעולה הקיימת, נמדדת במספר מסמכים. |
OperationType
סוג פעולת המדד.
תקצירים | |
---|---|
OPERATION_TYPE_UNSPECIFIED | לא מצוין. אף פעם לא מוגדר על ידי שרת. |
CREATING_INDEX | הפעולה היא יצירת האינדקס. יזום על ידי קריאת CreateIndex . |
ListIndexRequest
הבקשה עבור FirestoreAdmin.ListIndexes
.
שדות | |
---|---|
parent | שם מסד הנתונים. לדוגמה: |
filter | |
page_size | גודל עמוד הרשימה הסטנדרטי. |
page_token | אסימון עמוד הרשימה הסטנדרטי. |
ListIndexResponse
התגובה עבור FirestoreAdmin.ListIndexes
.
שדות | |
---|---|
indexes[] | האינדקסים. |
next_page_token | אסימון הרשימה הסטנדרטי של העמוד הבא. |
מיקום מטא נתונים
לסוג זה אין שדות.
הודעת המטא נתונים עבור google.cloud.location.Location.metadata
.
OperationState
המצבים השונים האפשריים למבצע מתמשך.
תקצירים | |
---|---|
STATE_UNSPECIFIED | לא מצוין. |
INITIALIZING | הבקשה בהכנה לעיבוד. |
PROCESSING | הבקשה נמצאת בעיבוד פעיל. |
CANCELLING | הבקשה נמצאת בתהליך ביטול לאחר שהמשתמש קרא google.longrunning.Operations.Cancelפעולה על הפעולה. |
FINALIZING | הבקשה טופלה ונמצאת בשלב הגמר שלה. |
SUCCESSFUL | הבקשה הסתיימה בהצלחה. |
FAILED | עיבוד הבקשה הסתיים, אך נתקלה בשגיאה. |
CANCELLED | הבקשה הסתיימה להתבטל לאחר שהמשתמש קרא google.longrunning.Operations.CancelOperation. |
התקדמות
מודד את ההתקדמות של מדד מסוים.
שדות | |
---|---|
work_completed | הערכה של כמה עבודה הושלמה. שים לב שזה עשוי להיות גדול מ- |
work_estimated | הערכה של כמה עבודה צריך לבצע. אפס אם אומדן העבודה אינו זמין. עשוי להשתנות ככל שהעבודה מתקדמת. |