Registry / database / bunyan-sql-stream

bunyan-sql-stream

JSON →
library0.0.4jsnpmunverified

A Bunyan stream that writes logs to SQL databases (PostgreSQL, MySQL, MSSQL, MariaDB, SQLite3, Oracle). Version 0.0.4 (latest) is stable but no longer updated. It wraps Knex.js for SQL queries, so tables are created manually. Unlike alternative per-database packages, this single module supports multiple dialects. Requires separate database client packages (e.g., pg, mysql).

databasedevops
npm install bunyan-sql-stream
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · BUNYAN-SQL-STREAM
B
bunyan-sql-stream
databasejavascriptv0.0.4
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.

bunyanSqlStream
✓ import bunyanSqlStream from 'bunyan-sql-stream'
✗ const bunyanSqlStream = require('bunyan-sql-stream').default
This package uses CommonJS default export. The default export is the stream factory function.
bunyanSqlStream
✓ const bunyanSqlStream = require('bunyan-sql-stream')
✗ const { bunyanSqlStream } = require('bunyan-sql-stream')
For CommonJS, simply require the package; it exports the function directly.
types
✓ import type { BunyanSqlStreamOptions } from 'bunyan-sql-stream'
✗ import { BunyanSqlStreamOptions } from 'bunyan-sql-stream' (not a value export)
The package has TypeScript declarations; options interface is available as a type export.

Creates a Bunyan logger that writes to a PostgreSQL database using bunyan-sql-stream. Requires a pre-existing 'logs' table with specific columns.

const bunyan = require('bunyan'); const bunyanSqlStream = require('bunyan-sql-stream'); const logger = bunyan.createLogger({ name: 'sql stream', level: 'info', streams: [ { stream: bunyanSqlStream({ client: 'pg', connection: { host: process.env.DB_HOST ?? 'localhost', user: process.env.DB_USER ?? 'postgres', password: process.env.DB_PASS ?? '', database: process.env.DB_NAME ?? 'logs' }, tableName: 'logs' }), type: 'raw' } ] }); logger.info({ user: 'test' }, 'User logged in');
Debug
Known issues
deprecatedThe package is no longer actively maintained; consider per-database alternatives (bunyan-postgres-stream, bunyan-mysql-stream).
fix
Switch to a dedicated stream package for your database.
affects: all
gotchaThe 'stream' option in Bunyan.createLogger must be wrapped in an object with 'stream' and 'type: raw'. Otherwise, the stream format is incorrect.
fix
Use 'streams' array with { stream: bunyanSqlStream(...), type: 'raw' }.
affects: all
gotchaThe table must exist with exact columns before using the stream. No migration is provided.
fix
Run the CREATE TABLE statement from the README manually.
affects: all
breakingKnex version compatibility: This package may not work with newer Knex versions due to internal API changes.
fix
Lock knex to version 0.x or pin bunyan-sql-stream to 0.0.4.
affects: >=0.0.4
gotchaOracle support is experimental; may require additional configuration.
fix
Test on Oracle before using in production.
affects: all
Errors
Common errors & fixes
Error: Cannot find module 'knex'
Missing knex dependency because it is a peer dependency not installed automatically.
fix
Run 'npm install knex' alongside bunyan-sql-stream.
Unhandled rejection error: relation "logs" does not exist
The destination table has not been created in the database.
fix
Execute the CREATE TABLE statement from the README before logging.
TypeError: bunyanSqlStream is not a function
Wrong import style: using default import in CommonJS without require.
fix
Use 'const bunyanSqlStream = require('bunyan-sql-stream');' (not .default).
Error: PoolConfig - write to pool without active pool configuration
Missing or invalid database connection options.
fix
Ensure client and connection fields are properly set in the options object.
Upgrade
Version history
0.0.4latest on npm
Audit
Dependencies
knexrequiredUsed internally for database queries.
Agent activity
12 hits · last 30 days
node
10
OpenAI (training)
1
Resources
githubhttps://github.com/fdesjardins/bunyan-sql-stream ↗
packagebunyan-sql-stream ↗
homepagehttps://github.com/fdesjardins/bunyan-sql-stream#readme ↗
bunyan-sql-stream — npm install bunyan-sql-stream · libregistry