REST Resource: projects.databases.documents

Recurso: Documento

Un documento de Firestore.

No debe exceder 1 MiB - 4 bytes.

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

string

El nombre del 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)

Sólo salida. La hora en la que se creó el documento.

Este valor aumenta monótonamente cuando se elimina 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 "Zulu", con 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)

Sólo salida. La hora a la que se modificó el documento por última vez.

Este valor se establece inicialmente en createTime y luego aumenta monótonamente 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 "Zulu", con 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 múltiples documentos.

batchWrite

Aplica un lote de operaciones de escritura.

beginTransaction

Inicia una nueva transacción.

commit

Confirma una transacción y, opcionalmente, actualiza los documentos.

createDocument

Crea un nuevo documento.

delete

Elimina un documento.

get

Obtiene un solo documento.

list

Enumera documentos.

listCollectionIds

Enumera todos los ID de colección debajo de un documento.

listDocuments

Enumera documentos.

partitionQuery

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

patch

Actualiza o inserta un documento.

rollback

Deshace una transacción.

runAggregationQuery

Ejecuta una consulta de agregación.

runQuery

Ejecuta una consulta.