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

Recurso REST: 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 teclas del mapa representan nombres de campo.

Un nombre de campo simple contiene solo los caracteres de la a a la z , de la A a la Z , de 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 campo reservados están prohibidos, excepto en ciertos contextos documentados. Las claves del mapa, representadas como UTF-8, no deben exceder los 1.500 bytes y no pueden estar vacías.

Las rutas de campo pueden usarse en otros contextos para referirse 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 de campo foo.x&y .

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

Un objeto que contiene una lista de "key": value pares de "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 monotónicamente cuando un documento se elimina y luego se vuelve a crear. También se puede comparar con los valores de otros documentos y 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 fraccionales. 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ó el documento por última vez.

Este valor se establece inicialmente en createTime luego aumenta monotónicamente con cada cambio en el documento. También se puede comparar con los valores de otros documentos y 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 fraccionales. 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, al tiempo que actualiza documentos

createDocument

Crea un nuevo documento.

delete

Borra un documento.

get

Obtiene un solo documento.

list

Listas de documentos.

listCollectionIds

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

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

Revierte una transacción.

runQuery

Ejecuta una consulta.