Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

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/{project_id}/databases/{database_id}/documents/{document_path} .

fields

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

Los campos del documento.

Las claves del mapa representan los nombres de los campos.

Un nombre de campo sencilla sólo contiene caracteres a a z , A a Z , 0 a 9 , o _ , y no debe comenzar con 0 a 9 . Por ejemplo, foo_bar_17 .

Los nombres de campo que coinciden con la expresión regular __.*__ están reservados. Los nombres de campos reservados están prohibidos excepto en ciertos contextos documentados. Las claves del mapa, representadas como UTF-8, no deben exceder los 1500 bytes y no pueden estar vacías.

Las rutas de campo se pueden utilizar en otros contextos para hacer referencia a campos estructurados definidos aquí. Para mapValue , la ruta del campo está representada por los nombres de campo simples o entre comillas de los campos que los contienen, delimitados por . . Por ejemplo, el campo estructurado "foo" : { mapValue: { "x&y" : { stringValue: "hello" }}} estaría representado por la ruta del campo foo.x&y .

Dentro de una ruta de campo, un nombre de campo entre comillas comienza y termina con ` y puede contener cualquier carácter. Algunos caracteres, incluido ` , deben escaparse usando un \ . Por ejemplo, `x&y` representa x&y `bak\`tik` representa bak`tik .

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

createTime

string ( Timestamp format)

Solo salida. La hora a 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 con el readTime de 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)

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

Este valor se establece inicialmente en createTime luego aumenta monótonamente con cada cambio en el documento. También se puede comparar con valores de otros documentos y con el readTime de 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 varios documentos.

batchWrite

Aplica un lote de operaciones de escritura.

beginTransaction

Inicia una nueva transacción.

commit

Confirma una transacción, mientras que opcionalmente actualiza documentos.

createDocument

Crea un nuevo documento.

delete

Elimina un documento.

get

Obtiene un solo documento.

list

Enumera documentos.

listCollectionIds

Enumera todas las ID de colección debajo de un documento.

partitionQuery

Particiona una consulta al devolver cursores de partición que se pueden utilizar para ejecutar la consulta en paralelo.

patch

Actualiza o inserta un documento.

rollback

Revierte una transacción.

runQuery

Ejecuta una consulta.