typesense-mongodb

A Node.js CLI to sync documents from a MongoDB collection to Typesense.

Showing:

Popularity

Downloads/wk

4

GitHub Stars

7

Maintenance

Last Commit

1mo ago

Contributors

2

Package

Dependencies

17

License

Apache-2.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Typesense MongoDB Integration

CircleCI

A CLI to sync documents from a MongoDB collection to Typesense.

Installation

npm install -g typesense-mongodb

Usage

Prerequisites

  • Make sure you are running MongoDB instance in a replica set. Or convert your standalone MongoDB instance to MongoDB replica set.
  • We highly recommend that you stop writes to your MongoDB collection until you get a message from the process.
  • If you are familiar with Typesense, it has an option to mark certain fields as facets. If you would like to use this feature, create your own Typesense collection and pass the collection name as an argument.

Example

typesense-mongodb \
    --mongo-collection=collection \
    --mongo-database=database \
    --typesense-collection=collection \
    --mongo-url=mongodb://localhost:27017 \
    --typesense-url=http://localhost:8108 \
    --typesense-api-key=xyz

Arguments

ParameterDefaultDescription
--mongo-databasedatabaseMongoDB database name
--mongo-collectioncollectionMongoDB collection name
--mongo-urlmongodb://localhost:27017MongoDB instance URI along with username and passsword
--typesense-collectioncollectionTypesense collection name
--typesense-urlhttp://localhost:8108Typesense endpoint URL
--typesense-api-keyxyzTypesense API key

Support

Please open a Github issue or join our Slack Community

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100