Bando
GitHubComunidade

Documentação Bando

Documentos e relations

Entende a diferença entre uma collection e um documento e aprende a relacionar documentos.

Collection vs. document

Esta é uma das distinções mais importantes do Bando.

A collection descreve a estrutura. Um document é um registro concreto dessa estrutura.

CollectionDefine como um post deve ser.
DocumentRepresenta um post específico.

Se a collection for posts, podemos ter documentos como:

JSON
{
"id": "post-123",
"collection": "posts",
"data": {
"title": "Aprendendo Bando",
"slug": "aprendendo-bando",
"content": "Meu primeiro artigo",
"published": true
}
}

Estrutura de um documento

O Bando trabalha com documentos que possuem informações sobre o próprio registro e os dados definidos pela collection.

  • id identifica o documento.
  • collection indica a collection à qual pertence.
  • data contém os campos definidos pela collection.
  • createdAt indica quando foi criado.
  • updatedAt indica quando foi atualizado.

Relations

Uma relation permite que um documento faça referência a outro documento.

Imagina que cada post possui um autor. Em vez de duplicar todas as informações do autor dentro do post, podemos guardar uma referência ao documento da collection authors.

TS
author: relation({
collection: "authors",
required: true,
})

O fluxo pode ser entendido assim:

postsDocumento do artigo.
authorReferência.
authorsDocumento do autor.

Uma relation para vários documentos

Quando um documento pode referenciar vários documentos, utiliza multiple: true.

TS
reviewers: relation({
collection: "authors",
multiple: true,
})
Gerir documentos no Studio →
Documentos e relations | Bando