SQL

Permite a configuração de um banco SQL que receberá as mensagens trafegadas.

Parâmetros

Parâmetros aceitos para esse tipo de sindicância de destino:

CampoDescriçãoValor

sql.driver

Driver do banco SQL

Tipo: enum[mysql postgres mssql] Obrigatório

sql.uri

URI de conexão com o banco SQL

Tipo: string Obrigatório

sql.table

Tabela no banco

Tipo: object Obrigatório

sql.table.schema

Nome do schema

Tipo: string Obrigatório

sql.table.name

Nome da tabela

Tipo: string Obrigatório

Caso algum campo da URI tenha caracteres especiais, será necessário deixar a URI em um formato especial. Exemplo de formatos por driver:

Requisição

curl --location '<HOST>/v1/configs' \
--header 'Content-Type: application/json' \
--header 'Authorization: <ACCESS-TOKEN>' \
--data '{
    "output": {
        "type": "SQL",
        "sql": {
          "driver": "postgres",
          "uri": "postgres://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]",
          "table": {
            "schema": "SCHEMA",
            "name": "NAME"
          }
        }
    }
}'

Resposta

A resposta desse endpoint será no seguinte formato:

{
  "id": "FIREHOSE-ID",
  "output": {
    "type": "SQL",
    "sql": {
      "driver": "postgres",
      "uri": "*",
      "table": {
        "schema": "SCHEMA",
        "name": "NAME"
      }
    }
  }
}

Limitações

A tabela com todas as colunas necessárias já deve estar criada no banco para que as mensagens sejam adicionadas. Somente campos de primeiro nível do json serão considerados colunas da tabela. Objetos ou arrays aninhados serão convertidos para string antes de serem inseridos no banco.

Last updated