Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moleculerjs/moleculer-db-adapter-macrometa
MacroMeta adapter for Moleculer DB service.
https://github.com/moleculerjs/moleculer-db-adapter-macrometa
data-access-layer macrometa moleculer
Last synced: 4 days ago
JSON representation
MacroMeta adapter for Moleculer DB service.
- Host: GitHub
- URL: https://github.com/moleculerjs/moleculer-db-adapter-macrometa
- Owner: moleculerjs
- License: mit
- Created: 2019-10-17T20:11:15.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-06T18:24:47.000Z (almost 2 years ago)
- Last Synced: 2024-05-23T10:01:12.657Z (6 months ago)
- Topics: data-access-layer, macrometa, moleculer
- Language: JavaScript
- Homepage: https://www.macrometa.co/
- Size: 154 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-moleculer - moleculer-db-adapter-macrometa - [MacroMeta](https://www.macrometa.com/) adapter for Moleculer DB service. (Services / Databases and Stores)
README
[](https://travis-ci.org/moleculerjs/moleculer-db-adapter-macrometa)
[](https://coveralls.io/github/moleculerjs/moleculer-db-adapter-macrometa?branch=master)
[](https://snyk.io/test/github/moleculerjs/moleculer-db-adapter-macrometa)
# moleculer-db-adapter-macrometa [](https://www.npmjs.com/package/moleculer-db-adapter-macrometa)
[MacroMeta](https://www.macrometa.co/) adapter for Moleculer DB service.
## Features
- auto creating collection
- raw C8QL queries
- save & execute named queries
- subscription to collection changes
## Install
```
npm install moleculer-db-adapter-macrometa --save
```
## Usage
```js
"use strict";
const { ServiceBroker } = require("moleculer");
const DbService = require("moleculer-db");
const MacroMetaAdapter = require("moleculer-db-adapter-macrometa");
const broker = new ServiceBroker();
// Create a service for `post` Macrometa collection
broker.createService({
name: "posts",
mixins: [DbService],
adapter: new MacroMetaAdapter({
config: "https://gdn1.macrometa.io",
auth: {
email: "[email protected]",
password: "secretpass"
},
tenant: null, // use default
fabric: null // use default
}),
collection: "posts" // Name of collection
});
broker.start()
// Create a new post
.then(() => broker.call("posts.create", {
title: "My first post",
content: "Lorem ipsum...",
votes: 0
}))
// Get all posts
.then(() => broker.call("posts.find").then(console.log));
```
### Raw queries
```js
// posts.service.js
module.exports = {
name: "posts",
mixins: [DbService],
adapter: new MacroMetaAdapter(),
actions: {
getMaxVotes() {
return this.adapter.rawQuery(`
FOR post IN posts
FILTER post.status == true && post.votes > @minVotes
SORT post.createdAt DESC
LIMIT 3
RETURN post._id
`, { minVotes: 2 }, {});
}
}
}
```
>More info about C8QL: https://dev.macrometa.io/docs/introduction-1
>You have direct access for the `this.collection` & `this.fabric` instances inside the services.
### Subscribe to changes
```js
// posts.service.js
module.exports = {
name: "posts",
mixins: [DbService],
adapter: new MacroMetaAdapter(),
methods: {
onChanges(payload) {
this.logger.info("Collection has been changed", payload);
}
},
async started() {
await this.adapter.subscribeToChanges((err msg) => {
if (err)
return this.logger.error("Subscription error", err);
this.onChanges(msg.payload);
});
},
async stopped() {
await this.adapter.unsubscribeFromChanges();
}
}
```
### Named queries
```js
await this.adapter.saveQuery(name, query, parameters);
await this.adapter.executeSavedQuery(name,variables);
```
## Test
```
$ npm test
```
In development with watching
```
$ npm run ci
```
## Contribution
Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.
## License
The project is available under the [MIT license](https://tldrlegal.com/license/mit-license).
## Contact
Copyright (c) 2019 MoleculerJS
[](https://github.com/moleculerjs) [](https://twitter.com/MoleculerJS)