REST Resource: projects.databases.documents

Recurso: Documento

Un documento de Firestore

No debe exceder los 1 MiB a 4 bytes.

Representación JSON
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Campos
name

string

El nombre de recurso del documento, por ejemplo projects/{projectId}/databases/{databaseId}/documents/{document_path}.

fields

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

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Solo salida. Indica la hora en la que se creó el documento.

Este valor aumenta de forma monotónica cuando se borra un documento y, luego, se vuelve a crear. También se puede comparar con valores de otros documentos y el readTime de una consulta.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo salida. Indica la hora en la que se modificó el documento por última vez.

Este valor se establece inicialmente en createTime y, luego, aumenta de forma monotónica con cada cambio en el documento. También se puede comparar con valores de otros documentos y el readTime de una consulta.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Métodos

batchGet

Obtiene varios documentos.

batchWrite

Aplica un lote de operaciones de escritura.

beginTransaction

Inicia una transacción nueva.

commit

Confirma una transacción y, de forma opcional, actualiza documentos.

createDocument

Crea un documento nuevo.

delete

Borra un documento.

get

Obtiene un solo documento.

list

Muestra una lista de documentos.

listCollectionIds

Muestra una lista de todos los ID de colección incluidos en un documento.

listDocuments

Muestra una lista de documentos.

partitionQuery

Particiona una consulta mediante la devolución de cursores de partición que se pueden usar para ejecutar la consulta en paralelo.

patch

Actualiza o inserta un documento.

rollback

Revierte una transacción.

runAggregationQuery

Ejecuta una consulta de agregación.

runQuery

Ejecuta una consulta.