Package google.firestore.admin.v1beta2

אינדקס

FirestoreAdmin

הפעולות נוצרות על ידי השירות FirestoreAdmin, אבל אפשר לגשת אליהן דרך השירות google.longrunning.Operations.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

יצירת אינדקס מורכב. פעולה זו מחזירה google.longrunning.Operation שניתן להשתמש בו כדי לעקוב אחר סטטוס היצירה. המטא-נתונים של הפעולה יהיו מסוג IndexOperationMetadata.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

מחיקת אינדקס מורכב.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

ייצוא עותק של כל המסמכים או של קבוצת משנה שלהם מ-Google Cloud Firestore למערכת אחסון אחרת, כמו Google Cloud Storage. ייתכן שהעדכונים האחרונים במסמכים לא יבואו לידי ביטוי בייצוא. הייצוא מתרחש ברקע, ואפשר לעקוב אחר ההתקדמות שלו ולנהל אותה באמצעות משאב הפעולה שנוצר. אפשר להשתמש בפלט של ייצוא רק לאחר סיום הפעולה המשויכת. אם פעולת ייצוא מתבטלת לפני הסיום, היא עלולה להשאיר נתונים חלקיים ב-Google Cloud Storage.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
GetField

rpc GetField(GetFieldRequest) returns (Field)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

הפונקציה מקבלת אינדקס מורכב.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

מייבאת מסמכים אל Google Cloud Firestore. מסמכים קיימים עם אותו שם יוחלפו. הייבוא מתבצע ברקע, וניתן לעקוב אחר ההתקדמות שלו ולנהל אותה באמצעות משאב הפעולה שנוצר. אם פעולת ImportDocuments בוטלה, יכול להיות שקבוצת משנה של הנתונים כבר יובאה אל Cloud Firestore.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

פירוט ההגדרות והמטא-נתונים של השדות למסד הנתונים הזה.

בשלב זה, FirestoreAdmin.ListFields תומך רק בשדות של כרטיסי מוצר שבוטלו באופן מפורש. כדי לבצע את השאילתה הזו, צריך להפעיל את המסנן FirestoreAdmin.ListFields ולהגדיר את המסנן indexConfig.usesAncestorConfig:false.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

בתיבת הדו-שיח הזו מפורטים אינדקסים מורכבים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.
UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

מעדכן הגדרות של שדה. בשלב הזה, העדכונים בשדות חלים רק על הגדרה של אינדקס של שדה אחד. עם זאת, שיחות אל FirestoreAdmin.UpdateField צריכות לספק אנונימיזציה של שדות כדי למנוע שינוי של הגדרות אישיות שהמתקשר לא מודע להן. אנונימיזציה של השדות צריכה להיות מוגדרת כ: { paths: "index_config" }.

הקריאה הזו מחזירה google.longrunning.Operation שעשוי לשמש למעקב אחר הסטטוס של עדכון השדה. המטא-נתונים של הפעולה יהיו מסוג FieldOperationMetadata.

כדי לקבוע את הגדרות ברירת המחדל של השדות עבור מסד הנתונים, יש להשתמש במשתנה Field המיוחד עם שם המשאב: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין בסקירה הכללית על אימות.

CreateIndexRequest

הבקשה על FirestoreAdmin.CreateIndex.

שדות
parent

string

שם הורה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

האינדקס המרוכב ליצירה.

DeleteIndexRequest

הבקשה על FirestoreAdmin.DeleteIndex.

שדות
name

string

שם הטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.ExportDocuments.

שדות
start_time

Timestamp

השעה שבה הפעולה הזו התחילה.
end_time

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
operation_state

OperationState

המצב של פעולת הייצוא.
progress_documents

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
progress_bytes

Progress

ההתקדמות בבייטים של הפעולה הזו.
collection_ids[]

string

אילו מזהי אוספים רוצים לייצא?
output_uri_prefix

string

היעד שאליו מתבצע ייצוא הישויות.

ExportDocumentsRequest

הבקשה על FirestoreAdmin.ExportDocuments.

שדות
name

string

מסד הנתונים לייצוא. הוא אמור להופיע בפורמט: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

אילו מזהי אוספים לייצא אם לא צוין אחרת, המשמעות היא כל האוספים.
output_uri_prefix

string

ה-URI של הפלט. נכון לעכשיו יש תמיכה במזהי URI של Google Cloud Storage בצורה הבאה: gs://BUCKET_NAME[/NAMESPACE_PATH], כאשר BUCKET_NAME הוא השם של הקטגוריה של Google Cloud Storage ו-NAMESPACE_PATH הוא נתיב אופציונלי של מרחב שמות ב-Google Cloud Storage. כשבוחרים שם, חשוב לפעול לפי ההנחיות למתן שמות ל-Google Cloud Storage: https://cloud.google.com/storage/docs/naming. אם ה-URI הוא קטגוריה (ללא נתיב מרחב שמות), תיווצר קידומת על סמך שעת ההתחלה.

ExportDocumentsResponse

הערך הוחזר בשדה התגובה google.longrunning.Operation.

שדות
output_uri_prefix

string

המיקום של קובצי הפלט. אפשר להשתמש בו כדי להתחיל לייבא ל-Cloud Firestore (הפרויקט הזה או פרויקט אחר) אחרי שהפעולה תסתיים בהצלחה.

שעון שדה

מייצג שדה אחד במסד הנתונים.

השדות מקובצים לפי 'קבוצת אוספים' שמייצגת את כל האוספים במסד הנתונים שיש להם אותו מזהה.

שדות
name

string

שם שדה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

נתיב של שדה יכול להיות שם של שדה פשוט, למשל address או נתיב לשדות בתוך map_value , כמו address.city, או נתיב של שדה מיוחד. השדה המיוחד החוקי היחיד הוא *, שמייצג כל שדה.

אפשר לצטט נתיבי שדות באמצעות (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` וכן באמצעות תווי ASCII.

דוגמאות: (הערה: התגובות כאן נכתבות בתחביר של סימני קריאה, כך שיש שכבה נוספת של סימני הטעמה שמייצגים בלוק קוד) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, ולא אף שדה.

Field מיוחד מכיל את הגדרות ברירת המחדל להוספה לאינדקס עבור כל השדות. שם המשאב בשדה הזה הוא: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* האינדקסים שהוגדרו ב-Field הזה יוחלו על כל השדות שאין להם תצורה משלהם של Field של אינדקס.
index_config

IndexConfig

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

IndexConfig

תצורת האינדקס עבור השדה הזה.

שדות
indexes[]

Index

האינדקסים הנתמכים עבור השדה הזה.
uses_ancestor_config

bool

פלט בלבד. כאשר הערך הוא True, הגדרת האינדקס של Field נקבעת לפי ההגדרות שמצוינות ב-ancestor_field. כשהערך הוא False, הגדרת האינדקס של Field מוגדרת באופן מפורש.
ancestor_field

string

פלט בלבד. המדיניות מציינת את שם המשאב של Field שממנו מוגדרת תצורת האינדקס של השדה הזה (כאשר uses_ancestor_config מוגדרת כ-True), או שממנו יש להגדיר את המשאב אם לא הייתה הגדרת אינדקס בשדה הזה (כאשר uses_ancestor_config מוגדרת כ-False).
reverting

bool

הפלט רק כאשר הערך הוא True, הגדרת האינדקס של Field נמצאת בתהליך החזרה לגרסה קודמת. בסיום, הגדרת האינדקס תעבור לאותו מצב כמו השדה שצוין על ידי ancestor_field. בשלב הזה uses_ancestor_config יהיה true ו-reverting יהיה false.

FieldOperationMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.UpdateField.

שדות
start_time

Timestamp

השעה שבה הפעולה הזו התחילה.
end_time

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
field

string

משאב השדה שעליו הפעולה הזו פועלת. לדוגמה: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

רשימה של IndexConfigDelta, שמתארת את כוונת הפעולה הזו.
state

OperationState

מצב הפעולה.
document_progress

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
bytes_progress

Progress

ההתקדמות בבייטים של הפעולה הזו.

IndexConfigDelta

מידע על שינוי בהגדרה של האינדקס.

שדות
change_type

ChangeType

מציין את השינויים באינדקס.
index

Index

האינדקס שמשתנה.

ChangeType

מציין את השינויים באינדקס.

טיפוסים בני מנייה (enums)
CHANGE_TYPE_UNSPECIFIED סוג השינוי לא מצוין או לא ידוע.
ADD המערכת מוסיפה את האינדקס של השדה היחיד.
REMOVE מתבצעת הסרה של האינדקס של השדה היחיד.

GetFieldRequest

הבקשה על FirestoreAdmin.GetField.

שדות
name

string

שם הטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

הבקשה על FirestoreAdmin.GetIndex.

שדות
name

string

שם הטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.ImportDocuments.

שדות
start_time

Timestamp

השעה שבה הפעולה הזו התחילה.
end_time

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
operation_state

OperationState

המצב של פעולת הייבוא.
progress_documents

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
progress_bytes

Progress

ההתקדמות בבייטים של הפעולה הזו.
collection_ids[]

string

אילו מזהי אוספים מיובאים.
input_uri_prefix

string

מיקום המסמכים המיובאים.

ImportDocumentsRequest

הבקשה על FirestoreAdmin.ImportDocuments.

שדות
name

string

מסד נתונים לייבוא. הוא אמור להופיע בפורמט: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

אילו מזהי אוספים לייבא המשמעות של 'לא צוין' היא כל האוספים הכלולים בייבוא.
input_uri_prefix

string

מיקום הקבצים שיוצאו. הערך הזה חייב להתאים לפלט_uri_prefix של ExportDocumentsResponse מייצוא שהושלם בהצלחה. למידע נוסף: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.

אינדקס

האינדקסים של Cloud Firestore מאפשרים לבצע שאילתות פשוטות ומורכבות על מסמכים במסד נתונים.

שדות
name

string

פלט בלבד. שם שהוגדר על ידי שרת לאינדקס הזה. אופן השם של אינדקסים מרוכבים יהיה: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} אם מדובר באינדקסים עם שדה יחיד, השדה הזה יהיה ריק.
query_scope

QueryScope

אינדקסים עם היקף שאילתת אוסף שצוין מאפשרים שאילתות באוסף שהוא הצאצא של מסמך ספציפי, שצוין בזמן השאילתה ושיש לו אותו מזהה אוסף.

אינדקסים עם היקף שאילתות של קבוצת אוספים שצוין מאפשרים שאילתות לכל האוספים שיוצאים ממסמך ספציפי, שצוינו בזמן השאילתה ושיש להם אותו מזהה אוסף כמו האינדקס הזה.
fields[]

IndexField

השדות שנתמכים על ידי האינדקס הזה.

באינדקסים מורכבים, הערך הוא תמיד 2 שדות או יותר. הערך האחרון בשדה הוא תמיד לנתיב השדה __name__. אם בזמן היצירה, __name__ לא צוין כשדה האחרון, הוא יתווסף באופן אוטומטי עם אותו כיוון כמו זה של השדה האחרון שהוגדר. אם השדה הסופי באינדקס מורכב אינו כיווני, הערך של __name__ יאורגן לפי ASCENDING (אלא אם צוין במפורש).

באינדקסים של שדה יחיד, זו תמיד תהיה רשומה אחת בדיוק עם נתיב שדה ששווה לנתיב השדה של השדה המשויך.
state

State

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

IndexField

שדה באינדקס. השדה field_path מתאר את השדה שנוצר לאינדקס, וה-value_mode מתאר את האופן שבו ערך השדה נוסף לאינדקס.

שדות
field_path

string

יכול להיות name. באינדקסים של שדה יחיד, השדה הזה חייב להתאים לשם השדה או שאפשר להשמיט אותו.
שדה איחוד value_mode. האופן שבו ערך השדה נוסף לאינדקס. value_mode יכול להיות רק אחד מהבאים:
order

Order

מציין שהשדה הזה תומך בסדר קריאה לפי הסדר שנקבע או בהשוואה באמצעות הסימנים =, <, <=, >, >=.
array_config

ArrayConfig

השדה הזה תומך בפעולות על ערכי array_value.

ArrayConfig

ההגדרות הנתמכות של ערכי המערך.

טיפוסים בני מנייה (enums)
ARRAY_CONFIG_UNSPECIFIED האינדקס לא תומך בשאילתות מערך נוספות.
CONTAINS האינדקס תומך בשאילתות לבלימת מערכים.

הזמנה

הסידורים הנתמכים.

טיפוסים בני מנייה (enums)
ORDER_UNSPECIFIED ההזמנה לא צוינה. האפשרות לא חוקית.
ASCENDING השדה מסודר לפי ערך שדה עולה.
DESCENDING השדה מסודר לפי ערך שדה יורד.

QueryScope

היקף השאילתה מגדיר את ההיקף שבו השאילתה רצה. יש לציין זאת בשדה from של שאילתה מובנית.

טיפוסים בני מנייה (enums)
QUERY_SCOPE_UNSPECIFIED היקף השאילתה לא צוין. האפשרות לא חוקית.
COLLECTION אינדקסים עם היקף שאילתת אוסף שצוין מאפשרים שאילתות באוסף שהוא הצאצא של מסמך ספציפי, שצוין בזמן השאילתה ושמזהה האוסף שצוין על ידי האינדקס.
COLLECTION_GROUP אינדקסים עם היקף שאילתה של קבוצת אוספים מוגדר לאפשר שאילתות לגבי כל האוספים שיש להם את מזהה האוסף שצוין על ידי האינדקס.

ארץ

המצב של אינדקס. במהלך יצירת האינדקס, האינדקס יהיה במצב CREATING. אם האינדקס נוצר בהצלחה, הוא יעבור למצב READY. אם תהיה בעיה ביצירת האינדקס, האינדקס יעבור למצב NEEDS_REPAIR.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED לא צוינה המדינה.
CREATING האינדקס נוצר. יש פעולה פעילה לאורך זמן עבור האינדקס. האינדקס מתעדכן כשכותבים מסמך. ייתכן שיהיו נתוני אינדקס מסוימים.
READY האינדקס מוכן לשימוש. האינדקס מתעדכן כשכותבים מסמך. האינדקס מאוכלס במלואו מכל המסמכים המאוחסנים בו.
NEEDS_REPAIR האינדקס נוצר, אבל משהו השתבש. אין פעולה פעילה לטווח ארוך עבור האינדקס, והפעולה הממושכת האחרונה שהסתיימה נכשלה. האינדקס לא מתעדכן כשכותבים מסמך. ייתכן שיהיו נתוני אינדקס מסוימים. יש להשתמש ב-google.long running.Operations API כדי לקבוע מדוע הפעולה האחרונה שניסה ליצור את האינדקס הזה נכשלה, ולאחר מכן ליצור מחדש את האינדקס.

IndexOperationMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.CreateIndex.

שדות
start_time

Timestamp

השעה שבה הפעולה הזו התחילה.
end_time

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
index

string

משאב האינדקס שעליו פועלת הפעולה. לדוגמה: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

מצב הפעולה.
progress_documents

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
progress_bytes

Progress

ההתקדמות בבייטים של הפעולה הזו.

ListFieldsRequest

הבקשה על FirestoreAdmin.ListFields.

שדות
parent

string

שם הורה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

המסנן שיוחל על התוצאות ברשימה. בשלב זה, FirestoreAdmin.ListFields תומך רק בשדות של כרטיסי מוצר שבוטלו באופן מפורש. כדי לבצע את השאילתה הזו, צריך להפעיל את המסנן FirestoreAdmin.ListFields ולהגדיר את המסנן indexConfig.usesAncestorConfig:false.
page_size

int32

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

string

אסימון דף שהוחזר מקריאה קודמת אל FirestoreAdmin.ListFields, וניתן להשתמש בו כדי לקבל את דף התוצאות הבא.

ListFieldsResponse

התשובה עבור FirestoreAdmin.ListFields.

שדות
fields[]

Field

השדות הנדרשים.
next_page_token

string

אסימון דף שיכול לשמש לבקשת דף נוסף של תוצאות. אם השדה יישאר ריק, זהו הדף האחרון.

ListIndexesRequest

הבקשה על FirestoreAdmin.ListIndexes.

שדות
parent

string

שם הורה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

המסנן שיוחל על התוצאות ברשימה.
page_size

int32

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

string

אסימון דף שהוחזר מקריאה קודמת אל FirestoreAdmin.ListIndexes, וניתן להשתמש בו כדי לקבל את דף התוצאות הבא.

ListIndexesResponse

התשובה עבור FirestoreAdmin.ListIndexes.

שדות
indexes[]

Index

האינדקסים המבוקשים.
next_page_token

string

אסימון דף שיכול לשמש לבקשת דף נוסף של תוצאות. אם השדה יישאר ריק, זהו הדף האחרון.

OperationState

מתאר את מצב הפעולה.

טיפוסים בני מנייה (enums)
OPERATION_STATE_UNSPECIFIED לא צוין.
INITIALIZING הבקשה בשלבי הכנה לעיבוד.
PROCESSING הבקשה בעיבוד בפועל.
CANCELLING הבקשה נמצאת בתהליך ביטול לאחר שהמשתמש שנקרא google.long running.Operations.CancelOperation בפעולה.
FINALIZING הבקשה טופלה ונמצאת בשלב הסופי.
SUCCESSFUL הבקשה הושלמה בהצלחה.
FAILED עיבוד הבקשה הסתיים, אבל הייתה שגיאה.
CANCELLED ביטול הבקשה הסתיים אחרי למשתמש שנקרא google.longlong.Operations.CancelOperation.

ההתקדמות

מתאר את התקדמות הפעולה. יחידת העבודה היא כללית ויש לפרש אותה בהתאם למקום שבו משתמשים ב-Progress.

שדות
estimated_work

int64

כמות העבודה המשוערת.
completed_work

int64

כמות העבודה שהושלמה.

UpdateFieldRequest

הבקשה על FirestoreAdmin.UpdateField.

שדות
field

Field

השדה שצריך לעדכן.
update_mask

FieldMask

מסכה, ביחס לשדה. אם צוין, רק התצורה שצוינה על ידי field_mask תהיה שמעודכנת בשדה.