Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mati365 authored Oct 15, 2023
1 parent bce3c09 commit c9c2633
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,23 @@

Tired of writing elasticsearch reindexing scripts? Are you constantly encountering data synchronization problems between the database and elasticsearch? Are you crying about the lack of namespaces in the organization of indexes in your cluster? Nothing lost! Here is **searchpunch** and punch this shit out!

**What does it offer (aside from the cool name)?**
## What does it offer (aside from the cool name)?

1. not much functionality but doing its job well
2. 0-downtime reindexing and safe index surges
3. easy data synchronization between any data source (for example, MariaDB, PostgreSQL and any other database)
4. automatic detection of index changes and performing reindexes
1. 0-downtime reindexing
2. automatic removing unused indices based on IaC namespace definition ♻
3. synchronization of data between any database using async generators
4. automatic detection of index settings / mappings modification and reindex modified inndices
5. bulk reindex of records
6. support of namespaces in index naming allowing to separate indexes into a cluster
7. automatic cleaning of unused indexes in the cluster
8. fully typed error handling using monadic functional approach
6. group indices into namespaces
8. fully typed error handling using Either error handling

## Installation
## Installation 🚀

```bash
yarn add @searchpunch/reindex
```

## How index synchronization works?
## How index synchronization works? 🛠️

1. Load current mapping schema into memory
2. Check if specified index exists in ElasticSearch
Expand All @@ -37,7 +36,7 @@ yarn add @searchpunch/reindex
1. If equal skip reindex
2. If differs perform full reindex

## Where it can be used?
## Where it can be used? 🏗️

1. Building ecommerce shops with aggregated products
2. Searching logs in dashboard
Expand Down

0 comments on commit c9c2633

Please sign in to comment.