sql-summary

library1.0.1jsnpmunverified

sql-summary (v1.0.1) is a lightweight JavaScript library that analyzes any SQL query and produces a concise summary string containing the main verb (SELECT, INSERT, UPDATE, etc.), the type of object operated on (TABLE, DATABASE, etc.), and the primary table or database name. It is maintained by Elastic and is ideal for logging, monitoring, and grouping similar queries without revealing sensitive details. It has minimal dependencies and is compatible with Node.js and browsers. Release cadence is low; the package is stable and receives updates for bug fixes.

database

npm install sql-summary

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SQL-SUMMARY

sql-summary

databasejavascriptv1.0.1

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.

default

✓ var sqlSummary = require('sql-summary')

✗ import sqlSummary from 'sql-summary'

This package is CommonJS only; no default ESM export exists.

sqlSummary

✓ const sqlSummary = require('sql-summary')

The module exports a single function. Use require as shown.

default (ESM via bundler)

✓ import sqlSummary from 'sql-summary'; // May work with bundlers using interop

✗ import { sqlSummary } from 'sql-summary'

Named import does not work; use default import with bundlers that support CJS interop.

Demonstrates basic usage: passing SQL queries to sqlSummary and printing the summarized output.

const sqlSummary = require('sql-summary'); const query1 = 'SELECT col1, col2 FROM table_name WHERE id=1'; console.log(sqlSummary(query1)); // => 'SELECT FROM table_name' const query2 = 'INSERT INTO users (name, age) VALUES ('Alice', 30)'; console.log(sqlSummary(query2)); // => 'INSERT INTO users' const query3 = 'UPDATE inventory SET quantity=10 WHERE product_id=5'; console.log(sqlSummary(query3)); // => 'UPDATE inventory'

Debug

Known issues

gotchaInput must be a string; otherwise, the function may throw or return unexpected results.

fix

Ensure the argument is a string: sqlSummary(String(query))

affects: >=1.0.0

gotchaThe summary may not handle all SQL dialects or complex queries (e.g., subqueries, CTEs) perfectly.

fix

Test with your specific SQL patterns; the summary is best-effort.

affects: >=1.0.0

gotchaNo TypeScript type definitions are provided; using in TypeScript may require a custom declaration.

fix

Create a .d.ts file: declare module 'sql-summary' { function sqlSummary(query: string): string; export = sqlSummary; }

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: sqlSummary is not a function

Incorrect import (e.g., using named import from an ESM environment)

fix

Use the CommonJS require: const sqlSummary = require('sql-summary');

Cannot find module 'sql-summary'

Package not installed or path issue in project

fix

Run npm install sql-summary and ensure node_modules contains it.

Upgrade

Version history

1.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

15 hits · last 30 days

node