{"id":10947,"date":"2021-03-30T09:13:45","date_gmt":"2021-03-30T16:13:45","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=10947"},"modified":"2025-06-13T23:42:25","modified_gmt":"2025-06-14T06:42:25","slug":"introduction-to-ottoman-with-couchbase","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/pt\/introduction-to-ottoman-with-couchbase\/","title":{"rendered":"Introdu\u00e7\u00e3o ao Ottoman com o Couchbase"},"content":{"rendered":"

O Ottoman \u00e9 um Object Data Modeler (ODM) para o SDK Node.js do Couchbase que fornece esquema e valida\u00e7\u00e3o JSON para NoSQL.<\/span><\/p>\n

Por que usar um ODM para o Couchbase<\/h2>\n

Com o Ottoman, voc\u00ea declara o esquema em seu c\u00f3digo. Embora o Couchbase n\u00e3o tenha imposi\u00e7\u00e3o de esquema para seus documentos, a maioria dos aplicativos precisa de algum n\u00edvel de esquema, mesmo no NoSQL. Vamos explorar como obter o esquema e a valida\u00e7\u00e3o no NoSQL usando o Ottoman e o Couchbase. <\/span><\/p>\n

\u00c9 importante validar se os documentos atendem a determinados requisitos antes de persistir. Embora o Ottoman crie uma abstra\u00e7\u00e3o sobre o SDK do Couchbase, as vantagens superam as desvantagens. Um desenvolvedor cria muita l\u00f3gica para criar e atualizar documentos, escrever o ciclo de vida pr\u00e9\/p\u00f3s, trabalhar com estruturas de dados e valida\u00e7\u00e3o.<\/span><\/p>\n

Banco de dados NoSQL e projeto de esquema<\/h3>\n

Um ODM desempenha uma fun\u00e7\u00e3o semelhante no NoSQL e em um banco de dados relacional, mas com benef\u00edcios adicionais. O Couchbase n\u00e3o imp\u00f5e valida\u00e7\u00e3o, pois \u00e9 flex\u00edvel em termos de esquema. O Ottoman pode realizar determinadas verifica\u00e7\u00f5es \u00e0 medida que seus aplicativos persistem nos dados. Podemos advertir e errar contra tipos e formatos de dados indesejados para campos individuais, definindo esquemas e modelos para v\u00e1rios tipos de documentos.<\/p>\n

O c\u00f3digo do aplicativo do servidor \u00e9 um \u00f3timo lugar para aplicar l\u00f3gica e valida\u00e7\u00e3o de neg\u00f3cios. O objetivo do Ottoman \u00e9 proporcionar uma melhor experi\u00eancia de desenvolvimento, al\u00e9m de oferecer controle sobre o esquema e a valida\u00e7\u00e3o ao usar o Couchbase com o Node. Queremos oferecer aos desenvolvedores uma ferramenta confi\u00e1vel para criar sistemas que sejam f\u00e1ceis de projetar, manter e dimensionar.<\/span><\/p>\n

\"Object<\/a><\/p>\n

O Couchbase \u00e9 um banco de dados NoSQL<\/span><\/h2>\n

O Couchbase Server \u00e9 um banco de dados de documentos sem esquema, categorizado como um armazenamento de dados NoSQL, mas essa n\u00e3o \u00e9 a melhor descri\u00e7\u00e3o, pois o Couchbase usa uma variante do SQL para fazer consultas, chamada N1QL<\/a>. O fato de um esquema n\u00e3o ser rigorosamente aplicado em bancos de dados NoSQL como o Couchbase n\u00e3o significa que voc\u00ea n\u00e3o deva aplic\u00e1-lo.<\/span><\/p>\n

Com o Couchbase, voc\u00ea obt\u00e9m os benef\u00edcios do dimensionamento de n\u00edvel empresarial, n\u00f3s em cluster e a capacidade de armazenar e recuperar dados em um formato JSON.<\/span><\/p>\n

Se voc\u00ea estiver familiarizado com o Mongoose, um ODM para MongoDB, voc\u00ea se sentir\u00e1 bastante confort\u00e1vel com o Ottoman, pois eles t\u00eam muitos recursos que se sobrep\u00f5em, j\u00e1 que ambos s\u00e3o feitos para NodeJS e usados para modelar e persistir dados em um banco de dados de valores-chave orientado a documentos JSON.<\/span><\/p>\n

Documento vs. Relacional <\/span>Banco de dados<\/span><\/h2>\n

Ao explorarmos o Couchbase e o banco de dados NoSQL e o design de esquema, primeiro veremos como uma estrutura de dados de documento difere do design de um banco de dados relacional. No exemplo abaixo, voc\u00ea ver\u00e1 uma compara\u00e7\u00e3o lado a lado dos dados que representam um hotel. <\/span><\/p>\n

\u00c0 esquerda, temos um documento que pode armazenar n\u00fameros de telefone em uma matriz, o que nos permite armazenar v\u00e1rios n\u00fameros de telefone de um \u00fanico hotel. Para fazer isso em um banco de dados relacional, voc\u00ea certamente precisaria de uma nova tabela e manter um relacionamento entre as duas usando chaves prim\u00e1rias.<\/span><\/p>\n

\"NoSQL<\/a><\/span><\/p>\n

Para obter mais informa\u00e7\u00f5es sobre modelagem de documentos, confira os recursos que reuni em uma postagem do blog: Guia de modelagem de dados JSON<\/a><\/span><\/p>\n

No Ottoman, temos muitas constru\u00e7\u00f5es para ajudar a definir o esquema e os modelos no n\u00edvel do aplicativo. Vamos examinar alguns dos termos mais importantes que voc\u00ea precisa conhecer no Ottoman.<\/span><\/p>\n

Tipos<\/span><\/h3>\n

Como visto em rosa na imagem acima, as propriedades do documento com o tipo de nome no Couchbase s\u00e3o quase equivalentes \u00e0s tabelas em um banco de dados relacional. Elas podem ajudar a agrupar diferentes tipos de documentos JSON para fins de indexa\u00e7\u00e3o. Ao usar \u00edndices secund\u00e1rios no Couchbase, podemos indexar em qualquer chave nos documentos. Se apenas 100 dos 10.000 documentos do seu banco de dados usarem um tipo de \"hotel\" e voc\u00ea normalmente quiser pesquisar hot\u00e9is com base na cidade ou no estado, conv\u00e9m criar um \u00cdndice Secund\u00e1rio Composto que s\u00f3 precise pesquisar os cem documentos em que a cidade ou o estado seja igual a um determinado valor. Isso \u00e9 muito mais eficiente do que usar, por exemplo, um \u00edndice prim\u00e1rio. <\/span><\/p>\n

Saiba mais sobre a indexa\u00e7\u00e3o no Couchbase<\/a>!<\/span><\/p>\n

Cole\u00e7\u00f5es<\/span><\/h3>\n

Semelhante aos tipos no Couchbase 6.x (vers\u00e3o principal mais recente do Couchbase no momento em que este artigo foi escrito) e n\u00e3o mostrado na ilustra\u00e7\u00e3o acima, as cole\u00e7\u00f5es ser\u00e3o favorecidas no Couchbase 7 (<\/span>j\u00e1 em vers\u00e3o beta<\/span><\/a>). No caso de usar cole\u00e7\u00f5es, voc\u00ea simplesmente n\u00e3o teria um 'tipo'<\/strong> em cada documento e, em vez disso, ter o documento atribu\u00eddo a uma propriedade 'hotel'<\/strong> cole\u00e7\u00e3o.<\/span><\/p>\n

Documentos<\/span><\/h3>\n

Compar\u00e1vel a linhas de dados em um banco de dados relacional. Os sistemas RDBMS tradicionais fazem refer\u00eancia a documentos relacionados de outras tabelas, como visto na ilustra\u00e7\u00e3o acima. No entanto, tamb\u00e9m \u00e9 poss\u00edvel fazer isso com um documento JSON; sugere-se incluir essas informa\u00e7\u00f5es como um documento incorporado quando poss\u00edvel, como vemos na propriedade de n\u00famero de telefone do documento do hotel, que \u00e9 uma matriz de n\u00fameros de telefone. Embora seja um exemplo muito simples, pense que se voc\u00ea tivesse uma propriedade de endere\u00e7o que fosse outro objeto JSON com muitas propriedades, voc\u00ea poderia pensar que ela precisaria ter seu pr\u00f3prio documento, mas aninhar essas informa\u00e7\u00f5es no documento pai, na maioria dos casos, n\u00e3o tem problema.<\/span><\/p>\n

Campos<\/span><\/h3>\n

Tamb\u00e9m conhecidos como atributos, s\u00e3o semelhantes \u00e0s colunas em um banco de dados relacional e, com o Ottoman, voc\u00ea pode criar requisitos em n\u00edvel de campo como parte do seu esquema.<\/span><\/p>\n

Esquema<\/span><\/h3>\n

Embora o Couchbase n\u00e3o tenha esquema ou seja flex\u00edvel, ainda podemos impor a estrutura no n\u00edvel do aplicativo para nossos documentos.<\/span><\/p>\n

Modelo<\/span><\/h3>\n

Um m\u00e9todo construtor que recebe um esquema e cria uma inst\u00e2ncia de um documento equivalente a um \u00fanico registro em um banco de dados relacional. Essa inst\u00e2ncia de documento pode ser constru\u00edda e depois persistida no Couchbase pelo Ottoman usando o salvar()<\/code> m\u00e9todo<\/a>.<\/span><\/p>\n

Primeiros passos<\/span><\/h2>\n

Vamos come\u00e7ar a criar um aplicativo de demonstra\u00e7\u00e3o que podemos usar para nos familiarizarmos com o Ottoman como um mapeador de documentos de objetos.<\/p>\n

Instala\u00e7\u00e3o do Couchbase<\/span><\/h3>\n

Antes de come\u00e7armos, vamos configurar o Couchbase. <\/span><\/p>\n

Voc\u00ea pode escolher entre <\/span>uma das seguintes op\u00e7\u00f5es<\/b> (estamos usando a op\u00e7\u00e3o #1 para este artigo):<\/span><\/p>\n

    \n
  1. Instalar o Couchbase Server usando o Docker<\/span><\/a><\/li>\n
  2. Fa\u00e7a o download do Couchbase espec\u00edfico para seu sistema operacional no site <\/span>Site do Couchbase<\/span><\/a><\/li>\n<\/ol>\n

    Vamos navegar por alguns dos conceitos b\u00e1sicos do Ottoman implementando um modelo que representa os dados de um exemplo simplificado de companhia a\u00e9rea, mantendo a tradi\u00e7\u00e3o do conjunto de dados Travel-Sample do Couchbase.<\/span><\/p>\n

    Estou usando o Visual Studio Code, o NodeJS v12.14 e o NPM 6.14.8, portanto, voc\u00ea precisar\u00e1 ter o Node.js instalado em seu computador.<\/span><\/p>\n

    Inicializando nosso projeto com o NPM<\/span><\/h3>\n

    Crie um diret\u00f3rio, inicialize nosso projeto, instale o Ottoman.js e abra-o no VS Code<\/span><\/p>\n

    mkdir intro-ottoman && cd $_ && npm init -y && npm i ottoman && touch createAirline.js && code .<\/pre>\n
    Abra o terminal no editor de sua prefer\u00eancia. Eu adicionei um comando no final que abrir\u00e1 no VS Code.<\/span><\/p>\n
    Conex\u00e3o com o Couchbase com o Ottoman<\/span><\/h3>\n
    Come\u00e7aremos a trabalhar a partir do arquivo .\/createAirline.js<\/code><\/span> na raiz do projeto e adicione o seguinte (com base na configura\u00e7\u00e3o padr\u00e3o):<\/span><\/p>\n
    const { Ottoman, model, Schema } = require('ottoman')\r\n\r\nconst ottoman = new Ottoman({collectionName: '_default'});\r\nottoman.connect({\r\n    connectionString: 'couchbase:\/\/localhost',\r\n    bucketName: 'travel',\r\n    username: 'Administrator',\r\n    password: 'password'\r\n});<\/pre>\n
    Juntos, eles importam o pacote ottoman e especificam a cole\u00e7\u00e3o padr\u00e3o (estilo do Couchbase Server 6.x)<\/span><\/p>\n
    Esquema e modelos otomanos<\/h3>\n
    Os modelos s\u00e3o construtores sofisticados compilados a partir de defini\u00e7\u00f5es de esquema. Uma inst\u00e2ncia de um modelo \u00e9 chamada de documento. Os modelos no Ottoman ajudam voc\u00ea a criar, ler, atualizar e excluir facilmente documentos no banco de dados do Couchbase.<\/span><\/p>\n
    A cria\u00e7\u00e3o de um modelo de otomana inclui alguns aspectos:<\/span><\/p>\n
    Defini\u00e7\u00e3o de um esquema de documento<\/span><\/h3>\n
    Um esquema define as propriedades do documento por meio de um objeto em que o nome da chave corresponde ao nome da propriedade na cole\u00e7\u00e3o.<\/span><\/p>\n
    const airlineSchema = new Schema({\r\n   callsign: String, \r\n   country: String, \r\n   name: String \r\n})<\/pre>\n
    Aqui definimos tr\u00eas propriedades (indicativo, pa\u00eds, nome)<\/strong> em nosso esquema, todos do tipo <\/span>Cordas.<\/b> Especificando um tipo para cada uma das propriedades do nosso modelo, \u00a0mapeia para um validador interno que ser\u00e1 acionado quando o modelo for salvo no banco de dados e falhar\u00e1 se o tipo de dados do valor n\u00e3o for do tipo <\/span>Cordas<\/b>.<\/span><\/p>\n
    Os seguintes tipos de esquema s\u00e3o permitidos:<\/span><\/p>\n