FireSync
  • Documentação
  • FireSync.APP
    • Bancos de Dados
      • Criação
        • Autorização de IP's
      • Edição
    • Menus
      • Criação
      • Edição
        • Busca Avançada
        • Header
        • Vinculos
    • Dashboards
    • Conta FireSync
      • Integrações
      • Usuários
      • Permissões
  • Serviços
    • Connector
      • NodeJS Modulo
      • Criação de Conector
      • Edição / Acesso
      • API
    • DBRealTime
      • Cliente Javascript
        • Introdução
        • Versão Atual
        • Instalação / Configuração
        • Conceitos Fundamentais
          • Conexão e Autenticação
          • Referência do Banco de Dados (DatabaseReference)
          • Caminhos (path vs relativePath)
          • Snapshot de Dados (DataSnapshot)
          • Chaves Inválidas
        • Guia Rápido / Uso Básico
        • Referência da API
          • Objeto fireSyncClient
          • Classe DatabaseReference
          • Classe DataSnapshot
        • Listeners em Tempo Real (onValue, off)
        • Eventos Públicos (on, off)
        • Tratamento de Erros
        • Exemplo Completo
      • Cliente NodeJS
        • Introdução
        • Instalação
        • Conceitos Fundamentais
          • Inicialização e Configuração
          • Cabeçalho Origin (Obrigatório)
          • Conexão, Estado e Reconexão
          • Autenticação (TOKEN)
          • Referência (DatabaseReference) e Caminhos
          • Snapshot de Dados (DataSnapshot)
          • IDs de Requisição (Uso Interno)
          • Chaves Inválidas
        • Guia Rápido / Uso Básico
        • Referência da API
          • Objeto fireSyncClient
          • Classe DatabaseReference
          • Classe DataSnapshot
        • Listeners em Tempo Real (onValue, off)
        • Eventos Públicos (on, off)
        • Tratamento de Erros
  • FireSync.Tools
    • FireSync Tools
    • XmlToJson
    • QRCode
    • Date
    • PIX
      • QRPIX
      • PIX
  • API Integrações
    • Integrações
    • Entry
    • Query
Fornecido por GitBook
Nesta página
  • Instalação
  • Uso
  • API
  • Error Handling
  1. Serviços
  2. Connector

NodeJS Modulo

Instalação

npm install firesync-connector-client

Uso

const { createClient } = require('firesync-client');

const client = createClient({
  appId: 'your-app-id',
  authToken: 'your-auth-token'
});

// SELECT 
const products = await client.select('products')
  .columns('id', 'name', 'price')
  .where([{ left: 'price', operator: '>', right: 100 }])
  .orderBy('name')
  .execute();
  
// INSERT 
await client.insert('products')
  .columns('name', 'price')
  .values('New Product', 199.99)
  .execute();

// UPDATE 
await client.update('products')
  .set([{ column: 'price', value: 149.99 }])
  .where([{ left: 'id', operator: '=', right: 1 }])
  .execute();

// DELETE 
await client.delete('products')
  .where([{ left: 'id', operator: '=', right: 1 }])
  .execute();

API

createClient(config)

  • config.baseURL (required): Your Firesync API base URL

  • config.appId (required): Your application ID

  • config.authToken (required): Your authorization token

  • config.timeout (optional): Request timeout in milliseconds (default: 30000)

Query Methods

All query methods return a QueryBuilder instance that can be chained:

  • .select(table)

  • .insert(table)

  • .update(table)

  • .delete(table)

  • .truncate(table)

  • .drop(table)

Query Builder Methods

  • .columns(...columns): Specify columns to select/insert

  • .values(...values): Specify values for insert

  • .where(conditions): Add WHERE conditions (array of objects)

  • .orderBy(...fields): Add ORDER BY clauses

  • .page(num): Set page number for pagination

  • .pageSize(size): Set page size for pagination

  • .set(updates): Add SET clauses for update (array of objects)

  • .execute(): Execute the query

Error Handling

All errors thrown by the client will be instances of Error. API errors will include the status code and message from the server.

AnteriorConnectorPróximoCriação de Conector

Atualizado há 1 mês