Registry / database / remotequery-ts-mysql

remotequery-ts-mysql

library0.0.23jsnpmunverified

Remotequery-ts-mysql is a TypeScript MySQL driver designed to work with the RemoteQuery framework for executing remote SQL queries. The current stable version is 0.0.23, with frequent releases. It provides a MySQL-specific Driver implementation that supports database configuration, logging, and service entry SQL mapping, converting snake_case database columns to camelCase fields. Key differentiators include tight integration with RemoteQuery-ts-common, built-in logging (consoleLogger), and TypeScript-first design with exported types.

database

npm install remotequery-ts-mysql

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · REMOTEQUERY-TS-MYS

remotequery-ts-mysql

databasejavascriptv0.0.23

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.

MySqlDriver

✓ import { MySqlDriver } from 'remotequery-ts-mysql'

✗ import MySqlDriver from 'remotequery-ts-mysql'

Named export, not default. Must use destructuring.

consoleLogger

✓ import { consoleLogger } from 'remotequery-ts-mysql'

✗ const consoleLogger = require('remotequery-ts-mysql').consoleLogger;

Named export; CommonJS require works but ESM import is preferred.

Driver

✓ import { Driver } from 'remotequery-ts-mysql'

✗ import { Driver } from 'remotequery-ts-common'

Driver interface is re-exported from this package for convenience; importing from common also works but not idiomatic.

Context, Request, Result

✓ import { Context, Request, Result } from 'remotequery-ts-mysql'

These types are re-exported from remotequery-ts-common. Also importable from common package directly.

Creates a MySqlDriver instance with database config, sets up logging, and defines a service entry SQL query.

import { MySqlDriver, consoleLogger, Driver } from 'remotequery-ts-mysql'; function newMySqlDriver(): Driver { const mySqlDriver: MySqlDriver = new MySqlDriver({ database: 'test', host: 'localhost', user: 'foo', password: process.env.DB_PASSWORD ?? '', }); mySqlDriver.setLogger(consoleLogger); mySqlDriver.setSqlLogger(consoleLogger); mySqlDriver.setServiceEntrySql( 'select service_id, statements, tags, roles from t_services where service_id = :serviceId' ); return mySqlDriver; }

Debug

Known issues

gotchaConfiguration object for MySqlDriver must include all required fields (database, host, user, password); missing fields cause runtime errors without clear validation messages.

fix

Ensure all required config keys are provided before constructing MySqlDriver.

affects: >=0.0.0

gotchaThe setServiceEntrySql method expects a SQL query with named parameters using colon prefix (e.g., :serviceId). Incorrect parameter syntax (e.g., ? or $1) will not be substituted.

fix

Use named parameters like :paramName in SQL strings for setServiceEntrySql.

affects: >=0.0.0

breakingVersion 0.0.23 may have breaking changes from earlier versions; check changelog. The package is pre-1.0.0 so minor versions may introduce breaking changes.

fix

Pin to exact version and test upgrades.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'remotequery-ts-common'

Missing peer dependency remotequery-ts-common not installed automatically.

fix

Run: npm install remotequery-ts-common@0.0.8

TypeError: mySqlDriver.setLogger is not a function

Using wrong import for MySqlDriver (default import) or MySqlDriver instance is undefined.

fix

Ensure you use named import: import { MySqlDriver } from 'remotequery-ts-mysql'

Cannot read properties of undefined (reading 'host')

Config object passed to MySqlDriver constructor is missing required fields.

fix

Provide full config with database, host, user, password.

Upgrade

Version history

0.0.23latest on npm

Audit

Dependencies

remotequery-ts-commonrequiredRequired peer dependency for RemoteQuery core abstractions (Driver, Request, Result, Context)

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/tonibuenter/remotequery-ts-mysql ↗

packageremotequery-ts-mysql ↗

homepagehttps://github.com/tonibuenter/remote-query-ts-mysql#readme ↗