Daten speichern

Daten mit PUT schreiben

Der grundlegende Schreibvorgang über die REST API ist PUT. Um das Speichern von Daten zu veranschaulichen, erstellen wir eine Blogging-Anwendung mit Beiträgen und Nutzern. Alle Daten für unsere Anwendung werden unter dem Pfad „fireblog“ an der Firebase-Datenbank-URL „https://docs-examples.firebaseio.com/fireblog“ gespeichert.

Speichern wir zuerst einige Nutzerdaten in unserer Firebase-Datenbank. Wir speichern jeden Nutzer mit einem eindeutigen Nutzernamen sowie seinem vollständigen Namen und seinem Geburtsdatum. Da jeder Nutzer einen eindeutigen Nutzernamen hat, ist es sinnvoll, hier PUT anstelle von POST zu verwenden, da wir den Schlüssel bereits haben und keinen erstellen müssen.

Mit PUT können wir einen String, eine Zahl, einen booleschen Wert, ein Array oder ein beliebiges JSON-Objekt in unsere Firebase-Datenbank schreiben. In diesem Fall übergeben wir ihm ein Objekt:

curl -X PUT -d '{
  "alanisawesome": {
    "name": "Alan Turing",
    "birthday": "June 23, 1912"
  }
}' 'https://docs-examples.firebaseio.com/fireblog/users.json'

Wenn ein JSON-Objekt in der Datenbank gespeichert wird, werden die Objekteigenschaften automatisch verschachtelt den untergeordneten Speicherorten zugeordnet. Wenn wir zum neu erstellten Knoten wechseln, sehen wir den Wert „Alan Turing“. Wir können Daten auch direkt an einem untergeordneten Speicherort speichern:

curl -X PUT -d '"Alan Turing"' \
  'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome/name.json'

curl -X PUT -d '"June 23, 1912"' \
  'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome/birthday.json'

In den beiden obigen Beispielen wird der Wert gleichzeitig mit einem Objekt und separat in untergeordnete Speicherorte geschrieben. In beiden Fällen werden dieselben Daten in unserer Firebase-Datenbank gespeichert:

{
  "users": {
    "alanisawesome": {
      "date_of_birth": "June 23, 1912",
      "full_name": "Alan Turing"
    }
  }
}

Eine erfolgreiche Anfrage wird durch einen HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält die Daten, die wir in die Datenbank geschrieben haben. Im ersten Beispiel wird nur ein Ereignis auf Clients ausgelöst, die die Daten beobachten, während im zweiten Beispiel zwei Ereignisse ausgelöst werden. Wenn am Nutzerpfad bereits Daten vorhanden sind, werden diese beim ersten Ansatz überschrieben. Bei der zweiten Methode wird dagegen nur der Wert jedes einzelnen untergeordneten Knotens geändert, während andere untergeordnete Knoten unverändert bleiben. PUT entspricht set() in unserem JavaScript SDK.

Daten mit PATCH aktualisieren

Mit einer PATCH-Anfrage können wir bestimmte Kinder an einem Standort aktualisieren, ohne vorhandene Daten zu überschreiben. Fügen wir den Nutzerdaten von Turing mit einer PATCH-Anfrage seinen Spitznamen hinzu:

curl -X PATCH -d '{
  "nickname": "Alan The Machine"
}' \
  'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome.json'

Durch die obige Anfrage wird nickname in das alanisawesome-Objekt geschrieben, ohne dass die untergeordneten Elemente name oder birthday gelöscht werden. Wenn wir stattdessen einen PUT-Antrag gestellt hätten, wären name und birthday gelöscht worden, da sie nicht in der Anfrage enthalten waren. Die Daten in unserer Firebase-Datenbank sehen jetzt so aus:

{
  "users": {
    "alanisawesome": {
      "date_of_birth": "June 23, 1912",
      "full_name": "Alan Turing",
      "nickname": "Alan The Machine"
    }
  }
}

Eine erfolgreiche Anfrage wird durch einen HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält die aktualisierten Daten, die in die Datenbank geschrieben wurden.

Firebase unterstützt auch Multipath-Updates. Das bedeutet, dass PATCH jetzt Werte an mehreren Stellen in Ihrer Firebase-Datenbank gleichzeitig aktualisieren kann. Das ist eine leistungsstarke Funktion, mit der Sie Ihre Daten denormalisieren können. Mithilfe von Multipath-Updates können wir Alan und Grace gleichzeitig Spitznamen hinzufügen:

curl -X PATCH -d '{
  "alanisawesome/nickname": "Alan The Machine",
  "gracehopper/nickname": "Amazing Grace"
}' \
  'https://docs-examples.firebaseio.com/fireblog/users.json'

Nach dieser Aktualisierung wurden sowohl Alan als auch Grace ihre Spitznamen hinzugefügt:

{
  "users": {
    "alanisawesome": {
      "date_of_birth": "June 23, 1912",
      "full_name": "Alan Turing",
      "nickname": "Alan The Machine"
    },
    "gracehop": {
      "date_of_birth": "December 9, 1906",
      "full_name": "Grace Hopper",
      "nickname": "Amazing Grace"
    }
  }
}

Wenn Sie versuchen, Objekte durch Schreiben von Objekten mit den enthaltenen Pfaden zu aktualisieren, führt dies zu einem anderen Verhalten. Sehen wir uns an, was passiert, wenn wir versuchen, Grace und Alan so zu aktualisieren:

curl -X PATCH -d '{
  "alanisawesome": {"nickname": "Alan The Machine"},
  "gracehopper": {"nickname": "Amazing Grace"}
}' \
  'https://docs-examples.firebaseio.com/fireblog/users.json'

Das führt zu einem anderen Verhalten, nämlich zum Überschreiben des gesamten /fireblog/users-Knotens:

{
  "users": {
    "alanisawesome": {
      "nickname": "Alan The Machine"
    },
    "gracehop": {
      "nickname": "Amazing Grace"
    }
  }
}

Daten mit bedingten Anfragen aktualisieren

1. Wenn Sie eine bedingte Anfrage an einem Standort ausführen möchten, rufen Sie die eindeutige Kennung für die aktuellen Daten an diesem Standort oder das ETag ab. Wenn sich die Daten an diesem Speicherort ändern, ändert sich auch das ETag. Sie können ein ETag mit einer anderen Methode als PATCH anfordern. Im folgenden Beispiel wird eine GET-Anfrage verwendet.

   curl -i 'https://test.example.com/posts/12345/upvotes.json' -H 'X-Firebase-ETag: true'
   

   Wenn du das ETag im Header aufrufst, wird das ETag des angegebenen Speicherorts in der HTTP-Antwort zurückgegeben.

   HTTP/1.1 200 OK
   Content-Length: 6
   Content-Type: application/json; charset=utf-8
   Access-Control-Allow-Origin: *
   ETag: [ETAG_VALUE]
   Cache-Control: no-cache
   
   10 // Current value of the data at the specified location
   

2. Fügen Sie den zurückgegebenen ETag in Ihre nächste PUT- oder DELETE-Anfrage ein, um Daten zu aktualisieren, die genau mit diesem ETag-Wert übereinstimmen. Wenn Sie den Zähler in unserem Beispiel auf 11 aktualisieren möchten, also um 1 höher als der ursprünglich abgerufene Wert 10, und die Anfrage fehlschlagen lassen möchten, wenn der Wert nicht mehr übereinstimmt, verwenden Sie den folgenden Code:

   curl -iX PUT -d '11' 'https://[PROJECT_ID].firebaseio.com/posts/12345/upvotes.json' -H 'if-match:[ETAG_VALUE]'
   

   Wenn der Wert der Daten an der angegebenen Stelle weiterhin 10 ist, stimmt das ETag in der PUT-Anfrage überein und die Anfrage ist erfolgreich. Die Zahl 11 wird in die Datenbank geschrieben.

   HTTP/1.1 200 OK
   Content-Length: 6
   Content-Type: application/json; charset=utf-8
   Access-Control-Allow-Origin: *
   Cache-Control: no-cache
   
   11 // New value of the data at the specified location, written by the conditional request
   

   Wenn der Speicherort nicht mehr mit dem ETag übereinstimmt, was z. B. passieren kann, wenn ein anderer Nutzer einen neuen Wert in die Datenbank geschrieben hat, schlägt die Anfrage fehl, ohne dass etwas an den Speicherort geschrieben wird. Die Rückgabeantwort enthält den neuen Wert und das ETag.

   HTTP/1.1 412 Precondition Failed
   Content-Length: 6
   Content-Type: application/json; charset=utf-8
   Access-Control-Allow-Origin: *
   ETag: [ETAG_VALUE]
   Cache-Control: no-cache
   
   12 // New value of the data at the specified location
   

3. Verwenden Sie die neuen Informationen, wenn Sie die Anfrage noch einmal senden möchten. Realtime Database wiederholt fehlgeschlagene bedingte Anfragen nicht automatisch. Sie können jedoch den neuen Wert und das ETag verwenden, um eine neue bedingte Anfrage mit den Informationen zu erstellen, die in der Fehlerantwort zurückgegeben wurden.

Bei REST-basierten bedingten Anfragen wird der HTTP-Standard if-match implementiert. Sie unterscheiden sich jedoch in folgenden Punkten vom Standard:

• Sie können für jede Anfrage vom Typ „if-match“ nur einen ETag-Wert angeben.
• Gemäß dem Standard sollten ETags mit allen Anfragen zurückgegeben werden. In Realtime Database werden ETags jedoch nur mit Anfragen zurückgegeben, die den Header X-Firebase-ETag enthalten. Dadurch werden die Abrechnungskosten für Standardanfragen gesenkt.

Bedingte Anfragen sind außerdem möglicherweise langsamer als normale REST-Anfragen.

Datenlisten speichern

Um für jedes untergeordnete Element, das einer Firebase-Datenbankreferenz hinzugefügt wird, einen eindeutigen, zeitstempelbasierten Schlüssel zu generieren, können wir eine POST-Anfrage senden. Für unseren users-Pfad war es sinnvoll, eigene Schlüssel zu definieren, da jeder Nutzer einen eindeutigen Nutzernamen hat. Wenn Nutzer der App jedoch Blogbeiträge hinzufügen, wird mit einer POST-Anfrage automatisch ein Schlüssel für jeden Blogbeitrag generiert:

curl -X POST -d '{
  "author": "alanisawesome",
  "title": "The Turing Machine"
}' 'https://docs-examples.firebaseio.com/fireblog/posts.json'

Unser posts-Pfad enthält jetzt die folgenden Daten:

{
  "posts": {
    "-JSOpn9ZC54A4P4RoqVa": {
      "author": "alanisawesome",
      "title": "The Turing Machine"
    }
  }
}

Der Schlüssel -JSOpn9ZC54A4P4RoqVa wurde automatisch für uns generiert, da wir eine POST-Anfrage verwendet haben. Eine erfolgreiche Anfrage wird durch einen 200 OK-HTTP-Statuscode angezeigt. Die Antwort enthält den Schlüssel der hinzugefügten neuen Daten:

{"name":"-JSOpn9ZC54A4P4RoqVa"}

Daten entfernen

Um Daten aus der Datenbank zu entfernen, können wir eine DELETE-Anfrage mit der URL des Pfads senden, aus dem wir Daten löschen möchten. Mit dem folgenden Befehl wird Alan aus dem Pfad users gelöscht:

curl -X DELETE \
  'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome.json'

Eine erfolgreiche DELETE-Anfrage wird durch einen 200 OK-HTTP-Statuscode mit einer Antwort im JSON-null-Format angezeigt.

URI-Parameter

Die REST API akzeptiert die folgenden URI-Parameter beim Schreiben von Daten in die Datenbank:

auth

Der Anfrageparameter auth ermöglicht den Zugriff auf Daten, die durch Firebase Realtime Database Security Rules geschützt sind. Er wird von allen Anfragetypen unterstützt. Das Argument kann entweder unser Firebase-App-Secret oder ein Authentifizierungstoken sein. Weitere Informationen dazu finden Sie im Abschnitt Nutzerautorisierung. Im folgenden Beispiel senden wir eine POST-Anfrage mit einem auth-Parameter, wobei CREDENTIAL entweder unser Firebase-App-Secret oder ein Authentifizierungstoken ist:

curl -X POST -d '{"Authenticated POST request"}' \
  'https://docs-examples.firebaseio.com/auth-example.json?auth=CREDENTIAL'

ausgeben

Mit dem Parameter print können wir das Format der Antwort aus der Datenbank angeben. Wenn wir print=pretty zur Anfrage hinzufügen, werden die Daten in einem für Menschen lesbaren Format zurückgegeben. print=pretty wird von GET-, PUT-, POST-, PATCH- und DELETE-Anfragen unterstützt.

Wenn wir die Ausgabe vom Server beim Schreiben von Daten unterdrücken möchten, können wir unserer Anfrage print=silent hinzufügen. Die resultierende Antwort ist leer und wird durch einen HTTP-Statuscode von 204 No Content angezeigt, wenn die Anfrage erfolgreich war. print=silent wird von GET-, PUT-, POST- und PATCH-Anfragen unterstützt.

Serverwerte schreiben

Serverwerte können an einem Speicherort mit einem Platzhalterwert geschrieben werden. Das ist ein Objekt mit einem einzelnen ".sv"-Schlüssel. Der Wert für diesen Schlüssel ist der Serverwert, den wir festlegen möchten. So können Sie beispielsweise einen Zeitstempel beim Erstellen eines Nutzers festlegen:

curl -X PUT -d '{".sv": "timestamp"}' \
  'https://docs-examples.firebaseio.com/alanisawesome/createdAt.json'

"timestamp" ist der einzige unterstützte Serverwert und entspricht der Zeit seit der UNIX-Epoche in Millisekunden.

Schreibleistung verbessern

Wenn wir große Datenmengen in die Datenbank schreiben, können wir mit dem Parameter print=silent die Schreibleistung verbessern und die Bandbreitennutzung verringern. Beim normalen Schreibvorgang antwortet der Server mit den geschriebenen JSON-Daten. Wenn print=silent angegeben ist, schließt der Server die Verbindung sofort nach Erhalt der Daten, wodurch die Bandbreitennutzung reduziert wird.

Wenn wir viele Anfragen an die Datenbank senden, können wir die HTTPS-Verbindung wiederverwenden, indem wir eine Keep-Alive-Anfrage im HTTP-Header senden.

Fehlerbedingungen

In den folgenden Fällen gibt die REST API Fehlercodes zurück:

Daten schützen

Firebase bietet eine Sicherheitssprache, mit der wir festlegen können, welche Nutzer Lese- und Schreibzugriff auf verschiedene Knoten unserer Daten haben. Weitere Informationen finden Sie unter Realtime Database Security Rules.