REST Resource: projects.databases.documents

Recurso: Documento

Um documento do Firestore.

Não deve exceder 1 MiB – 4 bytes.

Representação JSON
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Campos
name

string

O nome do recurso do documento, por exemplo projects/{projectId}/databases/{databaseId}/documents/{document_path} .

fields

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

Um objeto que contém uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Somente saída. A hora em que o documento foi criado.

Este valor aumenta monotonicamente quando um documento é excluído e depois recriado. Também pode ser comparado com valores de outros documentos e com o readTime de uma consulta.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Somente saída. A hora em que o documento foi alterado pela última vez.

Este valor é inicialmente definido como createTime e depois aumenta monotonicamente com cada alteração no documento. Também pode ser comparado com valores de outros documentos e com o readTime de uma consulta.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

Métodos

batchGet

 Obtém vários documentos.

batchWrite

 Aplica um lote de operações de gravação.

beginTransaction

 Inicia uma nova transação.

commit

 Confirma uma transação, enquanto opcionalmente atualiza documentos.

createDocument

 Cria um novo documento.

delete

 Exclui um documento.

get

 Obtém um único documento.

list

 Lista documentos.

listCollectionIds

 Lista todos os IDs de coleção abaixo de um documento.

listDocuments

 Lista documentos.

partitionQuery

 Particiona uma consulta retornando cursores de partição que podem ser usados ​​para executar a consulta em paralelo.

patch

 Atualiza ou insere um documento.

rollback

 Reverte uma transação.

runAggregationQuery

 Executa uma consulta de agregação.

runQuery

 Executa uma consulta.