Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skuyjs/query-builder
https://github.com/skuyjs/query-builder
hacktoberfest mariadb mysql2 postgresql query-builder
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/skuyjs/query-builder
- Owner: skuyjs
- License: mit
- Created: 2020-04-04T00:50:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T16:37:15.000Z (about 2 years ago)
- Last Synced: 2024-11-13T21:15:09.460Z (3 months ago)
- Topics: hacktoberfest, mariadb, mysql2, postgresql, query-builder
- Language: JavaScript
- Homepage:
- Size: 298 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @skuyjs/query-builder
SQL query builder for NodeJS
## Compatibility
This query builder is compatible with following Database Management Systems.
- MySQL via [mysql](https://www.npmjs.com/package/mysql)/[mysql2](https://www.npmjs.com/package/mysql2)
- MariaDB via [mariadb](https://www.npmjs.com/package/mariadb)
- PostgreSQL via [pg](https://www.npmjs.com/package/pg)
## Installation
You can install by run this command inside your project by using terminal.
```bash
npm i @skuyjs/query-builder
```
## Usage
### Connecting to database server
Type this following lines in your `.js` file and you can run it.
```javascript
const Database = require('@skuyjs/query-builder');
const db = new Database({
dialect: 'mysql',
username: 'root',
password: 'root',
database: 'test',
});
console.log(db.getDialect());
```
It will give you `mysql` (your dialect) as output.
> As dialect you choose, it have to installed first.
>
> Example:
> - `npm install mysql` for mysql
> - `npm install mysql2` for mysql2
> - `npm install mariadb` for mariadb
> - `npm install pg` for pg
### Querying
#### Select
Getting all data (select query) can do by use following lines.
```javascript
...
db
.table('users')
.all()
.then(console.log)
.catch(console.log);
// prints all data in users table
```
Getting all data with specific column(s), see following example.
```javascript
...
db
.table('users')
.get('fullname', 'email', 'password')
.then(console.log)
.catch(console.log);
// prints all data in users table, but
// only fullname, email, and password columns
```
#### Insert
Inserting a data can do by use following lines.
```javascript
...
db
.table('users')
.insert([null, 'my fullname', '[email protected]', 'mypass123'])
.then(console.log)
.catch(console.log);
// inserting data into users table
// prints insertion result
```
Inserting a data with specific column(s) can do by use following lines.
```javascript
...
db
.table('users')
.insert({
fullname: 'my fullname',
email: '[email protected]',
password: 'mypass123'
})
.then(console.log)
.catch(console.log);
// inserting data into users table
// prints insertion result
```
#### Update
Updating all data(s) can do by use following lines.
```javascript
db
.table('users')
.update({ fullname: 'aye' })
.then(console.log)
.catch(console.log);
// updating all data in users table
// prints update result
```
Updating data(s) with specific row(s) can do by use following lines.
```javascript
db
.table('users')
.where({ id: 1 })
.update({ fullname: 'aye' })
.then(console.log)
.catch(console.log);
// updating data(s) with 1 as id in users table
// prints update result
```
#### Delete
Deleting all datas can do by use following lines.
```javascript
db
.table('users')
.del()
.then(console.log)
.catch(console.log);
// deleting all data in users table
// prints deletion result
```
Deleting data(s) with specific row(s) can do by use following lines.
```javascript
db
.table('users')
.where({ id: 1 })
.del()
.then(console.log)
.catch(console.log);
// deleting data(s) with 1 as id in users table
// prints deletion result
```