Databases

API antiga de bancos (coleções e documentos). Em projeto novo, use TablesDB.

Classe Databases: 71 métodos (14 no @owbase/web, 71 no @owbase/node). Os exemplos usam a forma de objeto dos parâmetros; troque os valores entre < e > pelos seus.

list

Listar bancos

SDK: só @owbase/node

Obtém a lista de todos os bancos do projeto Owbase atual. Use o parâmetro search para filtrar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: name
`search`	`string`	não	Termo de busca para filtrar a lista. Tamanho máximo: 256 caracteres.
`total`	`boolean`	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo databases.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.list({
    queries: [], // opcional
    search: '<SEARCH>', // opcional
    total: false, // opcional
});

create

Criar banco

SDK: só @owbase/node

Cria um banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID único. Escolha um ID próprio ou gere um ID aleatório com `ID.unique()`. Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
`name`	`string`	sim	Nome do banco. Tamanho máximo: 128 caracteres.
`enabled`	`boolean`	não	O banco está ativo? Com false, os usuários não acessam o banco, mas os SDKs de servidor com chave de API ainda podem ler e gravar nele. Nenhum dado se perde ao alternar essa opção.

Acesso: chave de API com o escopo databases.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.create({
    databaseId: '<DATABASE_ID>',
    name: '<NAME>',
    enabled: false, // opcional
});

listTransactions

Listar transações

SDK: @owbase/web e @owbase/node

Lista as transações de todos os bancos.

Parâmetro	Tipo	Obrigatório	Descrição
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas.
`total`	`boolean`	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo rows.read ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.listTransactions({
    queries: [], // opcional
    total: false, // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.listTransactions({
    queries: [], // opcional
    total: false, // opcional
});

createTransaction

Criar transação

SDK: @owbase/web e @owbase/node

Cria uma transação.

Parâmetro	Tipo	Obrigatório	Descrição
`ttl`	`number`	não	Segundos até a transação expirar.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.createTransaction({
    ttl: 60, // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createTransaction({
    ttl: 60, // opcional
});

getTransaction

Obter transação

SDK: @owbase/web e @owbase/node

Obtém uma transação pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
`transactionId`	`string`	sim	ID da transação.

Acesso: chave de API com o escopo rows.read ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.getTransaction({
    transactionId: '<TRANSACTION_ID>',
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.getTransaction({
    transactionId: '<TRANSACTION_ID>',
});

updateTransaction

Atualizar transação

SDK: @owbase/web e @owbase/node

Atualiza uma transação, para confirmar ou desfazer as operações dela.

Parâmetro	Tipo	Obrigatório	Descrição
`transactionId`	`string`	sim	ID da transação.
`commit`	`boolean`	não	Confirmar a transação?
`rollback`	`boolean`	não	Desfazer a transação?

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.updateTransaction({
    transactionId: '<TRANSACTION_ID>',
    commit: false, // opcional
    rollback: false, // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateTransaction({
    transactionId: '<TRANSACTION_ID>',
    commit: false, // opcional
    rollback: false, // opcional
});

deleteTransaction

Excluir transação

SDK: @owbase/web e @owbase/node

Exclui uma transação pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
`transactionId`	`string`	sim	ID da transação.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.deleteTransaction({
    transactionId: '<TRANSACTION_ID>',
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.deleteTransaction({
    transactionId: '<TRANSACTION_ID>',
});

createOperations

Criar operações

SDK: @owbase/web e @owbase/node

Cria várias operações numa única transação.

Parâmetro	Tipo	Obrigatório	Descrição
`transactionId`	`string`	sim	ID da transação.
`operations`	`object[]`	não	Lista de operações preparadas.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.createOperations({
    transactionId: '<TRANSACTION_ID>',
    operations: [
        {
            action: 'create',
            databaseId: '<DATABASE_ID>',
            collectionId: '<COLLECTION_ID>',
            documentId: '<DOCUMENT_ID>',
            data: {
                name: "Walter O'Brien",
            },
        },
    ], // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createOperations({
    transactionId: '<TRANSACTION_ID>',
    operations: [
        {
            action: 'create',
            databaseId: '<DATABASE_ID>',
            collectionId: '<COLLECTION_ID>',
            documentId: '<DOCUMENT_ID>',
            data: {
                name: "Walter O'Brien",
            },
        },
    ], // opcional
});

get

Obter banco

SDK: só @owbase/node

Obtém um banco pelo ID. A resposta é um objeto JSON com os metadados do banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.

Acesso: chave de API com o escopo databases.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.get({
    databaseId: '<DATABASE_ID>',
});

update

Atualizar banco

SDK: só @owbase/node

Atualiza um banco pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`name`	`string`	não	Nome do banco. Tamanho máximo: 128 caracteres.
`enabled`	`boolean`	não	O banco está ativo? Com false, os usuários não acessam o banco, mas os SDKs de servidor com chave de API ainda podem ler e gravar nele. Nenhum dado se perde ao alternar essa opção.

Acesso: chave de API com o escopo databases.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.update({
    databaseId: '<DATABASE_ID>',
    name: '<NAME>', // opcional
    enabled: false, // opcional
});

delete

Excluir banco

SDK: só @owbase/node

Exclui um banco pelo ID. Só chaves de API com o escopo databases.write podem excluir um banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.

Acesso: chave de API com o escopo databases.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.delete({
    databaseId: '<DATABASE_ID>',
});

listCollections

Listar coleções

SDK: só @owbase/node

Obtém a lista de todas as coleções do databaseId informado. Use o parâmetro search para filtrar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: name, enabled, documentSecurity
`search`	`string`	não	Termo de busca para filtrar a lista. Tamanho máximo: 256 caracteres.
`total`	`boolean`	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo collections.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.listCollections({
    databaseId: '<DATABASE_ID>',
    queries: [], // opcional
    search: '<SEARCH>', // opcional
    total: false, // opcional
});

createCollection

Criar coleção

SDK: só @owbase/node

Cria uma coleção. Antes de usar esta rota, crie o banco por uma API de integração de servidor ou diretamente no console do banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID único. Escolha um ID próprio ou gere um ID aleatório com `ID.unique()`. Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
`name`	`string`	sim	Nome da coleção. Tamanho máximo: 128 caracteres.
`permissions`	`string[]`	não	Lista de permissões em texto. Por padrão, nenhum usuário recebe permissão alguma. Saiba mais sobre permissões.
`documentSecurity`	`boolean`	não	Permite definir permissões em cada documento. O usuário precisa de permissão no documento ou na coleção para acessar um documento. Saiba mais sobre permissões.
`enabled`	`boolean`	não	A coleção está ativa? Com false, os usuários não acessam a coleção, mas os SDKs de servidor com chave de API ainda podem ler e gravar nela. Nenhum dado se perde ao alternar essa opção.
`attributes`	`object[]`	não	Lista com as definições dos atributos a criar. Cada atributo deve ter: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, obrigatório nos tipos string e varchar), required (boolean, opcional), default (misto, opcional), array (boolean, opcional) e as opções próprias de cada tipo.
`indexes`	`object[]`	não	Lista com as definições dos índices a criar. Cada índice deve ter: key (string), type (string: key, fulltext, unique, spatial), attributes (lista de chaves de atributo), orders (lista de ASC/DESC, opcional) e lengths (lista de inteiros, opcional).

Acesso: chave de API com o escopo collections.write.

import { Client, Databases, Permission, Role } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createCollection({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    name: '<NAME>',
    permissions: [Permission.read(Role.any())], // opcional
    documentSecurity: false, // opcional
    enabled: false, // opcional
    attributes: [], // opcional
    indexes: [], // opcional
});

getCollection

Obter coleção

SDK: só @owbase/node

Obtém uma coleção pelo ID. A resposta é um objeto JSON com os metadados da coleção.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.

Acesso: chave de API com o escopo collections.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.getCollection({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
});

updateCollection

Atualizar coleção

SDK: só @owbase/node

Atualiza uma coleção pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`name`	`string`	não	Nome da coleção. Tamanho máximo: 128 caracteres.
`permissions`	`string[]`	não	Lista de permissões em texto. Por padrão, as permissões atuais são mantidas. Saiba mais sobre permissões.
`documentSecurity`	`boolean`	não	Permite definir permissões em cada documento. O usuário precisa de permissão no documento ou na coleção para acessar um documento. Saiba mais sobre permissões.
`enabled`	`boolean`	não	A coleção está ativa? Com false, os usuários não acessam a coleção, mas os SDKs de servidor com chave de API ainda podem ler e gravar nela. Nenhum dado se perde ao alternar essa opção.
`purge`	`boolean`	não	Com true, apaga todas as respostas de lista desta coleção guardadas em cache como parte da atualização. Use para que os leitores vejam os dados novos na hora, sem esperar o TTL do cache expirar.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases, Permission, Role } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateCollection({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    name: '<NAME>', // opcional
    permissions: [Permission.read(Role.any())], // opcional
    documentSecurity: false, // opcional
    enabled: false, // opcional
    purge: false, // opcional
});

deleteCollection

Excluir coleção

SDK: só @owbase/node

Exclui uma coleção pelo ID. Só usuários com permissão de escrita podem excluir este recurso.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.deleteCollection({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
});

listAttributes

Listar atributos

SDK: só @owbase/node

Lista os atributos da coleção.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: key, type, size, required, array, status, error
`total`	`boolean`	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo collections.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.listAttributes({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    queries: [], // opcional
    total: false, // opcional
});

createBigIntAttribute

Criar atributo bigint

SDK: só @owbase/node

Cria um atributo bigint. Opcionalmente, é possível informar os valores mínimo e máximo.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`min`	`number`	não	Valor mínimo
`max`	`number`	não	Valor máximo
`xdefault`	`number`	não	Valor padrão. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createBigIntAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    min: 0, // opcional
    max: 1000000, // opcional
    xdefault: 0, // opcional
    array: false, // opcional
});

updateBigIntAttribute

Atualizar atributo bigint

SDK: só @owbase/node

Atualiza um atributo bigint. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number`	não	Valor padrão. Não pode ser definido quando o atributo é obrigatório.
`min`	`number`	não	Valor mínimo
`max`	`number`	não	Valor máximo
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateBigIntAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 0,
    min: 0, // opcional
    max: 1000000, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createBooleanAttribute

Criar atributo booleano

SDK: só @owbase/node

Cria um atributo booleano.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`boolean`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createBooleanAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: false, // opcional
    array: false, // opcional
});

updateBooleanAttribute

Atualizar atributo booleano

SDK: só @owbase/node

Atualiza um atributo booleano. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`boolean`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateBooleanAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: false,
    newKey: '<NEW_KEY>', // opcional
});

createDatetimeAttribute

Criar atributo de data e hora

SDK: só @owbase/node

Cria um atributo de data e hora no padrão ISO 8601.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo no formato ISO 8601. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createDatetimeAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '2020-10-15T06:38:00.000+00:00', // opcional
    array: false, // opcional
});

updateDatetimeAttribute

Atualizar atributo de data e hora

SDK: só @owbase/node

Atualiza um atributo de data e hora. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateDatetimeAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '2020-10-15T06:38:00.000+00:00',
    newKey: '<NEW_KEY>', // opcional
});

createEmailAttribute

Criar atributo de e-mail

SDK: só @owbase/node

Cria um atributo de e-mail.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createEmailAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'email@example.com', // opcional
    array: false, // opcional
});

updateEmailAttribute

Atualizar atributo de e-mail

SDK: só @owbase/node

Atualiza um atributo de e-mail. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateEmailAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'email@example.com',
    newKey: '<NEW_KEY>', // opcional
});

createEnumAttribute

Criar atributo enum

SDK: só @owbase/node

Cria um atributo enum. O parâmetro elements funciona como a lista dos valores aceitos nesse atributo.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`elements`	`string[]`	sim	Lista de valores do enum.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createEnumAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    elements: ['active', 'inactive'],
    required: false,
    xdefault: 'active', // opcional
    array: false, // opcional
});

updateEnumAttribute

Atualizar atributo enum

SDK: só @owbase/node

Atualiza um atributo enum. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`elements`	`string[]`	sim	Nova lista de valores do enum.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateEnumAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    elements: ['active', 'inactive'],
    required: false,
    xdefault: 'active',
    newKey: '<NEW_KEY>', // opcional
});

createFloatAttribute

Criar atributo float

SDK: só @owbase/node

Cria um atributo float. Opcionalmente, é possível informar os valores mínimo e máximo.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`min`	`number`	não	Valor mínimo.
`max`	`number`	não	Valor máximo.
`xdefault`	`number`	não	Valor padrão. Não pode ser definido quando a coluna é obrigatória.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createFloatAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    min: 0, // opcional
    max: 100, // opcional
    xdefault: 10.5, // opcional
    array: false, // opcional
});

updateFloatAttribute

Atualizar atributo float

SDK: só @owbase/node

Atualiza um atributo float. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number`	não	Valor padrão. Não pode ser definido quando a coluna é obrigatória.
`min`	`number`	não	Valor mínimo.
`max`	`number`	não	Valor máximo.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateFloatAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 10.5,
    min: 0, // opcional
    max: 100, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createIntegerAttribute

Criar atributo de inteiro

SDK: só @owbase/node

Cria um atributo de inteiro. Opcionalmente, é possível informar os valores mínimo e máximo.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`min`	`number`	não	Valor mínimo
`max`	`number`	não	Valor máximo
`xdefault`	`number`	não	Valor padrão. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createIntegerAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    min: 0, // opcional
    max: 100, // opcional
    xdefault: 10, // opcional
    array: false, // opcional
});

updateIntegerAttribute

Atualizar atributo de inteiro

SDK: só @owbase/node

Atualiza um atributo de inteiro. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number`	não	Valor padrão. Não pode ser definido quando o atributo é obrigatório.
`min`	`number`	não	Valor mínimo
`max`	`number`	não	Valor máximo
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateIntegerAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 10,
    min: 0, // opcional
    max: 100, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createIpAttribute

Criar atributo de endereço IP

SDK: só @owbase/node

Cria um atributo de endereço IP.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createIpAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '192.0.2.0', // opcional
    array: false, // opcional
});

updateIpAttribute

Atualizar atributo de endereço IP

SDK: só @owbase/node

Atualiza um atributo de IP. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateIpAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '192.0.2.0',
    newKey: '<NEW_KEY>', // opcional
});

createLineAttribute

Criar atributo de linha geométrica

SDK: só @owbase/node

Cria um atributo de linha geométrica.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number[][]`	não	Valor padrão do atributo quando nenhum for informado: lista bidimensional de pares de coordenadas, [[longitude, latitude], [longitude, latitude], …], com os vértices da linha em ordem. Não pode ser definido quando o atributo é obrigatório.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createLineAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [
        [1, 2],
        [3, 4],
        [5, 6],
    ], // opcional
});

updateLineAttribute

Atualizar atributo de linha geométrica

SDK: só @owbase/node

Atualiza um atributo de linha geométrica. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number[][]`	não	Valor padrão do atributo quando nenhum for informado: lista bidimensional de pares de coordenadas, [[longitude, latitude], [longitude, latitude], …], com os vértices da linha em ordem. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateLineAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [
        [1, 2],
        [3, 4],
        [5, 6],
    ], // opcional
    newKey: '<NEW_KEY>', // opcional
});

createLongtextAttribute

Criar atributo longtext

SDK: só @owbase/node

Cria um atributo longtext.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?
`encrypt`	`boolean`	não	Liga ou desliga a criptografia do atributo. A criptografia aumenta a segurança, porque nenhum valor fica gravado em texto puro no banco. Porém, atributos criptografados não podem ser consultados.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createLongtextAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateLongtextAttribute

Atualizar atributo longtext

SDK: só @owbase/node

Atualiza um atributo longtext. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateLongtextAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    newKey: '<NEW_KEY>', // opcional
});

createMediumtextAttribute

Criar atributo mediumtext

SDK: só @owbase/node

Cria um atributo mediumtext.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?
`encrypt`	`boolean`	não	Liga ou desliga a criptografia do atributo. A criptografia aumenta a segurança, porque nenhum valor fica gravado em texto puro no banco. Porém, atributos criptografados não podem ser consultados.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createMediumtextAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateMediumtextAttribute

Atualizar atributo mediumtext

SDK: só @owbase/node

Atualiza um atributo mediumtext. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateMediumtextAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    newKey: '<NEW_KEY>', // opcional
});

createPointAttribute

Criar atributo de ponto

SDK: só @owbase/node

Cria um atributo de ponto geométrico.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number[]`	não	Valor padrão do atributo quando nenhum for informado: lista de dois números [longitude, latitude], que representa uma coordenada. Não pode ser definido quando o atributo é obrigatório.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createPointAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [1, 2], // opcional
});

updatePointAttribute

Atualizar atributo de ponto

SDK: só @owbase/node

Atualiza um atributo de ponto. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number[]`	não	Valor padrão do atributo quando nenhum for informado: lista de dois números [longitude, latitude], que representa uma coordenada. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updatePointAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [1, 2], // opcional
    newKey: '<NEW_KEY>', // opcional
});

createPolygonAttribute

Criar atributo de polígono

SDK: só @owbase/node

Cria um atributo de polígono geométrico.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number[][][]`	não	Valor padrão do atributo quando nenhum for informado: lista tridimensional em que a lista externa tem um ou mais anéis lineares, [[[longitude, latitude], …], …]. O primeiro anel é o contorno externo, os anéis seguintes são buracos internos, e cada anel precisa começar e terminar com o mesmo par de coordenadas. Não pode ser definido quando o atributo é obrigatório.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createPolygonAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [
        [
            [1, 2],
            [3, 4],
            [5, 6],
            [1, 2],
        ],
    ], // opcional
});

updatePolygonAttribute

Atualizar atributo de polígono

SDK: só @owbase/node

Atualiza um atributo de polígono. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`number[][][]`	não	Valor padrão do atributo quando nenhum for informado: lista tridimensional em que a lista externa tem um ou mais anéis lineares, [[[longitude, latitude], …], …]. O primeiro anel é o contorno externo, os anéis seguintes são buracos internos, e cada anel precisa começar e terminar com o mesmo par de coordenadas. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updatePolygonAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [
        [
            [1, 2],
            [3, 4],
            [5, 6],
            [1, 2],
        ],
    ], // opcional
    newKey: '<NEW_KEY>', // opcional
});

createRelationshipAttribute

Criar atributo de relação

SDK: só @owbase/node

Cria um atributo de relação. Saiba mais sobre atributos de relação.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`relatedCollectionId`	`string`	sim	ID da coleção relacionada.
`type`	`RelationshipType`	sim	Tipo de relação. Valores possíveis: oneToOne, oneToMany, manyToOne, manyToMany. Valores: `oneToOne`, `manyToOne`, `manyToMany`, `oneToMany`.
`twoWay`	`boolean`	não	É de mão dupla?
`key`	`string`	não	Chave do atributo.
`twoWayKey`	`string`	não	Chave do atributo de mão dupla.
`onDelete`	`RelationMutate`	não	Regra ao excluir. Valores possíveis: cascade, restrict, setNull. Valores: `cascade`, `restrict`, `setNull`.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases, RelationshipType, RelationMutate } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createRelationshipAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    relatedCollectionId: '<RELATED_COLLECTION_ID>',
    type: RelationshipType.OneToOne,
    twoWay: false, // opcional
    key: '<KEY>', // opcional
    twoWayKey: '<TWO_WAY_KEY>', // opcional
    onDelete: RelationMutate.Cascade, // opcional
});

updateRelationshipAttribute

Atualizar atributo de relação

SDK: só @owbase/node

Atualiza um atributo de relação. Saiba mais sobre atributos de relação.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`onDelete`	`RelationMutate`	não	Regra ao excluir. Valores possíveis: cascade, restrict, setNull. Valores: `cascade`, `restrict`, `setNull`.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases, RelationMutate } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateRelationshipAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    onDelete: RelationMutate.Cascade, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createStringAttribute

Criar atributo string

SDK: só @owbase/node

Cria um atributo string.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma tabela com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`size`	`number`	sim	Tamanho do atributo de texto, em número de caracteres.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?
`encrypt`	`boolean`	não	Liga ou desliga a criptografia do atributo. A criptografia aumenta a segurança, porque nenhum valor fica gravado em texto puro no banco. Porém, atributos criptografados não podem ser consultados.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createStringAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    size: 1,
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateStringAttribute

Atualizar atributo string

SDK: só @owbase/node

Atualiza um atributo string. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma tabela com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`size`	`number`	não	Tamanho máximo do atributo string.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateStringAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    size: 1, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createTextAttribute

Criar atributo de texto

SDK: só @owbase/node

Cria um atributo de texto.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?
`encrypt`	`boolean`	não	Liga ou desliga a criptografia do atributo. A criptografia aumenta a segurança, porque nenhum valor fica gravado em texto puro no banco. Porém, atributos criptografados não podem ser consultados.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createTextAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateTextAttribute

Atualizar atributo de texto

SDK: só @owbase/node

Atualiza um atributo de texto. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateTextAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    newKey: '<NEW_KEY>', // opcional
});

createUrlAttribute

Criar atributo de URL

SDK: só @owbase/node

Cria um atributo de URL.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createUrlAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'https://example.com', // opcional
    array: false, // opcional
});

updateUrlAttribute

Atualizar atributo de URL

SDK: só @owbase/node

Atualiza um atributo de URL. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateUrlAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'https://example.com',
    newKey: '<NEW_KEY>', // opcional
});

createVarcharAttribute

Criar atributo varchar

SDK: só @owbase/node

Cria um atributo varchar.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`size`	`number`	sim	Tamanho do atributo varchar, em número de caracteres. O tamanho máximo é 16381.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`array`	`boolean`	não	O atributo é uma lista?
`encrypt`	`boolean`	não	Liga ou desliga a criptografia do atributo. A criptografia aumenta a segurança, porque nenhum valor fica gravado em texto puro no banco. Porém, atributos criptografados não podem ser consultados.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createVarcharAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    size: 1,
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateVarcharAttribute

Atualizar atributo varchar

SDK: só @owbase/node

Atualiza um atributo varchar. Mudar o valor default não altera os documentos que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do atributo.
`required`	`boolean`	sim	O atributo é obrigatório?
`xdefault`	`string`	não	Valor padrão do atributo quando nenhum for informado. Não pode ser definido quando o atributo é obrigatório.
`size`	`number`	não	Tamanho máximo do atributo varchar.
`newKey`	`string`	não	Nova chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateVarcharAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    size: 1, // opcional
    newKey: '<NEW_KEY>', // opcional
});

getAttribute

Obter atributo

SDK: só @owbase/node

Obtém um atributo pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.

Acesso: chave de API com o escopo collections.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.getAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
});

deleteAttribute

Excluir atributo

SDK: só @owbase/node

Exclui um atributo.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`key`	`string`	sim	Chave do atributo.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.deleteAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
});

listDocuments

Listar documentos

SDK: @owbase/web e @owbase/node

Obtém a lista de todos os documentos do usuário numa coleção. Use os parâmetros de consulta para filtrar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres.
`transactionId`	`string`	não	ID da transação, para ler as alterações ainda não confirmadas dentro dela.
`total`	`boolean`	não	Com false, o total não é calculado e volta como 0.
`ttl`	`number`	não	Tempo de vida (TTL, em segundos) do cache das respostas de lista. As respostas ficam num cache chave-valor em memória, separado por projeto, coleção, versão do esquema (atributos e índices), papéis de autorização de quem chama e a consulta exata — assim, usuários com permissões diferentes nunca compartilham entradas do cache. Mudanças no esquema invalidam o cache automaticamente; gravações de documentos, não. Por isso, escolha um TTL em que dados desatualizados sejam aceitáveis. Use 0 para desligar o cache. Precisa estar entre 0 e 86400 (24 horas).

Acesso: chave de API com o escopo documents.read ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.listDocuments({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
    total: false, // opcional
    ttl: 0, // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.listDocuments({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
    total: false, // opcional
    ttl: 0, // opcional
});

createDocument

Criar documento

SDK: @owbase/web e @owbase/node

Cria um documento. Antes de usar esta rota, crie a coleção por uma API de integração de servidor ou diretamente no console do banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database. Defina os atributos antes de criar documentos.
`documentId`	`string`	sim	ID do documento. Escolha um ID próprio ou gere um ID aleatório com `ID.unique()`. Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
`data`	`object`	sim	Dados do documento como objeto JSON.
`permissions`	`string[]`	não	Lista de permissões em texto. Por padrão, só o usuário atual recebe todas as permissões. Saiba mais sobre permissões.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases, Permission, Role } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.createDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    data: {
        username: 'walter.obrien',
        email: 'walter.obrien@example.com',
        fullName: "Walter O'Brien",
        age: 30,
        isAdmin: false,
    },
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

import { Client, Databases, Permission, Role } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.createDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    data: {
        username: 'walter.obrien',
        email: 'walter.obrien@example.com',
        fullName: "Walter O'Brien",
        age: 30,
        isAdmin: false,
    },
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

createDocuments

Criar documentos

SDK: só @owbase/node

Cria documentos. Antes de usar esta rota, crie a coleção por uma API de integração de servidor ou diretamente no console do banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database. Defina os atributos antes de criar documentos.
`documents`	`object[]`	sim	Lista com os dados dos documentos como objetos JSON.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createDocuments({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documents: [
        {
            $id: 'example1',
            username: 'walter.obrien',
            email: 'walter.obrien@example.com',
            fullName: "Walter O'Brien",
            age: 30,
            isAdmin: false,
        },
    ],
    transactionId: '<TRANSACTION_ID>', // opcional
});

upsertDocuments

Criar ou atualizar documentos

SDK: só @owbase/node

Cria ou atualiza documentos. Antes de usar esta rota, crie a coleção por uma API de integração de servidor ou diretamente no console do banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`documents`	`object[]`	sim	Lista com os dados dos documentos como objetos JSON. Pode conter documentos parciais.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.upsertDocuments({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documents: [
        {
            $id: 'example1',
            username: 'walter.obrien',
            email: 'walter.obrien@example.com',
            fullName: "Walter O'Brien",
            age: 30,
            isAdmin: false,
        },
    ],
    transactionId: '<TRANSACTION_ID>', // opcional
});

updateDocuments

Atualizar documentos

SDK: só @owbase/node

Atualiza todos os documentos que atendem às consultas; sem consultas, todos os documentos são atualizados. Você pode enviar só os campos a atualizar.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`data`	`object`	não	Dados do documento como objeto JSON. Inclua só os pares de atributo e valor a atualizar.
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.updateDocuments({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    data: {
        username: 'walter.obrien',
        email: 'walter.obrien@example.com',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

deleteDocuments

Excluir documentos

SDK: só @owbase/node

Exclui documentos em massa por consultas; sem consultas, todos os documentos são excluídos.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.deleteDocuments({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    queries: [
        '{"method":"equal", "attribute":"$id", "values":["<DOCUMENT_ID>"]}',
    ], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

getDocument

Obter documento

SDK: @owbase/web e @owbase/node

Obtém um documento pelo ID. A resposta é um objeto JSON com os dados do documento.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`documentId`	`string`	sim	ID do documento.
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres.
`transactionId`	`string`	não	ID da transação, para ler as alterações ainda não confirmadas dentro dela.

Acesso: chave de API com o escopo documents.read ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.getDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.getDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

upsertDocument

Criar ou atualizar documento

SDK: @owbase/web e @owbase/node

Cria ou atualiza um documento. Antes de usar esta rota, crie a coleção por uma API de integração de servidor ou diretamente no console do banco.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`documentId`	`string`	sim	ID do documento.
`data`	`object`	não	Dados do documento como objeto JSON. Inclua todos os atributos obrigatórios do documento a criar ou atualizar.
`permissions`	`string[]`	não	Lista de permissões em texto. Por padrão, as permissões atuais são mantidas. Saiba mais sobre permissões.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases, Permission, Role } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.upsertDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    data: {
        username: 'walter.obrien',
        email: 'walter.obrien@example.com',
        fullName: "Walter O'Brien",
        age: 30,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

import { Client, Databases, Permission, Role } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.upsertDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    data: {
        username: 'walter.obrien',
        email: 'walter.obrien@example.com',
        fullName: "Walter O'Brien",
        age: 30,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

updateDocument

Atualizar documento

SDK: @owbase/web e @owbase/node

Atualiza um documento pelo ID. Com o método patch, você envia só os campos que vão mudar.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`documentId`	`string`	sim	ID do documento.
`data`	`object`	não	Dados do documento como objeto JSON. Inclua só os pares de atributo e valor a atualizar.
`permissions`	`string[]`	não	Lista de permissões em texto. Por padrão, as permissões atuais são mantidas. Saiba mais sobre permissões.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases, Permission, Role } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.updateDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    data: {
        username: 'walter.obrien',
        email: 'walter.obrien@example.com',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

import { Client, Databases, Permission, Role } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.updateDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    data: {
        username: 'walter.obrien',
        email: 'walter.obrien@example.com',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

deleteDocument

Excluir documento

SDK: @owbase/web e @owbase/node

Exclui um documento pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`documentId`	`string`	sim	ID do documento.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.deleteDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.deleteDocument({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    transactionId: '<TRANSACTION_ID>', // opcional
});

decrementDocumentAttribute

Decrementar atributo do documento

SDK: @owbase/web e @owbase/node

Decrementa um atributo de um documento pelo valor informado.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`documentId`	`string`	sim	ID do documento.
`attribute`	`string`	sim	Chave do atributo.
`value`	`number`	não	Valor a decrementar no atributo. Precisa ser um número.
`min`	`number`	não	Valor mínimo do atributo. Se o valor atual for menor que este, a chamada falha com erro.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.decrementDocumentAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    attribute: '<ATTRIBUTE>',
    value: 1, // opcional
    min: 0, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.decrementDocumentAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    attribute: '<ATTRIBUTE>',
    value: 1, // opcional
    min: 0, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

incrementDocumentAttribute

Incrementar atributo do documento

SDK: @owbase/web e @owbase/node

Incrementa um atributo de um documento pelo valor informado.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção.
`documentId`	`string`	sim	ID do documento.
`attribute`	`string`	sim	Chave do atributo.
`value`	`number`	não	Valor a incrementar no atributo. Precisa ser um número.
`max`	`number`	não	Valor máximo do atributo. Se o valor atual for maior que este, a chamada falha com erro.
`transactionId`	`string`	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo documents.write ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

import { Client, Databases } from '@owbase/web';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>'); // ID do projeto

const databases = new Databases(client);

const result = await databases.incrementDocumentAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    attribute: '<ATTRIBUTE>',
    value: 1, // opcional
    max: 100, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setSession(''); // sessão do usuário

const databases = new Databases(client);

const result = await databases.incrementDocumentAttribute({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    documentId: '<DOCUMENT_ID>',
    attribute: '<ATTRIBUTE>',
    value: 1, // opcional
    max: 100, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

listIndexes

Listar índices

SDK: só @owbase/node

Lista os índices da coleção.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`queries`	`string[]`	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: key, type, status, attributes, error
`total`	`boolean`	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo collections.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.listIndexes({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    queries: [], // opcional
    total: false, // opcional
});

createIndex

Criar índice

SDK: só @owbase/node

Cria um índice nos atributos listados. O índice deve incluir todos os atributos que você vai consultar num mesmo pedido. Os atributos podem ser key, fulltext e unique.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do índice.
`type`	`DatabasesIndexType`	sim	Tipo do índice. Valores: `key`, `fulltext`, `unique`, `spatial`.
`attributes`	`string[]`	sim	Lista de atributos a indexar. No máximo 100 atributos, cada um com até 32 caracteres.
`orders`	`OrderBy[]`	não	Lista das ordens do índice. No máximo 100 ordens. Valores: `asc`, `desc`.
`lengths`	`number[]`	não	Tamanho do índice. No máximo 100

Acesso: chave de API com o escopo collections.write.

import { Client, Databases, DatabasesIndexType, OrderBy } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.createIndex({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
    type: DatabasesIndexType.Key,
    attributes: ['username'],
    orders: [OrderBy.Asc], // opcional
    lengths: [], // opcional
});

getIndex

Obter índice

SDK: só @owbase/node

Obtém um índice pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do índice.

Acesso: chave de API com o escopo collections.read.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.getIndex({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
});

deleteIndex

Excluir índice

SDK: só @owbase/node

Exclui um índice.

Parâmetro	Tipo	Obrigatório	Descrição
`databaseId`	`string`	sim	ID do banco.
`collectionId`	`string`	sim	ID da coleção. Você pode criar uma coleção com a integração de servidor do serviço Database.
`key`	`string`	sim	Chave do índice.

Acesso: chave de API com o escopo collections.write.

import { Client, Databases } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const databases = new Databases(client);

const result = await databases.deleteIndex({
    databaseId: '<DATABASE_ID>',
    collectionId: '<COLLECTION_ID>',
    key: '<KEY>',
});

As descrições desta página são traduções das que vêm da especificação da API do servidor (licença BSD-3-Clause), e os exemplos vêm do gerador de SDKs (licença MIT). Os avisos completos estão no arquivo NOTICE dos pacotes @owbase/web e @owbase/node.