Index
-
FirestoreAdmin
(Schnittstelle) -
CreateIndexRequest
(Nachricht) -
DeleteIndexRequest
(Nachricht) -
ExportDocumentsMetadata
(Nachricht) -
ExportDocumentsRequest
(Nachricht) -
ExportDocumentsResponse
(Nachricht) -
Field
(Nachricht) -
Field.IndexConfig
(Nachricht) -
FieldOperationMetadata
(Nachricht) -
FieldOperationMetadata.IndexConfigDelta
(Nachricht) -
FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum) -
GetFieldRequest
(Nachricht) -
GetIndexRequest
(Nachricht) -
ImportDocumentsMetadata
(Nachricht) -
ImportDocumentsRequest
(Nachricht) -
Index
(Nachricht) -
Index.IndexField
(Nachricht) -
Index.IndexField.ArrayConfig
(enum) -
Index.IndexField.Order
(Aufzählung) -
Index.QueryScope
(enum) -
Index.State
(Aufzählung) -
IndexOperationMetadata
(Nachricht) -
ListFieldsRequest
(Nachricht) -
ListFieldsResponse
(Nachricht) -
ListIndexesRequest
(Nachricht) -
ListIndexesResponse
(Nachricht) -
OperationState
(Aufzählung) -
Progress
(Nachricht) -
UpdateFieldRequest
(Nachricht)
FirestoreAdmin
Vorgänge werden vom Dienst FirestoreAdmin
erstellt, der Zugriff erfolgt jedoch über den Dienst google.longrunning.Operations
.
CreateIndex |
---|
Erstellt einen zusammengesetzten Index. Dadurch wird eine
|
Index löschen |
---|
Löscht einen zusammengesetzten Index.
|
Dokumente exportieren |
---|
Exportiert eine Kopie aller oder einer Teilmenge der Dokumente aus Google Cloud Firestore in ein anderes Speichersystem, beispielsweise Google Cloud Storage. Kürzlich durchgeführte Aktualisierungen von Dokumenten werden möglicherweise nicht im Export berücksichtigt. Der Export erfolgt im Hintergrund und sein Fortschritt kann über die erstellte Operationsressource überwacht und verwaltet werden. Die Ausgabe eines Exports darf erst verwendet werden, wenn der zugehörige Vorgang abgeschlossen ist. Wenn ein Exportvorgang vor Abschluss abgebrochen wird, bleiben möglicherweise Teildaten im Google Cloud Storage zurück.
|
GetField |
---|
Ruft die Metadaten und die Konfiguration für ein Feld ab.
|
GetIndex |
---|
Ruft einen zusammengesetzten Index ab.
|
Dokumente importieren |
---|
Importiert Dokumente in Google Cloud Firestore. Vorhandene Dokumente mit demselben Namen werden überschrieben. Der Import erfolgt im Hintergrund und sein Fortschritt kann über die erstellte Operationsressource überwacht und verwaltet werden. Wenn ein ImportDocuments-Vorgang abgebrochen wird, ist es möglich, dass eine Teilmenge der Daten bereits in Cloud Firestore importiert wurde.
|
ListFields |
---|
Listet die Feldkonfiguration und Metadaten für diese Datenbank auf. Derzeit unterstützt
|
ListIndexes |
---|
Listet zusammengesetzte Indizes auf.
|
UpdateField |
---|
Aktualisiert eine Feldkonfiguration. Derzeit gelten Feldaktualisierungen nur für die Indexkonfiguration einzelner Felder. Allerdings sollten Aufrufe von Dieser Aufruf gibt eine Um die Standardfeldeinstellungen für die Datenbank zu konfigurieren, verwenden Sie das spezielle
|
CreateIndexRequest
Die Anfrage für FirestoreAdmin.CreateIndex
.
Felder | |
---|---|
parent | Ein übergeordneter Name der Form |
index | Der zu erstellende zusammengesetzte Index. |
DeleteIndexRequest
Die Anfrage für FirestoreAdmin.DeleteIndex
.
Felder | |
---|---|
name | Ein Name der Form |
ExportDocumentsMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.ExportDocuments
.
Felder | |
---|---|
start_time | Der Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time | Der Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird deaktiviert, wenn der Vorgang noch läuft. |
operation_state | Der Status des Exportvorgangs. |
progress_documents | Der Fortschritt dieser Operation in Dokumenten. |
progress_bytes | Der Fortschritt dieses Vorgangs in Bytes. |
collection_ids[] | Welche Sammlungs-IDs werden exportiert? |
output_uri_prefix | Wohin die Entitäten exportiert werden. |
ExportDocumentsRequest
Die Anfrage für FirestoreAdmin.ExportDocuments
.
Felder | |
---|---|
name | Datenbank zum Exportieren. Sollte die Form haben: |
collection_ids[] | Welche Sammlungs-IDs exportiert werden sollen. Nicht spezifiziert bedeutet alle Sammlungen. |
output_uri_prefix | Der Ausgabe-URI. Unterstützt derzeit nur Google Cloud Storage-URIs der Form: |
ExportDocumentsResponse
Wird im Antwortfeld google.longrunning.Operation
zurückgegeben.
Felder | |
---|---|
output_uri_prefix | Speicherort der Ausgabedateien. Dies kann verwendet werden, um einen Import in Cloud Firestore (dieses Projekt oder ein anderes Projekt) zu starten, nachdem der Vorgang erfolgreich abgeschlossen wurde. |
Feld
Stellt ein einzelnes Feld in der Datenbank dar.
Felder werden nach ihrer „Sammlungsgruppe“ gruppiert, die alle Sammlungen in der Datenbank mit derselben ID darstellen.
Felder | |
---|---|
name | Ein Feldname der Form Ein Feldpfad kann ein einfacher Feldname sein, z. B. Feldpfade können mit Beispiele: (Hinweis: Kommentare werden hier in Markdown-Syntax geschrieben, es gibt also eine zusätzliche Backtick-Ebene zur Darstellung eines Codeblocks) Ein spezielles |
index_config | Die Indexkonfiguration für dieses Feld. Wenn diese Option nicht festgelegt ist, wird die Feldindizierung auf die durch |
IndexConfig
Die Indexkonfiguration für dieses Feld.
Felder | |
---|---|
indexes[] | Die für dieses Feld unterstützten Indizes. |
uses_ancestor_config | Nur Ausgabe. Wenn true, wird die Indexkonfiguration des |
ancestor_field | Nur Ausgabe. Gibt den Ressourcennamen des |
reverting | Nur Ausgabe Wenn „true“, wird die Indexkonfiguration des |
FieldOperationMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.UpdateField
.
Felder | |
---|---|
start_time | Der Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time | Der Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird deaktiviert, wenn der Vorgang noch läuft. |
field | Die Feldressource, auf die dieser Vorgang wirkt. Zum Beispiel: |
index_config_deltas[] | Eine Liste von |
state | Der Status des Vorgangs. |
document_progress | Der Fortschritt dieser Operation in Dokumenten. |
bytes_progress | Der Fortschritt dieses Vorgangs in Bytes. |
IndexConfigDelta
Informationen zu einer Indexkonfigurationsänderung.
Felder | |
---|---|
change_type | Gibt an, wie sich der Index ändert. |
index | Der Index wird geändert. |
Typ ändern
Gibt an, wie sich der Index ändert.
Aufzählungen | |
---|---|
CHANGE_TYPE_UNSPECIFIED | Die Art der Änderung ist nicht spezifiziert oder bekannt. |
ADD | Der Einzelfeldindex wird hinzugefügt. |
REMOVE | Der Einzelfeldindex wird entfernt. |
GetFieldRequest
Die Anfrage für FirestoreAdmin.GetField
.
Felder | |
---|---|
name | Ein Name der Form |
GetIndexRequest
Die Anfrage für FirestoreAdmin.GetIndex
.
Felder | |
---|---|
name | Ein Name der Form |
ImportDocumentsMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.ImportDocuments
.
Felder | |
---|---|
start_time | Der Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time | Der Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird deaktiviert, wenn der Vorgang noch läuft. |
operation_state | Der Status des Importvorgangs. |
progress_documents | Der Fortschritt dieser Operation in Dokumenten. |
progress_bytes | Der Fortschritt dieses Vorgangs in Bytes. |
collection_ids[] | Welche Sammlungs-IDs werden importiert? |
input_uri_prefix | Der Speicherort der importierten Dokumente. |
ImportDocumentsRequest
Die Anfrage für FirestoreAdmin.ImportDocuments
.
Felder | |
---|---|
name | Datenbank zum Importieren. Sollte die Form haben: |
collection_ids[] | Welche Sammlungs-IDs importiert werden sollen. Nicht angegeben bedeutet, dass alle im Import enthaltenen Sammlungen enthalten sind. |
input_uri_prefix | Speicherort der exportierten Dateien. Dies muss mit dem „output_uri_prefix“ einer „ExportDocumentsResponse“ aus einem Export übereinstimmen, der erfolgreich abgeschlossen wurde. Siehe: |
Index
Cloud Firestore-Indizes ermöglichen einfache und komplexe Abfragen von Dokumenten in einer Datenbank.
Felder | |
---|---|
name | Nur Ausgabe. Ein vom Server definierter Name für diesen Index. Die Form dieses Namens für zusammengesetzte Indizes lautet: |
query_scope | Indizes mit einem angegebenen Sammlungsabfragebereich ermöglichen Abfragen für eine Sammlung, die das untergeordnete Element eines bestimmten Dokuments ist, zum Zeitpunkt der Abfrage angegeben wurde und dieselbe Sammlungs-ID hat. Indizes mit einem angegebenen Sammlungsgruppen-Abfragebereich ermöglichen Abfragen für alle Sammlungen, die von einem bestimmten Dokument abstammen, das zum Zeitpunkt der Abfrage angegeben wurde und dieselbe Sammlungs-ID wie dieser Index haben. |
fields[] | Die von diesem Index unterstützten Felder. Bei zusammengesetzten Indizes sind dies immer 2 oder mehr Felder. Der letzte Feldeintrag gilt immer für den Feldpfad Bei Einzelfeldindizes ist dies immer genau ein Eintrag mit einem Feldpfad, der dem Feldpfad des zugehörigen Felds entspricht. |
state | Nur Ausgabe. Der Bereitstellungsstatus des Index. |
IndexField
Ein Feld in einem Index. Der field_path beschreibt, welches Feld indiziert wird, der value_mode beschreibt, wie der Feldwert indiziert wird.
Felder | |
---|---|
field_path | Kann ein Name sein. Bei Einzelfeldindizes muss dieser mit dem Namen des Feldes übereinstimmen oder kann weggelassen werden. |
Union-Feld value_mode . Wie der Feldwert indiziert wird. value_mode kann nur einer der folgenden Werte sein: | |
order | Gibt an, dass dieses Feld das Sortieren nach der angegebenen Reihenfolge oder den Vergleich mit =, <, <=, >, >= unterstützt. |
array_config | Gibt an, dass dieses Feld Operationen für |
ArrayConfig
Die unterstützten Array-Wertkonfigurationen.
Aufzählungen | |
---|---|
ARRAY_CONFIG_UNSPECIFIED | Der Index unterstützt keine zusätzlichen Array-Abfragen. |
CONTAINS | Der Index unterstützt Array-Einschlussabfragen. |
Befehl
Die unterstützten Bestellungen.
Aufzählungen | |
---|---|
ORDER_UNSPECIFIED | Die Reihenfolge ist nicht spezifiziert. Keine gültige Option. |
ASCENDING | Das Feld wird nach aufsteigendem Feldwert sortiert. |
DESCENDING | Das Feld wird nach absteigendem Feldwert sortiert. |
Abfragebereich
Der Abfragebereich definiert den Bereich, in dem eine Abfrage ausgeführt wird. Dies wird im from
Feld einer StructuredQuery angegeben.
Aufzählungen | |
---|---|
QUERY_SCOPE_UNSPECIFIED | Der Abfragebereich ist nicht angegeben. Keine gültige Option. |
COLLECTION | Indizes mit einem angegebenen Sammlungsabfragebereich ermöglichen Abfragen für eine Sammlung, die das untergeordnete Element eines bestimmten Dokuments ist, das zum Zeitpunkt der Abfrage angegeben wurde, und die über die durch den Index angegebene Sammlungs-ID verfügt. |
COLLECTION_GROUP | Indizes mit einem angegebenen Sammlungsgruppen-Abfragebereich ermöglichen Abfragen für alle Sammlungen, die über die durch den Index angegebene Sammlungs-ID verfügen. |
Zustand
Der Status eines Index. Während der Indexerstellung befindet sich ein Index im Status CREATING
. Wenn der Index erfolgreich erstellt wurde, wechselt er in den Status READY
. Wenn bei der Indexerstellung ein Problem auftritt, wechselt der Index in den Status NEEDS_REPAIR
.
Aufzählungen | |
---|---|
STATE_UNSPECIFIED | Der Staat ist nicht spezifiziert. |
CREATING | Der Index wird erstellt. Für den Index ist ein aktiver, lang andauernder Vorgang vorhanden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Möglicherweise sind einige Indexdaten vorhanden. |
READY | Der Index ist einsatzbereit. Der Index wird beim Schreiben eines Dokuments aktualisiert. Der Index wird vollständig mit allen gespeicherten Dokumenten gefüllt, auf die er sich bezieht. |
NEEDS_REPAIR | Der Index wurde erstellt, aber es ist ein Fehler aufgetreten. Für den Index ist kein aktiver Langzeitvorgang vorhanden und der zuletzt abgeschlossene Langzeitvorgang ist fehlgeschlagen. Der Index wird beim Schreiben eines Dokuments nicht aktualisiert. Möglicherweise sind einige Indexdaten vorhanden. Verwenden Sie die google.longrunning.Operations-API, um festzustellen, warum der Vorgang, der zuletzt versucht hat, diesen Index zu erstellen, fehlgeschlagen ist, und erstellen Sie dann den Index neu. |
IndexOperationMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.CreateIndex
.
Felder | |
---|---|
start_time | Der Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time | Der Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird deaktiviert, wenn der Vorgang noch läuft. |
index | Die Indexressource, auf die dieser Vorgang wirkt. Zum Beispiel: |
state | Der Status des Vorgangs. |
progress_documents | Der Fortschritt dieser Operation in Dokumenten. |
progress_bytes | Der Fortschritt dieses Vorgangs in Bytes. |
ListFieldsRequest
Die Anfrage für FirestoreAdmin.ListFields
.
Felder | |
---|---|
parent | Ein übergeordneter Name der Form |
filter | Der Filter, der auf Listenergebnisse angewendet werden soll. Derzeit unterstützt |
page_size | Die Anzahl der zurückzugebenden Ergebnisse. |
page_token | Ein Seitentoken, das von einem vorherigen Aufruf von |
ListFieldsResponse
Die Antwort für FirestoreAdmin.ListFields
.
Felder | |
---|---|
fields[] | Die angeforderten Felder. |
next_page_token | Ein Seitentoken, mit dem eine weitere Ergebnisseite angefordert werden kann. Wenn leer, ist dies die letzte Seite. |
ListIndexesRequest
Die Anfrage für FirestoreAdmin.ListIndexes
.
Felder | |
---|---|
parent | Ein übergeordneter Name der Form |
filter | Der Filter, der auf Listenergebnisse angewendet werden soll. |
page_size | Die Anzahl der zurückzugebenden Ergebnisse. |
page_token | Ein Seitentoken, das von einem vorherigen Aufruf von |
ListIndexesResponse
Die Antwort für FirestoreAdmin.ListIndexes
.
Felder | |
---|---|
indexes[] | Die angeforderten Indizes. |
next_page_token | Ein Seitentoken, mit dem eine weitere Ergebnisseite angefordert werden kann. Wenn leer, ist dies die letzte Seite. |
OperationsState
Beschreibt den Status des Vorgangs.
Aufzählungen | |
---|---|
OPERATION_STATE_UNSPECIFIED | Nicht spezifiziert. |
INITIALIZING | Die Anfrage wird zur Bearbeitung vorbereitet. |
PROCESSING | Die Anfrage wird aktiv bearbeitet. |
CANCELLING | Die Anfrage wird gerade abgebrochen, nachdem der Benutzer google.longrunning.Operations.CancelOperation für den Vorgang aufgerufen hat. |
FINALIZING | Die Anfrage wurde bearbeitet und befindet sich in der Abschlussphase. |
SUCCESSFUL | Die Anfrage wurde erfolgreich abgeschlossen. |
FAILED | Die Verarbeitung der Anfrage wurde abgeschlossen, es ist jedoch ein Fehler aufgetreten. |
CANCELLED | Der Abbruch der Anfrage wurde abgeschlossen, nachdem der Benutzer google.longrunning.Operations.CancelOperation aufgerufen hat. |
Fortschritt
Beschreibt den Fortschritt des Vorgangs. Die Arbeitseinheit ist generisch und muss basierend darauf interpretiert werden, wo Progress
verwendet wird.
Felder | |
---|---|
estimated_work | Der geschätzte Arbeitsaufwand. |
completed_work | Der Umfang der abgeschlossenen Arbeit. |
UpdateFieldRequest
Die Anfrage für FirestoreAdmin.UpdateField
.
Felder | |
---|---|
field | Das zu aktualisierende Feld. |
update_mask | Eine Maske relativ zum Feld. Wenn angegeben, wird nur die durch diese Feldmaske angegebene Konfiguration im Feld aktualisiert. |