npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rsql-mongodb

v2.2.1

Published

Converting RSQL queries to MongoDB queries

Downloads

1,055

Readme

rsql-mongodb

Converting RSQL queries to MongoDB queries.

NPM Version Build Coverage

Installation

$ npm install rsql-mongodb

What is RSQL

RSQL (RESTful Service Query Language) is based on FIQL (Feed Item Query Language).
It's a query language that introduces basic and logical operators. This is perfect for RESTful APIs.

Basic operators supported

  • Equal to : ==
  • Not equal to : !=
  • Less than : =lt=
  • Less than or equal to : =le=
  • Greater than : =gt=
  • Greater than or equal to : =ge=
  • In : =in=
  • Not in : =out=

Logical operators supported

  • AND : ;
  • OR : ,

Additionals operators

  • Like (Regex) : =regex= (to match regex values)
  • Exists : =exists= (to check if property exists)
NOTE

Parenthesized expression can be used to define the precedence.

Return values

Return an Object or null.
This object can be passed to mongoDB methods find(), findOne(), ...

Examples

const rsqlMongoDB = require('rsql-mongodb');

try{

    // String comparison : you can add quotes to force string values
    rsqlMongoDB('lastName=="doe"');
    //=> { "lastName" : "doe" }
    rsqlMongoDB('lastName==janne');
    //=> { "lastName" : "janne" }

    // Boolean comparison
    rsqlMongoDB('married!=true');
    //=> { "married": { $ne: true } }

    // Number comparison
    rsqlMongoDB('childs=gt=2');
    //=> { "childs": { $gt: 2 } }

    // Date comparison
    rsqlMongoDB('birthday=ge=1959-10-21');
    //=> { "birthday": { $gte: new Date("1959-10-21T00:00:00.000Z") } }

    // In comparison
    rsqlMongoDB('childs=in=(1,2,3)');
    //=> { "childs": { $in: [1,2,3] } }

    // Out comparison
    rsqlMongoDB('childs=out=(1,2,3)');
    //=> { "childs": { $nin: [1,2,3] } }

    // Like operator
    rsqlMongoDB('lastName=regex=do*');
    //=> { "lastName": { $regex: "do*", $options: "" } }

    // Like operator with options
    rsqlMongoDB('lastName=regex=do*=si');
    //=> { "lastName": { $regex: "do*", $options: "si" } }
    rsqlMongoDB('lastName=regex="do=*"=si');
    //=> { "lastName": { $regex: "do=*", $options: "si" } }

    // Exists operator
    rsqlMongoDB('childs=exists=true');
    //=> { "childs": { $exists: true } }

    // Groups
    rsqlMongoDB('(firstName=="john";lastName=="doe"),(firstName==janne;lastName==doe)');
    //=> { $or: [ { $and: [ { "firstName" : "john" } , { "lastName" : "doe" } ] } , { $and: [ { "firstName" : "janne" } , { "lastName" : "doe" } ] } ] }

    // Using "_id"
    rsqlMongoDB('_id==650a7389a7ab39ddcfbc6832');
    //=> { "_id" : new ObjectId('650a7389a7ab39ddcfbc6832') }

    // Escape special character "(" ")" ";" and ","
    rsqlMongoDB('lastName=="janne\\(doe\\)"')
    //=> { "lastName" : "janne(doe)" }
    rsqlMongoDB('lastName=="janne\\;doe"')
    //=> { "lastName" : "janne;doe" }
}
catch(err){
    console.log(err);
}

License

MIT