Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trinly01/TrinDB
A fast persistent or in memory NoSQL databasse for any JS framework
https://github.com/trinly01/TrinDB
Last synced: 15 days ago
JSON representation
A fast persistent or in memory NoSQL databasse for any JS framework
- Host: GitHub
- URL: https://github.com/trinly01/TrinDB
- Owner: trinly01
- Created: 2020-03-14T07:11:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T09:59:11.000Z (almost 2 years ago)
- Last Synced: 2024-10-02T10:18:52.810Z (about 1 month ago)
- Language: JavaScript
- Size: 926 KB
- Stars: 19
- Watchers: 3
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-pinoy-made - GitHub
README
# Welcome to Trin.DB!
A **fast RESTful persistent or in memory NoSQL database** *`(18 KiB only!) `*
> **Join and support our Community**
> Web and Mobile Developers PH
> [ [Facebook Page](https://fb.com/webmobile.ph) | [Group](https://fb.com/groups/webmobile.ph/) ]
## Installation
```bash
npm install trin.db
```
or
```bash
yarn add trin.db
```
## Usage
```javascript
const express = require('express')
const app = express()
const port = process.env.PORT || 3000
const trinDB = require('trin.db')
app.use(express.json()) // required for RESTful APIs
app.listen(port, async () => {
app.trinDB = {
todos: await trinDB({ // Todos Service
filename: 'trinDb/todos.db', // get records from a file
inMemoryOnly: false, // Optional
restful // Optional
})
}
})
// Other Options
const restful = { // Optional
app, // express app
url: '/todos', // API end-point
hooks // Optional
}
const hooks = ({app, service}) => ({ // Hooks Example
before: {
all: [
(req, res, next) => {
console.log('before all hook')
next()
}
],
get: [],
find: [],
create: [],
patch: [],
remove: []
}
after: {
all: [
(result) => {
console.log(result)
return result
}
],
}
})
```
## await trinDB(``)
Returns a trinDB Service
| Object Prop | Type | Description | Default | Mode |
|--|--|--|--|--|
| *filename* | `` | Path to file. Required if in persistent mode | n/a | persistent |
| *inMemoryOnly* | `` | ( Optional ) If `true`, database will be in non-persistent mode | `false` | in-memory |
| *restful* | `` | ( Optional ) `{ app, url, hooks }` | n/a | persistent |
### *service.create(``)*
Returns the created ``
```javascript
/* example existing records (service.data)
{
asd: { _id: 'asd', text: 'Hello', read: true, nested: { prop: 'xander' } },
zxc: { _id: 'zxc', text: 'World', read: false, nested: { prop: 'ford' } }
}
*/
const result = service.create({
text: 'Trinmar Pogi'
})
console.log(result)
// { _id: 'qwe', text: 'Trinmar Pogi' }
console.log(service.data)
/* service.data with the newly created object
{
asd: { _id: 'asd', text: 'Hello', read: true, nested: { prop: 'xander' } },
zxc: { _id: 'zxc', text: 'World', read: false, nested: { prop: 'ford' } },
qwe: { _id: 'qwe', text: 'Trinmar Pogi' }
}
*/
```
*RESTful API*
```bash
curl --location --request POST 'http://localhost:3000/todos' \
--header 'Content-Type: application/json' \
--data-raw '{
"text": "Trinmar Pogi"
}'
```
### *service.find(``)*
Returns found data ``
```javascript
/* example existing records (service.data)
{
asd: { _id: 'asd', firstName: 'Trinmar', lastName: 'Pogi', age: 20 },
zxc: { _id: 'zxc', firstName: 'Trinly Zion', lastName: 'Boado', age: 1 },
qwe: { _id: 'qwe', firstName: 'Lovely', lastName: 'Boado', age: 18 }
}
*/
// Equality
result = service.find({
query: {
lastName: 'Pogi' // equality
},
limit: 10, // default 10
skip: 0 // default 0
})
console.log(result)
/*
{
total: 1,
limit: 10,
skip: 0,
data: {
asd: { _id: 'asd', firstName: 'Trinmar', lastName: 'Pogi', age: 20 }
}
}
*/
```
*RESTful API*
```bash
curl --location --request GET 'http://localhost:3000/todos?lastName=Pogi&$limit=10&$skip=0'
```
### Complex Query (conditional >, >==, <, <==, &&, || )
```javascript
// Map data or select specific props
result = service.find({
query (obj) {
return ob.age < 20
},
map (obj) {
return {
fullName: obj.firstName + ' '+ obj.lastName
}
}
})
console.log(result)
/*
{
total: 2,
limit: 10,
skip: 0,
data: {
zxc: { _id: 'zxc', firstName: 'Trinly Zion Boado' },
qwe: { _id: 'qwe', firstName: 'Lovely Boado' }
}
}
*/
```
### *service.search(`keywords`)*
fuzzy search finds data based on the keywords (``) and returns it sorted by `_score`
```javascript
/* example existing records (service.data)
{
asd: { _id: 'asd', firstName: 'Trinmar', lastName: 'Boado' },
zxc: { _id: 'zxc', firstName: 'Trinly Zion', lastName: 'Boado' },
qwe: { _id: 'qwe', firstName: 'Lovely', lastName: 'Boado' }
}
*/
result = service.search('ly oad')
console.log(result)
/*
{
total: 3,
data: {
qwe: { _score: 2, _id: 'qwe', firstName: 'Lovely', lastName: 'Boado', age: 18 },
zxc: { _score: 2, _id: 'zxc', firstName: 'Trinly Zion', lastName: 'Boado', age: 1 },
asd: { _score: 1, _id: 'asd', firstName: 'Trinmar', lastName: 'Pogi', age: 20 },
}
}
*/
```
*RESTful API*
```bash
curl --location --request GET 'http://localhost:3000/todos?$search=ly%20oad'
```
### *service.patch(_id, ``)*
Returns the created ``
```javascript
// { _id: 'q12m3k', firstName: 'Trinmar', lastName: 'Boado' nested: { counter: 123 } }
const result = service.patch('q12m3k', {
lastName: 'Pogi',
children: ['Trinly Zion'],
'nested.counter': 456
})
console.log(result)
// { _id: 'q12m3k', lastName: 'Pogi' children: ['Trinly Zion'], 'nested.counter': 456 }
console.log(service.data['q12m3k'])
// { _id: 'q12m3k', firstName: 'Trinmar', lastName: 'Pogi', nested: { prop: 456 }, children: ['Trinly Zion'] }
```
*RESTful API*
```bash
curl --location --request PATCH 'http://localhost:3000/todos/:_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"lastName": "Pogi",
"children": ["Trinly Zion"],
"nested.counter": 456
}'
```
### *service.remove(_id)*
Returns the removed ``
```javascript
service.remove('q12m3k')
console.log(service.data['q12m3k'])
// undefined
```
*RESTful API*
```bash
curl --location --request DELETE 'http://localhost:3000/todos/:_id'
```
### *service.removeProps(_id, ``)*
Returns the removed `` props
```javascript
// { _id: 'q12m3k', firstName: 'Trinmar', lastName: 'Pogi', nested: { prop: 456 }, children: ['Trinly Zion'] }
service.removeProps('q12m3k', {
lastName: true,
'nested.prop': true
firstName: false
})
console.log(service.data['q12m3k'])
// { _id: 'q12m3k', firstName: 'Trinmar', children: ['Trinly Zion'] }
```
*RESTful API*
```bash
curl --location --request PATCH 'http://localhost:3000/todos/:_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"$action": "removeProps"
"lastName": true,
"nested.prop": true,
"firstName": false
}'
```
### *service.inc(_id, ``)*
Increments specific props and returns the ``
```javascript
// { _id: 'q12m3k', firstName: 'Trinmar', lastName: 'Pogi', nested: { prop: 456 }, children: ['Trinly Zion'] }
service.inc('q12m3k', {
'nested.prop': 5
})
console.log(service.data['q12m3k'])
// { _id: 'q12m3k', firstName: 'Trinmar', lastName: 'Pogi', nested: { prop: 461 }, children: ['Trinly Zion'] }
```
*RESTful API*
```bash
curl --location --request PATCH 'http://localhost:3000/todos/:_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"$action": "inc"
"nested.prop": 5
}'
```
### *service.splice(_id, ``)*
removes element by index and returns the ``
```javascript
// { _id: 'q12m3k', children: ['Trinly Zion', 'Trinmar Boado'] }
service.splice('q12m3k', {
'children': 1
})
console.log(service.data['q12m3k'])
// { _id: 'q12m3k', children: ['Trinly Zion'] }
```
*RESTful API*
```bash
curl --location --request PATCH 'http://localhost:3000/todos/:_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"$action": "splice"
"children": 1
}'
```
### *service.push(_id, ``)*
adds one or more elements to the end of an array and returns the ``
```javascript
// { _id: 'q12m3k', children: ['Trinly Zion', 'Trinmar Boado'] }
service.push('q12m3k', {
'children': 'Lovely Boado'
})
console.log(service.data['q12m3k'])
// { _id: 'q12m3k', children: ['Trinly Zion', 'Trinmar Boado', 'Lovely Boado'] }
```
*RESTful API*
```bash
curl --location --request PATCH 'http://localhost:3000/todos/:_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"$action": "push"
"children": "Lovely Boado'"
}'
```
### *service.unshift(_id, ``)*
adds one or more elements to the beginning of an `array` and returns the ``
```javascript
// { _id: 'q12m3k', children: ['Trinly Zion', 'Trinmar Boado'] }
service.unshift('q12m3k', {
'children': 'Lovely Boado'
})
console.log(service.data['q12m3k'])
// { _id: 'q12m3k', children: ['Lovely Boado', 'Trinly Zion', 'Trinmar Boado'] }
```
*RESTful API*
```bash
curl --location --request PATCH 'http://localhost:3000/todos/:_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"$action": "unshift"
"children": "Lovely Boado'"
}'
```
### *service.sort(data,``)*
Sorts the data based on the `` and returns the sorted data
```javascript
/* example existing records (service.data)
{
asd: { _id: 'asd', firstName: 'Trinmar', lastName: 'Pogi', age: 20 },
zxc: { _id: 'zxc', firstName: 'Trinly Zion', lastName: 'Boado', age: 1 },
qwe: { _id: 'qwe', firstName: 'Lovely', lastName: 'Boado', age: 18 }
}
*/
// Descending (-1)
result = service.sort({
data: service.data, // (Optional) if not defined, service.data will be used
params: {
age: -1
}
})
console.log(result)
/*
{
asd: { _id: 'asd', firstName: 'Trinmar', lastName: 'Pogi', age: 20 },
qwe: { _id: 'qwe', firstName: 'Lovely', lastName: 'Boado', age: 18 },
zxc: { _id: 'zxc', firstName: 'Trinly Zion', lastName: 'Boado', age: 1 }
}
*/
```
### *service.copmact(filename, ``)*
writes the compact data to a file
| param | Type | Description | Default |
|--|--|--|--|
| *filename* | `` | (Optional) Path to file | current |
| | `` | ( Optional ) a TrinDB object | `service.data` |
```javascript
service.copmact('test.db', service.data)
```
# *Join and support our Community*
**Web and Mobile Developers PH**
[ [Facebook Page](https://fb.com/webmobile.ph) | [Group](https://fb.com/groups/webmobile.ph/) ]