REST Resource: projects.databases.documents

Ressource : Document

Document Firestore.

Ne doit pas dépasser 1 Mio à 4 octets.

Représentation JSON
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Champs
name

string

Nom de ressource du document (par exemple, projects/{projectId}/databases/{databaseId}/documents/{document_path}).

fields

map (key: string, value: object (Value))

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le document a été créé.

Cette valeur augmente de façon linéaire lorsqu'un document est supprimé, puis recréé. Il peut également être comparé aux valeurs d'autres documents et aux readTime d'une requête.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le document a été modifié pour la dernière fois.

Cette valeur est initialement définie sur createTime, puis augmente de façon linéaire à chaque modification du document. Il peut également être comparé aux valeurs d'autres documents et aux readTime d'une requête.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Méthodes

batchGet

Récupère plusieurs documents.

batchWrite

Applique un lot d'opérations d'écriture.

beginTransaction

Démarre une nouvelle transaction.

commit

Valide une transaction et met à jour des documents si vous le souhaitez.

createDocument

Crée un document.

delete

Supprime un document.

get

Récupère un seul document.

list

Répertorie les documents.

listCollectionIds

Répertorie tous les ID de collection sous un document.

listDocuments

Répertorie les documents.

partitionQuery

Partitionne une requête en renvoyant des curseurs de partition pouvant être utilisés pour exécuter la requête en parallèle.

patch

Met à jour ou insère un document.

rollback

Annule une transaction.

runAggregationQuery

Exécute une requête d'agrégation.

runQuery

Exécute une requête.