REST Resource: projects.databases.documents

Ressource : Document

Un document Firestore.

Ne doit pas dépasser 1 Mo - 4 octets.

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

string

Le nom de la ressource du document, par projects/{projectId}/databases/{databaseId}/documents/{document_path} .

fields

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

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

createTime

string ( Timestamp format)

Sortie uniquement. L'heure à laquelle le document a été créé.

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

Un horodatage au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Sortie uniquement. Heure à laquelle le document a été modifié pour la dernière fois.

Cette valeur est initialement définie sur createTime , puis augmente de manière monotone à chaque modification apportée au document. Il peut également être comparé aux valeurs d'autres documents et au readTime d'une requête.

Un horodatage au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .

Méthodes

batchGet

Obtient plusieurs documents.

batchWrite

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

beginTransaction

Commence une nouvelle transaction.

commit

Valide une transaction, tout en mettant éventuellement à jour les documents.

createDocument

Crée un nouveau document.

delete

Supprime un document.

get

Obtient 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 qui peuvent ê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.