sql-in-mongodb
v1.0.0
Published
parse SQL to MongoDB query
Downloads
7
Maintainers
Readme
SQL-in-MongoDB
This tools can convert common sql query to mongodb query. Support node version >= 12
:star: Why we need this tool
If we have a complex query condition, use mongodb query we should write complex json object, and sometime we often missing the brackets, but use this tools, we just need write an simple sql query, and it can convert it to mongodb query.
:rocket: How to use
1. install dependency
npm install sql-in-mongodb
or
yarn add sql-in-mongodb
2. Code example
import SQLParser from 'sql-in-mongodb'; // for commonjs: const SQLParser = require('sql-in-mongodb');
// database data: {a: 1, b: 2}
const sqlQuery = `where a = 1`; // you also can use: `select * from tablename where a = 1`
const parser = new SQLParser();
const data = await TestModel.find(parser.parseSql(sqlQuery));
console.log(JSON.stringify(data)); // output [{a: 1, b: 2}]
If you want select some fields
import SQLParser from 'sql-in-mongodb';
// database data: {a: 1, b: 2, c: 3, d: 4}
const sqlQuery = `select a,b from test where a = 1`;
const parser = new SQLParser();
const mongoQuery = parser.parseSql(sqlQuery);
const selectedFileds = parser.getSelectedFeilds(sqlQuery);
const data = await TestModel.findOne(mongoQuery, selectedFileds);
console.log(JSON.stringify(data)); // output {a: 1, b: 2}
:question: SQLParser() Option parameters
export type Option = {
likeOpsCaseSensitive?: boolean, // if true, the like operator will be case sensitive
multipleLineSql?: boolean, // if true, the sql will be splited by `;` and parsed mongodb query will be an array
database?: Database, // Todo: support each database advanced query statement. only suppport common sql query now
}
// the default value
const DEFAULT_OPTIONS: Option = {
likeOpsCaseSensitive: false,
multipleLineSql: false,
database: 'mysql',
}
:eyes: Todo
- Support cli
- Support each database advanced query statement, only suppport common sql query now