Index
FirestoreAdmin
(Benutzeroberfläche)CreateIndexRequest
(Meldung)DeleteIndexRequest
(Meldung)ExportDocumentsMetadata
(Meldung)ExportDocumentsRequest
(Meldung)ExportDocumentsResponse
(Meldung)Field
(Meldung)Field.IndexConfig
(Meldung)FieldOperationMetadata
(Meldung)FieldOperationMetadata.IndexConfigDelta
(Meldung)FieldOperationMetadata.IndexConfigDelta.ChangeType
(Aufzählung)GetFieldRequest
(Meldung)GetIndexRequest
(Meldung)ImportDocumentsMetadata
(Meldung)ImportDocumentsRequest
(Meldung)Index
(Meldung)Index.IndexField
(Meldung)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(Meldung)ListFieldsRequest
(Meldung)ListFieldsResponse
(Meldung)ListIndexesRequest
(Meldung)ListIndexesResponse
(Meldung)OperationState
(Aufzählung)Progress
(Meldung)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 ein
|
DeleteIndex |
---|
Löscht einen zusammengesetzten Index.
|
ExportDocuments |
---|
Exportiert eine Kopie aller oder eines Teils von Dokumenten von Google Cloud Firestore in ein anderes Speichersystem wie Google Cloud Storage. Kürzlich an Dokumenten vorgenommene Aktualisierungen werden möglicherweise nicht im Export berücksichtigt. Der Export wird im Hintergrund ausgeführt und der Fortschritt kann über die erstellte Vorgangsressource überwacht und verwaltet werden. Die Ausgabe eines Exports kann erst verwendet werden, nachdem der zugehörige Vorgang abgeschlossen ist. Wenn ein Exportvorgang vor dem Abschluss abgebrochen wird, bleiben möglicherweise unvollständige Daten in Google Cloud Storage erhalten.
|
GetField |
---|
Ruft die Metadaten und die Konfiguration für ein Feld ab.
|
GetIndex |
---|
Ruft einen zusammengesetzten Index ab.
|
ImportDocuments |
---|
Importiert Dokumente in Google Cloud Firestore. Vorhandene Dokumente mit demselben Namen werden überschrieben. Der Import wird im Hintergrund ausgeführt und der Fortschritt kann über die erstellte Vorgangsressource überwacht und verwaltet werden. Wenn ein ImportDocuments-Vorgang abgebrochen wird, wurde möglicherweise bereits ein Teil der Daten in Cloud Firestore importiert.
|
ListFields |
---|
Listet die Feldkonfiguration und Metadaten für diese Datenbank auf. Derzeit unterstützt
|
ListIndexes |
---|
Listet zusammengesetzte Indexe auf.
|
UpdateField |
---|
Aktualisiert eine Feldkonfiguration. Derzeit gelten Feldaktualisierungen nur für die Einzelfeldindexkonfiguration. Aufrufe von Dieser Aufruf gibt ein Verwenden Sie zum Konfigurieren der Standardfeldeinstellungen für die Datenbank die spezielle
|
CreateIndexRequest
Die Anfrage für FirestoreAdmin.CreateIndex
.
Felder | |
---|---|
parent |
Ein übergeordneter Name im Format |
index |
Zusammengesetzter Index, der erstellt werden soll |
DeleteIndexRequest
Die Anfrage für FirestoreAdmin.DeleteIndex
.
Felder | |
---|---|
name |
Einen Namen im Format |
ExportDocumentsMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.ExportDocuments
.
Felder | |
---|---|
start_time |
Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time |
Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird nicht festgelegt, wenn der Vorgang noch läuft. |
operation_state |
Der Status des Exportvorgangs. |
progress_documents |
Der Fortschritt dieses Vorgangs in Dokumenten. |
progress_bytes |
Der Fortschritt dieses Vorgangs in Byte. |
collection_ids[] |
Die zu exportierenden Sammlungs-IDs |
output_uri_prefix |
Das Ziel, in das die Entitäten exportiert werden. |
ExportDocumentsRequest
Die Anfrage für FirestoreAdmin.ExportDocuments
.
Felder | |
---|---|
name |
Zu exportierende Datenbank. Muss das Format |
collection_ids[] |
Die zu exportierenden Sammlungs-IDs. „Nicht angegeben“ bedeutet alle Sammlungen. |
output_uri_prefix |
Der Ausgabe-URI. Derzeit werden Google Cloud Storage-URIs im Format |
ExportDocumentsResponse
Wird im Antwortfeld google.longrunning.Operation
zurückgegeben.
Felder | |
---|---|
output_uri_prefix |
Speicherort der Ausgabedateien. Damit kann nach erfolgreichem Abschluss des Vorgangs ein Import in Cloud Firestore (dieses oder ein anderes Projekt) gestartet werden. |
Field
Stellt ein einzelnes Feld in der Datenbank dar.
Felder werden nach ihrer „Sammlungsgruppe“ gruppiert, die alle Sammlungen in der Datenbank mit derselben ID darstellt.
Felder | |
---|---|
name |
Einen Feldnamen im Format Ein Feldpfad kann ein einfacher Feldname wie Feldpfade können mit Beispiele: (Hinweis: Kommentare hier sind in Markdown-Syntax geschrieben, es gibt also eine zusätzliche Ebene mit Graviszeichen, die einen Codeblock darstellen) Eine spezielle |
index_config |
Die Indexkonfiguration für dieses Feld. Wenn die Richtlinie nicht konfiguriert ist, wird die Feldindexierung auf die durch |
IndexConfig
Die Indexkonfiguration für dieses Feld.
Felder | |
---|---|
indexes[] |
Die für dieses Feld unterstützten Indexe. |
uses_ancestor_config |
Nur Ausgabe Bei „true“ wird die Indexkonfiguration von |
ancestor_field |
Nur Ausgabe Gibt den Ressourcennamen des |
reverting |
Nur Ausgabe. Bei „true“ wird die Indexkonfiguration von |
FieldOperationMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.UpdateField
.
Felder | |
---|---|
start_time |
Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time |
Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird nicht festgelegt, wenn der Vorgang noch läuft. |
field |
Die Feldressource, auf die sich dieser Vorgang auswirkt. Beispiel: |
index_config_deltas[] |
Eine Liste der |
state |
Status des Vorgangs. |
document_progress |
Der Fortschritt dieses Vorgangs in Dokumenten. |
bytes_progress |
Der Fortschritt dieses Vorgangs in Byte. |
IndexConfigDelta
Informationen zu einer Indexkonfigurationsänderung.
Felder | |
---|---|
change_type |
Gibt an, wie sich der Index ändert. |
index |
Index, der geändert wird. |
ChangeType
Gibt an, wie sich der Index ändert.
Enums | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Die Art der Änderung ist nicht angegeben oder bekannt. |
ADD |
Der Einzelfeldindex wird hinzugefügt. |
REMOVE |
Der Einzelfeldindex wird entfernt. |
GetFieldRequest
Die Anfrage für FirestoreAdmin.GetField
.
Felder | |
---|---|
name |
Einen Namen im Format |
GetIndexRequest
Die Anfrage für FirestoreAdmin.GetIndex
.
Felder | |
---|---|
name |
Einen Namen im Format |
ImportDocumentsMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.ImportDocuments
.
Felder | |
---|---|
start_time |
Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time |
Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird nicht festgelegt, wenn der Vorgang noch läuft. |
operation_state |
Der Status des Importvorgangs. |
progress_documents |
Der Fortschritt dieses Vorgangs in Dokumenten. |
progress_bytes |
Der Fortschritt dieses Vorgangs in Byte. |
collection_ids[] |
Die zu importierenden Sammlungs-IDs |
input_uri_prefix |
Der Speicherort der zu importierenden Dokumente. |
ImportDocumentsRequest
Die Anfrage für FirestoreAdmin.ImportDocuments
.
Felder | |
---|---|
name |
Datenbank, in die importiert werden soll. Muss das Format |
collection_ids[] |
Die zu importierenden Sammlungs-IDs „Nicht angegeben“ bedeutet, dass alle im Import enthaltenen Sammlungen enthalten sind. |
input_uri_prefix |
Speicherort der exportierten Dateien. Dieser Wert muss mit dem Wert „output_uri_prefix“ einer ExportDocumentsResponse aus einem erfolgreich abgeschlossenen Export übereinstimmen. Weitere Informationen: |
Index
Cloud Firestore-Indexe ermöglichen einfache und komplexe Abfragen von Dokumenten in einer Datenbank.
Felder | |
---|---|
name |
Nur Ausgabe Ein vom Server definierter Name für diesen Index. Das Format dieses Namens für zusammengesetzte Indexe sieht so aus: |
query_scope |
Indexe, für die ein Sammlungsabfragebereich angegeben ist, ermöglichen Abfragen für eine Sammlung, die einem bestimmten Dokument untergeordnet ist, zum Zeitpunkt der Abfrage angegeben wurde und dieselbe Sammlungs-ID hat. Indexe, für die ein Sammlungsgruppen-Abfragebereich angegeben ist, ermöglichen Abfragen für alle Sammlungen, die von einem bestimmten, zum Zeitpunkt der Abfrage angegebenen Dokument abstammen und dieselbe Sammlungs-ID wie dieser Index haben. |
fields[] |
Die von diesem Index unterstützten Felder. Bei zusammengesetzten Indexen sind dies immer 2 oder mehr Felder. Der letzte Feldeintrag bezieht sich immer auf den Feldpfad Bei Einzelfeldindexen 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. „field_path“ beschreibt, welches Feld indexiert ist, „value_mode“ beschreibt, wie der Feldwert indexiert wird.
Felder | |
---|---|
field_path |
Kann name sein. Bei Einzelfeldindexen muss dieser mit dem Namen des Felds übereinstimmen oder kann weggelassen werden. |
Union-Feld value_mode . Wie der Feldwert indexiert wird. Für value_mode ist nur einer der folgenden Werte zulässig: |
|
order |
Gibt an, dass dieses Feld die Sortierung in der angegebenen Reihenfolge oder den Vergleich mit =, <, <=, >, >= unterstützt. |
array_config |
Gibt an, dass dieses Feld Vorgänge für |
ArrayConfig
Die unterstützten Arraywertkonfigurationen.
Enums | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
Der Index unterstützt keine zusätzlichen Array-Abfragen. |
CONTAINS |
Der Index unterstützt Array-Einschließungsabfragen. |
Auftrag
Die unterstützten Sortierungen.
Enums | |
---|---|
ORDER_UNSPECIFIED |
Die Reihenfolge ist nicht angegeben. Keine gültige Option. |
ASCENDING |
Das Feld wird nach aufsteigendem Feldwert sortiert. |
DESCENDING |
Das Feld wird nach absteigendem Feldwert sortiert. |
QueryScope
Der Abfragebereich definiert den Bereich, in dem eine Abfrage ausgeführt wird. Diese wird im Feld from
einer StructuredQuery angegeben.
Enums | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
Der Abfragebereich ist nicht angegeben. Keine gültige Option. |
COLLECTION |
Indexe, für die ein Sammlungsabfragebereich angegeben ist, ermöglichen Abfragen für eine Sammlung, die einem bestimmten Dokument untergeordnet ist, zum Zeitpunkt der Abfrage angegeben wurde und die vom Index angegebene Sammlungs-ID hat. |
COLLECTION_GROUP |
Indexe, für die ein Sammlungsgruppen-Abfragebereich angegeben ist, ermöglichen Abfragen in allen Sammlungen, für die die vom Index angegebene Sammlungs-ID angegeben wurde. |
Status
Der Status eines Index. Während der Indexerstellung hat ein Index den 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
.
Enums | |
---|---|
STATE_UNSPECIFIED |
Der Status ist nicht angegeben. |
CREATING |
Der Index wird erstellt. Für den Index ist ein aktiver Vorgang mit langer Ausführungszeit vorhanden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Möglicherweise sind einige Indexdaten vorhanden. |
READY |
Der Index kann verwendet werden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Der Index ist vollständig mit allen gespeicherten Dokumenten gefüllt, für die er gilt. |
NEEDS_REPAIR |
Der Index wurde erstellt, aber ein Fehler ist aufgetreten. Für den Index ist kein aktiver Vorgang mit langer Ausführungszeit vorhanden und der zuletzt abgeschlossene Vorgang mit langer Ausführungszeit ist fehlgeschlagen. Der Index wird beim Schreiben eines Dokuments nicht aktualisiert. Möglicherweise sind einige Indexdaten vorhanden. Ermitteln Sie mithilfe der API „google.longrunning.Operations“, warum der Vorgang, bei dem zuletzt versucht wurde, diesen Index zu erstellen, fehlgeschlagen ist. Erstellen Sie dann den Index neu. |
IndexOperationMetadata
Metadaten für google.longrunning.Operation
Ergebnisse von FirestoreAdmin.CreateIndex
.
Felder | |
---|---|
start_time |
Zeitpunkt, zu dem dieser Vorgang gestartet wurde. |
end_time |
Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird nicht festgelegt, wenn der Vorgang noch läuft. |
index |
Die Indexressource, auf die sich dieser Vorgang auswirkt. Beispiel: |
state |
Status des Vorgangs. |
progress_documents |
Der Fortschritt dieses Vorgangs in Dokumenten. |
progress_bytes |
Der Fortschritt dieses Vorgangs in Byte. |
ListFieldsRequest
Die Anfrage für FirestoreAdmin.ListFields
.
Felder | |
---|---|
parent |
Ein übergeordneter Name im Format |
filter |
Der Filter, der auf die Listenergebnisse angewendet werden soll. Derzeit unterstützt |
page_size |
Die Anzahl der zurückzugebenden Ergebnisse. |
page_token |
Ein Seitentoken, das von einem vorherigen Aufruf an |
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 das Feld leer ist, ist dies die letzte Seite. |
ListIndexesRequest
Die Anfrage für FirestoreAdmin.ListIndexes
.
Felder | |
---|---|
parent |
Ein übergeordneter Name im Format |
filter |
Der Filter, der auf die Listenergebnisse angewendet werden soll. |
page_size |
Die Anzahl der zurückzugebenden Ergebnisse. |
page_token |
Ein Seitentoken, das von einem vorherigen Aufruf an |
ListIndexesResponse
Die Antwort für FirestoreAdmin.ListIndexes
.
Felder | |
---|---|
indexes[] |
Die angeforderten Indexe. |
next_page_token |
Ein Seitentoken, mit dem eine weitere Ergebnisseite angefordert werden kann. Wenn das Feld leer ist, ist dies die letzte Seite. |
OperationState
Beschreibt den Status des Vorgangs.
Enums | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Nicht angegeben |
INITIALIZING |
Die Anfrage wird für die Verarbeitung vorbereitet. |
PROCESSING |
Die Anfrage wird aktiv verarbeitet. |
CANCELLING |
Die Anfrage wird gerade abgebrochen, nachdem der Nutzer google.longrunning.Operations.CancelOperation für den Vorgang aufgerufen hat. |
FINALIZING |
Die Anfrage wurde verarbeitet und befindet sich in der Abschlussphase. |
SUCCESSFUL |
Die Anfrage wurde erfolgreich abgeschlossen. |
FAILED |
Die Verarbeitung der Anfrage ist abgeschlossen. Es ist jedoch ein Fehler aufgetreten. |
CANCELLED |
Das Abbrechen der Anfrage ist abgeschlossen, nachdem der Nutzer google.longrunning.Operations.CancelOperation aufgerufen hat. |
Fortschritt
Beschreibt den Fortschritt des Vorgangs. Die Arbeitseinheit ist generisch und muss abhängig davon interpretiert werden, wo Progress
verwendet wird.
Felder | |
---|---|
estimated_work |
Der geschätzte Arbeitsaufwand. |
completed_work |
Die Menge 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 von „field_mask“ angegebene Konfiguration im Feld aktualisiert. |