TablesDB

Bancos, tabelas, colunas, índices e linhas.

Classe TablesDB: 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 pelas colunas: 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.

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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.

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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 documents.read (também aceita rows.read) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

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

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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 (também aceita rows.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

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

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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 documents.read (também aceita rows.read) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

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

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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 (também aceita rows.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

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

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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 (também aceita rows.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

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

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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 (também aceita rows.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

const result = await tablesDB.createOperations({
    transactionId: '<TRANSACTION_ID>',
    operations: [
        {
            action: 'create',
            databaseId: '<DATABASE_ID>',
            tableId: '<TABLE_ID>',
            rowId: '<ROW_ID>',
            data: {
                name: "Walter O'Brien",
            },
        },
    ], // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createOperations({
    transactionId: '<TRANSACTION_ID>',
    operations: [
        {
            action: 'create',
            databaseId: '<DATABASE_ID>',
            tableId: '<TABLE_ID>',
            rowId: '<ROW_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.

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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.

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.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.

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

listTables

Listar tabelas

SDK: só @owbase/node

Obtém a lista de todas as tabelas 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 pelas colunas: name, enabled, rowSecurity
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 tables.read (também aceita collections.read).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

createTable

Criar tabela

SDK: só @owbase/node

Cria uma tabela. 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.
tableId	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 tabela. 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.
rowSecurity	boolean	não	Permite definir permissões em cada linha. O usuário precisa de permissão na linha ou na tabela para acessar uma linha. Saiba mais sobre permissões.
enabled	boolean	não	A tabela está ativa? Com false, os usuários não acessam a tabela, mas os SDKs de servidor com chave de API ainda podem ler e gravar nela. Nenhum dado se perde ao alternar essa opção.
columns	object[]	não	Lista com as definições das colunas a criar. Cada coluna 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 coluna), orders (lista de ASC/DESC, opcional) e lengths (lista de inteiros, opcional).

Acesso: chave de API com o escopo tables.write (também aceita collections.write).

@owbase/node

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createTable({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    name: '<NAME>',
    permissions: [Permission.read(Role.any())], // opcional
    rowSecurity: false, // opcional
    enabled: false, // opcional
    columns: [], // opcional
    indexes: [], // opcional
});

getTable

Obter tabela

SDK: só @owbase/node

Obtém uma tabela pelo ID. A resposta é um objeto JSON com os metadados da tabela.

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

Acesso: chave de API com o escopo tables.read (também aceita collections.read).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.getTable({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
});

updateTable

Atualizar tabela

SDK: só @owbase/node

Atualiza uma tabela pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
name	string	não	Nome da tabela. 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.
rowSecurity	boolean	não	Permite definir permissões em cada linha. O usuário precisa de permissão na linha ou na tabela para acessar uma linha. Saiba mais sobre permissões.
enabled	boolean	não	A tabela está ativa? Com false, os usuários não acessam a tabela, 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 tabela 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 tables.write (também aceita collections.write).

@owbase/node

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateTable({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    name: '<NAME>', // opcional
    permissions: [Permission.read(Role.any())], // opcional
    rowSecurity: false, // opcional
    enabled: false, // opcional
    purge: false, // opcional
});

deleteTable

Excluir tabela

SDK: só @owbase/node

Exclui uma tabela 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.
tableId	string	sim	ID da tabela.

Acesso: chave de API com o escopo tables.write (também aceita collections.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.deleteTable({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
});

listColumns

Listar colunas

SDK: só @owbase/node

Lista as colunas da tabela.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
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 pelas colunas: 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 tables.read (também aceita collections.read, columns.read, attributes.read).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.listColumns({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    queries: [], // opcional
    total: false, // opcional
});

createBigIntColumn

Criar coluna bigint

SDK: só @owbase/node

Cria uma coluna 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.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
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	A coluna é uma lista?

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createBigIntColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    min: 0, // opcional
    max: 1000000, // opcional
    xdefault: 0, // opcional
    array: false, // opcional
});

updateBigIntColumn

Atualizar coluna bigint

SDK: só @owbase/node

Atualiza uma coluna bigint. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
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 da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateBigIntColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 0,
    min: 0, // opcional
    max: 1000000, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createBooleanColumn

Criar coluna booleana

SDK: só @owbase/node

Cria uma coluna booleana.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createBooleanColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: false, // opcional
    array: false, // opcional
});

updateBooleanColumn

Atualizar coluna booleana

SDK: só @owbase/node

Atualiza uma coluna booleana. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateBooleanColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: false,
    newKey: '<NEW_KEY>', // opcional
});

createDatetimeColumn

Criar coluna de data e hora

SDK: só @owbase/node

Cria uma coluna de data e hora no padrão ISO 8601.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão da coluna no formato ISO 8601. Não pode ser definido quando a coluna é obrigatória.
array	boolean	não	A coluna é uma lista?

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

updateDatetimeColumn

Atualizar coluna de data e hora

SDK: só @owbase/node

Atualiza uma coluna de data e hora. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão da coluna quando nenhum for informado. Não pode ser definido quando a coluna é obrigatória.
newKey	string	não	Nova chave da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

createEmailColumn

Criar coluna de e-mail

SDK: só @owbase/node

Cria uma coluna de e-mail.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão da coluna quando nenhum for informado. Não pode ser definido quando a coluna é obrigatória.
array	boolean	não	A coluna é uma lista?

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createEmailColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '[email protected]', // opcional
    array: false, // opcional
});

updateEmailColumn

Atualizar coluna de e-mail

SDK: só @owbase/node

Atualiza uma coluna de e-mail. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão da coluna quando nenhum for informado. Não pode ser definido quando a coluna é obrigatória.
newKey	string	não	Nova chave da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateEmailColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '[email protected]',
    newKey: '<NEW_KEY>', // opcional
});

createEnumColumn

Criar coluna enum

SDK: só @owbase/node

Cria uma coluna enum. O parâmetro elements funciona como a lista dos valores aceitos nessa coluna.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createEnumColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    elements: ['active', 'inactive'],
    required: false,
    xdefault: 'active', // opcional
    array: false, // opcional
});

updateEnumColumn

Atualizar coluna enum

SDK: só @owbase/node

Atualiza uma coluna enum. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateEnumColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    elements: ['active', 'inactive'],
    required: false,
    xdefault: 'active',
    newKey: '<NEW_KEY>', // opcional
});

createFloatColumn

Criar coluna float

SDK: só @owbase/node

Cria uma coluna 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.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
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	A coluna é uma lista?

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createFloatColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    min: 0, // opcional
    max: 100, // opcional
    xdefault: 10.5, // opcional
    array: false, // opcional
});

updateFloatColumn

Atualizar coluna float

SDK: só @owbase/node

Atualiza uma coluna float. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
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 da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateFloatColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 10.5,
    min: 0, // opcional
    max: 100, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createIntegerColumn

Criar coluna de inteiro

SDK: só @owbase/node

Cria uma coluna 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.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
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	A coluna é uma lista?

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createIntegerColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    min: 0, // opcional
    max: 100, // opcional
    xdefault: 10, // opcional
    array: false, // opcional
});

updateIntegerColumn

Atualizar coluna de inteiro

SDK: só @owbase/node

Atualiza uma coluna de inteiro. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
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 da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateIntegerColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 10,
    min: 0, // opcional
    max: 100, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createIpColumn

Criar coluna de endereço IP

SDK: só @owbase/node

Cria uma coluna de endereço IP.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão. Não pode ser definido quando a coluna é obrigatória.
array	boolean	não	A coluna é uma lista?

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createIpColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '192.0.2.0', // opcional
    array: false, // opcional
});

updateIpColumn

Atualizar coluna de endereço IP

SDK: só @owbase/node

Atualiza uma coluna de IP. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão. Não pode ser definido quando a coluna é obrigatória.
newKey	string	não	Nova chave da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateIpColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: '192.0.2.0',
    newKey: '<NEW_KEY>', // opcional
});

createLineColumn

Criar coluna de linha geométrica

SDK: só @owbase/node

Cria uma coluna de linha geométrica.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço TablesDB.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	number[][]	não	Valor padrão da coluna 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 a coluna é obrigatória.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

updateLineColumn

Atualizar coluna de linha geométrica

SDK: só @owbase/node

Atualiza uma coluna de linha geométrica. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço TablesDB.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	number[][]	não	Valor padrão da coluna 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 a coluna é obrigatória.
newKey	string	não	Nova chave da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

createLongtextColumn

Criar coluna longtext

SDK: só @owbase/node

Cria uma coluna longtext.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createLongtextColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateLongtextColumn

Atualizar coluna longtext

SDK: só @owbase/node

Atualiza uma coluna longtext. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateLongtextColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    newKey: '<NEW_KEY>', // opcional
});

createMediumtextColumn

Criar coluna mediumtext

SDK: só @owbase/node

Cria uma coluna mediumtext.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createMediumtextColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateMediumtextColumn

Atualizar coluna mediumtext

SDK: só @owbase/node

Atualiza uma coluna mediumtext. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateMediumtextColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    newKey: '<NEW_KEY>', // opcional
});

createPointColumn

Criar coluna de ponto

SDK: só @owbase/node

Cria uma coluna de ponto geométrico.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createPointColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [1, 2], // opcional
});

updatePointColumn

Atualizar coluna de ponto

SDK: só @owbase/node

Atualiza uma coluna de ponto. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updatePointColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: [1, 2], // opcional
    newKey: '<NEW_KEY>', // opcional
});

createPolygonColumn

Criar coluna de polígono

SDK: só @owbase/node

Cria uma coluna de polígono geométrico.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço TablesDB.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	number[][][]	não	Valor padrão da coluna 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 a coluna é obrigatória.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

updatePolygonColumn

Atualizar coluna de polígono

SDK: só @owbase/node

Atualiza uma coluna de polígono. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço TablesDB.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	number[][][]	não	Valor padrão da coluna 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 a coluna é obrigatória.
newKey	string	não	Nova chave da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

createRelationshipColumn

Criar coluna de relação

SDK: só @owbase/node

Cria uma coluna de relação. Saiba mais sobre colunas de relação.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
relatedTableId	string	sim	ID da tabela 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 da coluna.
twoWayKey	string	não	Chave da coluna 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 tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createRelationshipColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    relatedTableId: '<RELATED_TABLE_ID>',
    type: RelationshipType.OneToOne,
    twoWay: false, // opcional
    key: '<KEY>', // opcional
    twoWayKey: '<TWO_WAY_KEY>', // opcional
    onDelete: RelationMutate.Cascade, // opcional
});

updateRelationshipColumn

Atualizar coluna de relação

SDK: só @owbase/node

Atualiza uma coluna de relação. Saiba mais sobre colunas de relação.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateRelationshipColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    onDelete: RelationMutate.Cascade, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createStringColumn

Criar coluna string

SDK: só @owbase/node

Obsoleto

Use tablesDB.createTextColumn.

Cria uma coluna string.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createStringColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    size: 1,
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateStringColumn

Atualizar coluna string

SDK: só @owbase/node

Obsoleto

Use tablesDB.updateTextColumn.

Atualiza uma coluna string. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateStringColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    size: 1, // opcional
    newKey: '<NEW_KEY>', // opcional
});

createTextColumn

Criar coluna de texto

SDK: só @owbase/node

Cria uma coluna de texto.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createTextColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateTextColumn

Atualizar coluna de texto

SDK: só @owbase/node

Atualiza uma coluna de texto. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateTextColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    newKey: '<NEW_KEY>', // opcional
});

createUrlColumn

Criar coluna de URL

SDK: só @owbase/node

Cria uma coluna de URL.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão da coluna quando nenhum for informado. Não pode ser definido quando a coluna é obrigatória.
array	boolean	não	A coluna é uma lista?

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createUrlColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'https://example.com', // opcional
    array: false, // opcional
});

updateUrlColumn

Atualizar coluna de URL

SDK: só @owbase/node

Atualiza uma coluna de URL. Mudar o valor default não altera as linhas que já existem.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.
required	boolean	sim	A coluna é obrigatória?
xdefault	string	não	Valor padrão da coluna quando nenhum for informado. Não pode ser definido quando a coluna é obrigatória.
newKey	string	não	Nova chave da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateUrlColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'https://example.com',
    newKey: '<NEW_KEY>', // opcional
});

createVarcharColumn

Criar coluna varchar

SDK: só @owbase/node

Cria uma coluna varchar.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createVarcharColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    size: 1,
    required: false,
    xdefault: 'Hello World', // opcional
    array: false, // opcional
    encrypt: false, // opcional
});

updateVarcharColumn

Atualizar coluna varchar

SDK: só @owbase/node

Atualiza uma coluna varchar. Mudar o valor default não altera as linhas que já existem.

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

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateVarcharColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    required: false,
    xdefault: 'Hello World',
    size: 1, // opcional
    newKey: '<NEW_KEY>', // opcional
});

getColumn

Obter coluna

SDK: só @owbase/node

Obtém uma coluna pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.

Acesso: chave de API com o escopo tables.read (também aceita collections.read, columns.read, attributes.read).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.getColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
});

deleteColumn

Excluir coluna

SDK: só @owbase/node

Exclui uma coluna.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
key	string	sim	Chave da coluna.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, columns.write, attributes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.deleteColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
});

listIndexes

Listar índices

SDK: só @owbase/node

Lista os índices da tabela.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela 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 pelas colunas: 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 tables.read (também aceita collections.read, indexes.read).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

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

createIndex

Criar índice

SDK: só @owbase/node

Cria um índice nas colunas listadas. O índice deve incluir todas as colunas que você vai consultar num mesmo pedido. O tipo pode ser key, fulltext ou unique.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço Database.
key	string	sim	Chave do índice.
type	TablesDBIndexType	sim	Tipo do índice. Valores: key, fulltext, unique, spatial.
columns	string[]	sim	Lista de colunas a indexar. No máximo 100 colunas, cada uma 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 tables.write (também aceita collections.write, indexes.write).

@owbase/node

import { Client, TablesDB, TablesDBIndexType, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createIndex({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
    type: TablesDBIndexType.Key,
    columns: ['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.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço Database.
key	string	sim	Chave do índice.

Acesso: chave de API com o escopo tables.read (também aceita collections.read, indexes.read).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.getIndex({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_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.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço TablesDB.
key	string	sim	Chave do índice.

Acesso: chave de API com o escopo tables.write (também aceita collections.write, indexes.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.deleteIndex({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    key: '<KEY>',
});

listRows

Listar linhas

SDK: @owbase/web e @owbase/node

Obtém a lista de todas as linhas do usuário numa tabela. Use os parâmetros de consulta para filtrar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço TablesDB.
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, tabela, versão do esquema (colunas 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 linhas, 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 rows.read (também aceita documents.read) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

const result = await tablesDB.listRows({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
    total: false, // opcional
    ttl: 0, // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.listRows({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
    total: false, // opcional
    ttl: 0, // opcional
});

createRow

Criar linha

SDK: @owbase/web e @owbase/node

Cria uma linha. Antes de usar esta rota, crie a tabela 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.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço Database. Defina as colunas antes de criar linhas.
rowId	string	sim	ID da linha. 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 da linha 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 rows.write (também aceita documents.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    data: {
        username: 'walter.obrien',
        email: '[email protected]',
        fullName: "Walter O'Brien",
        age: 30,
        isAdmin: false,
    },
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    data: {
        username: 'walter.obrien',
        email: '[email protected]',
        fullName: "Walter O'Brien",
        age: 30,
        isAdmin: false,
    },
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

createRows

Criar linhas

SDK: só @owbase/node

Cria linhas. Antes de usar esta rota, crie a tabela 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.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço Database. Defina as colunas antes de criar linhas.
rows	object[]	sim	Lista com os dados das linhas como objetos JSON.
transactionId	string	não	ID da transação em que a operação é preparada.

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

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.createRows({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rows: [
        {
            $id: 'example1',
            username: 'walter.obrien',
            email: '[email protected]',
            fullName: "Walter O'Brien",
            age: 30,
            isAdmin: false,
        },
    ],
    transactionId: '<TRANSACTION_ID>', // opcional
});

upsertRows

Criar ou atualizar linhas

SDK: só @owbase/node

Cria ou atualiza linhas. Antes de usar esta rota, crie a tabela 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.
tableId	string	sim	ID da tabela.
rows	object[]	sim	Lista com os dados das linhas como objetos JSON. Pode conter linhas parciais.
transactionId	string	não	ID da transação em que a operação é preparada.

Acesso: chave de API com o escopo rows.write (também aceita documents.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.upsertRows({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rows: [
        {
            $id: 'example1',
            username: 'walter.obrien',
            email: '[email protected]',
            fullName: "Walter O'Brien",
            age: 30,
            isAdmin: false,
        },
    ],
    transactionId: '<TRANSACTION_ID>', // opcional
});

updateRows

Atualizar linhas

SDK: só @owbase/node

Atualiza todas as linhas que atendem às consultas; sem consultas, todas as linhas são atualizadas. Você pode enviar só os campos a atualizar.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
data	object	não	Dados da linha como objeto JSON. Inclua só os pares de coluna 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 rows.write (também aceita documents.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateRows({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    data: {
        username: 'walter.obrien',
        email: '[email protected]',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

deleteRows

Excluir linhas

SDK: só @owbase/node

Exclui linhas em massa por consultas; sem consultas, todas as linhas são excluídas.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela 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 rows.write (também aceita documents.write).

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.deleteRows({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    queries: ['{"method":"equal", "attribute":"$id", "values":["<ROW_ID>"]}'], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

getRow

Obter linha

SDK: @owbase/web e @owbase/node

Obtém uma linha pelo ID. A resposta é um objeto JSON com os dados da linha.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela. Você pode criar uma tabela com a integração de servidor do serviço Database.
rowId	string	sim	ID da linha.
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 rows.read (também aceita documents.read) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

const result = await tablesDB.getRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.getRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    queries: [], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

upsertRow

Criar ou atualizar linha

SDK: @owbase/web e @owbase/node

Cria ou atualiza uma linha. Antes de usar esta rota, crie a tabela 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.
tableId	string	sim	ID da tabela.
rowId	string	sim	ID da linha.
data	object	não	Dados da linha como objeto JSON. Inclua todas as colunas obrigatórias da linha 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 rows.write (também aceita documents.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.upsertRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    data: {
        username: 'walter.obrien',
        email: '[email protected]',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.upsertRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    data: {
        username: 'walter.obrien',
        email: '[email protected]',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

updateRow

Atualizar linha

SDK: @owbase/web e @owbase/node

Atualiza uma linha 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.
tableId	string	sim	ID da tabela.
rowId	string	sim	ID da linha.
data	object	não	Dados da linha como objeto JSON. Inclua só os pares de coluna 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 rows.write (também aceita documents.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    data: {
        username: 'walter.obrien',
        email: '[email protected]',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB, 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 tablesDB = new TablesDB(client);

const result = await tablesDB.updateRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    data: {
        username: 'walter.obrien',
        email: '[email protected]',
        fullName: "Walter O'Brien",
        age: 33,
        isAdmin: false,
    }, // opcional
    permissions: [Permission.read(Role.any())], // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

deleteRow

Excluir linha

SDK: @owbase/web e @owbase/node

Exclui uma linha pelo ID.

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

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

@owbase/web

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

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

const tablesDB = new TablesDB(client);

const result = await tablesDB.deleteRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.deleteRow({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    transactionId: '<TRANSACTION_ID>', // opcional
});

decrementRowColumn

Decrementar coluna da linha

SDK: @owbase/web e @owbase/node

Decrementa uma coluna de uma linha pelo valor informado.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
rowId	string	sim	ID da linha.
column	string	sim	Chave da coluna.
value	number	não	Valor a decrementar na coluna. Precisa ser um número.
min	number	não	Valor mínimo da coluna. 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 rows.write (também aceita documents.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

const result = await tablesDB.decrementRowColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    column: '<COLUMN>',
    value: 1, // opcional
    min: 0, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.decrementRowColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    column: '<COLUMN>',
    value: 1, // opcional
    min: 0, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

incrementRowColumn

Incrementar coluna da linha

SDK: @owbase/web e @owbase/node

Incrementa uma coluna de uma linha pelo valor informado.

Parâmetro	Tipo	Obrigatório	Descrição
databaseId	string	sim	ID do banco.
tableId	string	sim	ID da tabela.
rowId	string	sim	ID da linha.
column	string	sim	Chave da coluna.
value	number	não	Valor a incrementar na coluna. Precisa ser um número.
max	number	não	Valor máximo da coluna. 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 rows.write (também aceita documents.write) ou sessão do usuário, ou mesmo sem sessão (vale o que as permissões do recurso deixam).

@owbase/web

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

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

const tablesDB = new TablesDB(client);

const result = await tablesDB.incrementRowColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    column: '<COLUMN>',
    value: 1, // opcional
    max: 100, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

console.log(result);

@owbase/node

import { Client, TablesDB } 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 tablesDB = new TablesDB(client);

const result = await tablesDB.incrementRowColumn({
    databaseId: '<DATABASE_ID>',
    tableId: '<TABLE_ID>',
    rowId: '<ROW_ID>',
    column: '<COLUMN>',
    value: 1, // opcional
    max: 100, // opcional
    transactionId: '<TRANSACTION_ID>', // opcional
});

---

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.