Giter Club home page Giter Club logo

sqlite-x's Introduction

sqlite-x

A tiny wrapper around the sqlite3 package that makes life a lot easier, featuring:

  • Promise-based API
  • Simple and easy to use interface with tagged template literals
  • Automatic parameterizing to prevent SQL injections

If there's something this package can't support, you can access the original node-sqlite3 object via sqlitexInstance#db.

Getting started

Install the package:

npm i sqlite-x

Then require it in your module:

const Sqlitex = require("sqlite-x");

Usage

This is an extension of sqlite3, so this package should replicate its behavior. You can access the internal database directly with Sqlitex#db.

Use with async/await and tagged templates.

Basic usage

const db = new Sqlitex("./data.db");
await db.run`CREATE TABLE IF NOT EXISTS tbl (
  user varchar(255),
  pass int
)`;

const user = "john", password = 1234;
await db.run`INSERT INTO tbl (user,pass) VALUES (${user},${password})`; // sqlitex auto-parameterizes your template inputs, so no need to worry about SQL injection

const { pass } = await db.get`SELECT pass FROM tbl WHERE user = ${user}`;
console.assert(pass === 1234);

Query multiple

const paidUsers = await db.all`SELECT * FROM tbl WHERE paid = 1`;
console.log(
  `${paidUsers.length} users have paid for this service:\n\n`,
  paidUsers.map(i => i.user).join("\n")
);

Testing

Jest tests are written for this package. Run them with npm test.

sqlite-x's People

Contributors

codingjlu avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.