Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tur-ph/quick.mongo
This is a mongo db database connector with easy and simple functions.
https://github.com/tur-ph/quick.mongo
database mongodb mongodb-atlas mongoosejs quick-db
Last synced: about 1 month ago
JSON representation
This is a mongo db database connector with easy and simple functions.
- Host: GitHub
- URL: https://github.com/tur-ph/quick.mongo
- Owner: Caallum
- Created: 2021-05-10T19:58:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-06-13T17:27:37.000Z (over 3 years ago)
- Last Synced: 2024-10-07T20:59:47.342Z (about 1 month ago)
- Topics: database, mongodb, mongodb-atlas, mongoosejs, quick-db
- Language: JavaScript
- Homepage:
- Size: 62.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# quick.mongo
> Simple Database using MongoDB
> The name is a copy of `quick.db`, this uses the Mongo Atlas Database to store data though
## Documentation
### new Database()
```js
new database(mongo url, options)
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
Mongo URL | [URL](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_is_a_URL) | ✖ | The URL given to you by the MongoDB Atlas Connection
options | [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) | null | null
options.name | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ✖ | The name of the collection you want to create
#### Example
```js
const quickMongo = require('@turph/quickmongo');
const database = new quickMongo('{ INSERT MONGO URL HERE }', { name: 'database' });
db
.on('error', err => console.log(err))
.on('connected', info => console.log(info));
```
Constructor
### database.set()
```js
database.set(key, value)
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
Key | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ✖ | The key of the value
Value | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) / [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) | ✖ | The value of the key you wish to set
#### Example
```js
await database.set('foo', 'fee');
```
Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>
### database.get()
```js
await database.get(key)
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
key | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ✖ | The key of that vakue you wish to find
#### Example
```js
await database.get('foo'); // fee
```
Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>
### database.search()
```js
database.search(query)
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
query | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ✖ | The term you wish to search for
#### Example
```js
await database.search('foo');
```
Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
### database.find()
```js
database.find(query)
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
query | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ✖ | The term you wish to search for
#### Example
```js
await database.find('foo');
```
Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
### database.all()
```js
database.all()
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
| | | |
#### Example
```js
await database.all()
```
Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
### database.delete()
```js
database.delete(key)
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
Key | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ✖ | The key of the value you wish to delete
#### Example
```js
await database.delete('foo');
```
Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>
### database.clear()
```js
database.clear(key)
```
Parameter | Type | Optional | Description
--- | --- | --- | ---
Key | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ✖ | The key of the value you wish to clear from your database. Note: this will delete ALL matches so perform at your own risk
#### Example
```js
await database.clear('foo');
```
Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>