Registry / database / plywood-mysql-requester

plywood-mysql-requester

library2.3.0jsnpmunverified

MySQL requester abstraction layer for Plywood (v2.3.0). Provides a function to generate a MySQL requester that accepts queries and returns Q promises resolving to data tables. Designed for Node.js, commonly used with the Plywood analytics library. Limited release cadence (minor versions). Alternative to direct mysql2 usage, tightly coupled with Plywood's Q-promise patterns. Ships TypeScript declarations.

database

npm install plywood-mysql-requester

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PLYWOOD-MYSQL-REQU

plywood-mysql-requester

databasejavascriptv2.3.0

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.

mySqlRequester

✓ import { mySqlRequester } from 'plywood-mysql-requester'

✗ const mySqlRequester = require('plywood-mysql-requester')

Named export since v2; commonJS require should use destructuring

default

✓

✗ const mySqlRequester = require('plywood-mysql-requester')

No default export; must use named import or destructured require

MySqlRequesterOptions

✓ import type { MySqlRequesterOptions } from 'plywood-mysql-requester'

Type import for TypeScript users describing generator options

Shows how to create a requester with MySQL connection config and execute a query.

import { mySqlRequester } from 'plywood-mysql-requester'; const requester = mySqlRequester({ host: 'localhost', database: 'test', user: process.env.DB_USER ?? 'root', password: process.env.DB_PASS ?? '' }); requester({ query: 'SELECT id, name FROM users LIMIT 10' }).then(rows => { console.log(rows); });

Debug

Known issues

gotchaRequester returns Q promise, not native Promise

fix

Use .then() / .done() Q patterns or convert via Q().nodeify()

affects: *

deprecatedInitialization via constructor pattern deprecated in favor of factory function

fix

Use mySqlRequester(options) instead of new MySqlRequester(options)

affects: <2.0

gotchaEnvironment variable not read automatically; must pass credentials explicitly

fix

Manually read DB_USER, DB_PASS etc.

affects: *

breakingRemoved support for callback style; only Q promises

fix

Use .then() for results

affects: >=2.0

gotchaNo built-in connection pooling; each requester creates separate connections

fix

Wrap requester creation in a connection pool manager

affects: *

Errors

Common errors & fixes

TypeError: mySqlRequester is not a function

Importing default instead of named export

fix

import { mySqlRequester } from 'plywood-mysql-requester'

Cannot find module 'plywood-mysql-requester'

Package not installed

fix

npm install plywood-mysql-requester

Unhandled promise rejection due to missing Q .done()

Using .then() without .done() from Q

fix

Append .done() to catch silent errors

ER_ACCESS_DENIED_ERROR: Access denied for user

Missing or incorrect credentials

fix

Verify host, user, password, database in options

Upgrade

Version history

2.3.0latest on npm

Audit

Dependencies

plywoodrequiredCore dependency for Plywood abstractions

Agent activity

2 hits · last 30 days

node

Resources

githubssh://git@github.com/implydata/plywood-mysql-requester ↗

packageplywood-mysql-requester ↗

homepagehttps://github.com/implydata/plywood-mysql-requester#readme ↗