Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@sqltools/formatter
Advanced tools
Package description
The @sqltools/formatter package is a library for formatting SQL queries. It provides a way to beautify SQL code, making it more readable and maintainable. It supports various SQL dialects and allows customization of the formatting options.
SQL Formatting
This feature allows you to format SQL queries. The code sample demonstrates how to format a simple SQL SELECT query using the package.
const { format } = require('@sqltools/formatter');
const query = 'SELECT * FROM table WHERE id = 1';
const formattedQuery = format(query, { language: 'sql' });
console.log(formattedQuery);
Customizing Formatting Options
This feature allows you to customize the formatting options such as indentation, case, and line breaks. The code sample shows how to format a query with custom options for indentation and uppercase keywords.
const { format } = require('@sqltools/formatter');
const options = {
language: 'sql',
indent: ' ',
uppercase: true
};
const query = 'select * from table where id = 1';
const formattedQuery = format(query, options);
console.log(formattedQuery);
sql-formatter is a popular SQL formatting library that supports multiple dialects. It is similar to @sqltools/formatter but has a different API and might have different formatting options or defaults.
pg-formatter is a PostgreSQL SQL formatter. It is more specialized than @sqltools/formatter as it focuses on PostgreSQL dialect, whereas @sqltools/formatter supports multiple dialects.
Readme
Forked from zeroturnaround/sql-formatter but with improvements and ported Typescript.
This package is part of vscode-sqltools extension.
→ Try it online using our playground.
Get the latest version from NPM/Yarn:
npm install @sqltools/formatter
#
yarn add @sqltools/formatter
import sqlFormatter from '@sqltools/formatter';
console.log(sqlFormatter.format('SELECT * FROM table1'));
Will output:
SELECT *
FROM table1
You can also pass in configuration options:
sqlFormatter.format('SELECT *', {
language: 'sql',
indent: '\t', // Defaults to two spaces
});
option | description | type | default |
---|---|---|---|
language | Query language, default is Standard SQL | sql, n1ql, db2, pl/sql | sql |
indent | Characters used for indentation | string | (2 spaces) |
reservedWordCase | How to change the case of reserved words | upper , lower , null | null (no change) |
linesBetweenQueries | How many line breaks between queries | number or 'preserve' | 1 |
params | Collection of params for placeholder replacement | object for name params, array for indexed placeholders |
FAQs
Formats SQL queries. Part of SQLTools
The npm package @sqltools/formatter receives a total of 1,225,902 weekly downloads. As such, @sqltools/formatter popularity was classified as popular.
We found that @sqltools/formatter demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.