Registry / database / repzo-sql-connector

repzo-sql-connector

library1.1.38jsnpmunverified

Repzo SQL Connector (v1.1.38) enables seamless data synchronization between Repzo CRM and SQL databases, supporting reporting and analytics with platforms like Microsoft Power BI. It provides a TypeScript SDK with connection management, schema mapping, and data export utilities. Actively maintained with frequent releases, it is designed for ETL workflows. Ship with TypeScript types and ESM/CJS support.

database crm

npm install repzo-sql-connector

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · REPZO-SQL-CONNECTO

repzo-sql-connector

databasejavascriptv1.1.38

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SqlConnector

✓ import { SqlConnector } from 'repzo-sql-connector'

✗ const SqlConnector = require('repzo-sql-connector').SqlConnector

ESM default; CommonJS users must use destructured require.

Config

✓ import type { Config } from 'repzo-sql-connector'

✗ import { Config } from 'repzo-sql-connector'

Config is a TypeScript type, export named as type. Use import type for clarity.

connect

✓ import { connect } from 'repzo-sql-connector'

✗ import { Connection } from 'repzo-sql-connector'

The function is named connect, not Connection. Connection is a class used internally.

Client

✓ import { Client } from 'repzo-sql-connector'

✗ const Client = require('repzo-sql-connector').default

Client is a named export. There is no default export.

Initializes a MySQL connection, connects, and triggers full data sync.

import { SqlConnector } from 'repzo-sql-connector'; const connector = new SqlConnector({ host: process.env.DB_HOST ?? 'localhost', port: parseInt(process.env.DB_PORT ?? '3306'), database: process.env.DB_NAME ?? 'repzo', user: process.env.DB_USER ?? 'root', password: process.env.DB_PASSWORD ?? '', dialect: 'mysql', }); connector.connect() .then(() => connector.syncAll()) .then(() => console.log('Sync complete')) .catch(console.error);

Debug

Known issues

breakingv1.0.0 changed configuration parameter order; existing code using positional arguments will break.

fix

Update to object-based config: new SqlConnector({ host, port, ... }).

affects: <1.0.0

deprecatedThe syncAll method is deprecated in v1.1.0 in favor of syncTables().

fix

Use connector.syncTables(['table1', 'table2']).

affects: >=1.1.0

gotchaWhen using MSSQL (tedious), the package requires tedious v15+ and Node.js 16+. Older Node.js versions will cause runtime errors.

fix

Update Node.js to v16+ and install tedious@15.

affects: >=1.1.0

breakingIn v1.2.0, the export method previously returning a Promise was changed to return readable streams for large datasets.

fix

Consume the returned stream via pipeline() or response.pipe().

affects: >=1.2.0

deprecatedThe default export (SqlConnector default) was removed in v1.0.0; only named exports are available.

fix

Use import { SqlConnector } from 'repzo-sql-connector' instead.

affects: >=1.0.0

gotchaThe package does not support SQLite or PostgreSQL; only MySQL and MSSQL are supported.

fix

Use other connectors for PostgreSQL or SQLite.

affects: all

Errors

Common errors & fixes

Error: Cannot find module 'repzo-sql-connector'

Package not installed or wrong import path.

fix

Run npm install repzo-sql-connector and ensure import uses correct case.

TypeError: connector.syncAll is not a function

syncAll was removed in v1.1.0.

fix

Use connector.syncTables() instead.

Error: connect ECONNREFUSED 127.0.0.1:3306

MySQL server not running or wrong host/port.

fix

Start MySQL server or update configuration in connector constructor.

Error: ConnectionError: Login failed for user '...'

Invalid credentials for MSSQL.

fix

Check user and password in the connector config.

TypeError: (destructured parameter) is not iterable

Using array-based parameters before v1.0.0.

fix

Update to object-based config (see breaking change warning).

Upgrade

Version history

1.1.38latest on npm

Audit

Dependencies

mysql2requiredMySQL database driver for SQL connections

tediousoptionalMSSQL database driver for SQL Server connections

Agent activity

32 hits · last 30 days

node