Saltar para o conteúdo
Verificado

Consultar e escrever dados da app

Leia linhas de uma tabela do Studio e adicione uma, a partir de fora do runtime, com os mesmos dois métodos que uma app em execução chama.

dbs_read e dbs_create são as mesmas duas chamadas que um programa javascript ou api faz em runtime através de xu.dbs_read(...) e xu.dbs_create(...), acessíveis diretamente com uma chave de API de conta para que o seu próprio backend possa ler e escrever numa tabela do Studio de um projeto sem passar de todo pelo runtime. Consulte JavaScript Framework para ver o lado dentro do projeto dos mesmos métodos, e Plataforma de desenvolvimento para o resto de data_module.

Encontrar um table_id

table_id é o _id do próprio nó da tabela, nunca o seu nome de apresentação. get_progs com menu_type: "table" lista todas as tabelas de um projeto como pares {_id, properties: {menuName}}, a forma mais barata de associar um nome que consegue ler ao id de que estes dois métodos precisam.

Métodos

POST/cpi/dbs_read
user_access

DBS Read

Reads records from an app table with optional row range, single-row lookup, sorting, filtering, and archived-record selection.

POST/cpi/dbs_create
admin

DBS Create

Creates a new record in the specified app table from the provided key-value table data.

Passo a passo

Leia uma página de linhas

from/to é um intervalo de linhas (from é o deslocamento, to - from é o tamanho da página), e ambos são opcionais, omita-os e obtém a página predefinida da tabela. Todos os outros filtros (row_id, query, sortModel, archived) também são opcionais.

curl -s https://xuda.ai/cpi/dbs_read \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","app_id":"YOUR_APP_ID","table_id":"YOUR_TABLE_ID","from":0,"to":50}'
const res = await fetch('https://xuda.ai/cpi/dbs_read', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    app_id: 'YOUR_APP_ID',
    table_id: 'YOUR_TABLE_ID',
    from: 0,
    to: 50,
  }),
});
const { code, data } = await res.json();
if (code > 0) for (const row of data.rows) console.log(row.id, row.value);
import requests

res = requests.post(
    'https://xuda.ai/cpi/dbs_read',
    json={'api_key': 'YOUR_API_KEY', 'app_id': 'YOUR_APP_ID', 'table_id': 'YOUR_TABLE_ID', 'from': 0, 'to': 50},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value'])

2. Adicione uma linha

table_data é um objeto simples indexado pelos ids de campo da própria tabela, os ids de coluna que o Studio atribuiu quando a tabela foi construída, não nomes genéricos. Leia primeiro uma linha com o passo 1 se não tiver a certeza de como se chamam os campos de uma determinada tabela.

curl -s https://xuda.ai/cpi/dbs_create \
  -H 'content-type: application/json' \
  -d '{
    "api_key": "YOUR_API_KEY",
    "app_id": "YOUR_APP_ID",
    "table_id": "YOUR_TABLE_ID",
    "table_data": { "CNT_Name": "Priya Shah", "CNT_Email": "[email protected]" }
  }'
const res = await fetch('https://xuda.ai/cpi/dbs_create', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    app_id: 'YOUR_APP_ID',
    table_id: 'YOUR_TABLE_ID',
    table_data: { CNT_Name: 'Priya Shah', CNT_Email: '[email protected]' },
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data.id, data.rev);
import requests

res = requests.post(
    'https://xuda.ai/cpi/dbs_create',
    json={
        'api_key': 'YOUR_API_KEY',
        'app_id': 'YOUR_APP_ID',
        'table_id': 'YOUR_TABLE_ID',
        'table_data': {'CNT_Name': 'Priya Shah', 'CNT_Email': '[email protected]'},
    },
)
body = res.json()
if body['code'] > 0:
    print(body['data']['id'], body['data']['rev'])

A resposta

dbs_read envolve o resultado do plugin da tabela e acrescenta no topo a contagem total da própria tabela:

json
{
  "code": 1,
  "data": {
    "rows": [
      {
        "id": "dbs-392_tbl_a91f0e_7c2b9a11",
        "value": { "CNT_Name": "Priya Shah", "CNT_Email": "[email protected]" }
      }
    ],
    "total_rows": 1,
    "opt": { "...": "the query options this read actually ran, echoed back for reference" },
    "total_table_count": 42
  }
}

Cada linha é { id, value }: id é o id de documento da própria linha (o que row_id numa chamada posterior, ou dbs_update/dbs_delete, espera), value são os dados dos campos indexados da mesma forma que table_data foi enviado. total_rows conta esta página; total_table_count é a tabela inteira (apenas linhas ativas, a menos que archived: true tenha sido enviado), o número que um controlo "Página 1 de N" leria.

dbs_create responde com a escrita, não com a linha:

json
{
  "code": 1,
  "data": {
    "ok": true,
    "id": "dbs-392_tbl_a91f0e_7c2b9a11",
    "rev": "1-9f8e7d6c5b4a3f2e1d0c"
  }
}

Leia a nova linha de volta com dbs_read (row_id definido com data.id) se precisar do seu value guardado, esta chamada não o devolve. Enviar um array em table_data em vez de um objeto insere cada elemento como a sua própria linha numa só chamada, e nesse caso id/rev regressam por linha e não uma só vez.

Erros

A seguir