https://github.com/gwendall/meteor-mongo-algolia-sync
Automatically sync a Mongo collection to an Algolia index
https://github.com/gwendall/meteor-mongo-algolia-sync
Last synced: about 2 months ago
JSON representation
Automatically sync a Mongo collection to an Algolia index
- Host: GitHub
- URL: https://github.com/gwendall/meteor-mongo-algolia-sync
- Owner: gwendall
- Created: 2015-10-14T15:48:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-07T14:18:04.000Z (almost 8 years ago)
- Last Synced: 2025-04-04T22:46:59.315Z (about 2 months ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 7
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```diff
- NOTE: This package is not maintained anymore.
- If you want to help, please reach out to [email protected]
```
Meteor Mongo Algolia Sync
=========================
Automatically sync a Mongo collection to an Algolia index.
Installation
------------
``` sh
meteor add gwendall:mongo-algolia-sync
```
Methods
-------
**MongoCollection.syncAlgolia(AlgoliaIndex, options)**
Keeps track of all documents inserted / updated / removed within a Mongo collection, and performs the equivalent operations to an Algolia index.
```javascript
// Server-only
AlgoliaClient = AlgoliaSearch(ALGOLIA_APP_ID, ALGOLIA_SECRET_KEY);
AlgoliaIndex = AlgoliaClient.initIndex('posts');
MongoCollection = new Mongo.Collection('posts');
MongoCollection.syncAlgolia(AlgoliaIndex, {
debug: true,
transform: function(doc) {
delete doc.secret;
return doc;
}
});
```
Options:
- debug (boolean): Console logs operations or not (```false``` by default).
- transform (function): Allows to transform the documents that will be saved to Algolia (return ```false``` to prevent syncing a given document).
**MongoCollection.initAlgolia(AlgoliaIndex, options)**
Performs the initial sync of all the documents in the given Mongo collection to the given Algolia index.
```javascript
// Server-only
MongoCollection.initAlgolia(AlgoliaIndex, {
clearIndex: true
});
```
Options (same as above + the following):
- clearIndex: Empty the Algolia index on start (```false``` by default).
- mongoSelector: Mongo selector for the cursor that will be synced to Algolia (```{}``` by default).
- mongoOptions: Mongo options for the cursor that will be synced to Algolia (```{}``` by default).
Notes
-----
- The Algolia indexes can be created with the [acemtp:algolia](http://github.com/acemtp/meteor-algolia) package.
- The Algolia ```objectID``` used will be the ```_id``` of the Mongo documents.