Open Source alternative to Algolia + Pinecone and an Easier-to-Use alternative to ElasticSearch ⚡ 🔍 ✨ Fast, typo tolerant, in-memory fuzzy Search Engine for building delightful search experiences
C++ algoliadatastoreelasticsearchenterprise-searchfacetingfull-text-searchfuzzy-searchgeosearchin-memoryinstantsearchmerchandisingpineconesearchsearch-enginesemantic-searchsimilarity-searchsite-searchsynonymstypo-tolerancevector-search
Added throughput benchmark
Jason Bosco92f9895b2f27
diff --git a/README.md b/README.mdindex ccea7b34..eed6e819 100644--- a/README.md+++ b/README.md@@ -16,10 +16,11 @@ Typesense is a fast, typo-tolerant search engine for building delightful search- [API Documentation](#api-documentation)- [API Clients](#api-clients)- [Search UI Components](#search-ui-components)-- [Build from Source](#build-from-source)+- [Benchmarks](#benchmarks)- [FAQ](#faq)- [Support](#support)- [Getting Latest Updates](#getting-latest-updates)+- [Build from Source](#build-from-source)## Features@@ -146,38 +147,9 @@ to quickly build powerful search experiences, complete with filtering, sorting,Here's how: [https://typesense.org/docs/0.15.0/guide/#search-ui](https://typesense.org/docs/0.15.0/guide/#search-ui)-## Build from source--**Building with Docker**--The docker build script takes care of all required dependencies, so it's the easiest way to build Typesense:--```-TYPESENSE_VERSION=nightly ./docker-build.sh --build-deploy-image --create-binary [--clean] [--depclean]-```--**Building on your machine**--Typesense requires the following dependencies:--* C++11 compatible compiler (GCC >= 4.9.0, Apple Clang >= 8.0, Clang >= 3.9.0)-* Snappy-* zlib-* OpenSSL (>=1.0.2)-* curl-* ICU-* brpc-* braft--```-./build.sh --create-binary [--clean] [--depclean]-```--The first build will take some time since other third-party libraries are pulled and built as part of the build process.-## FAQ-**How does this differ from Elasticsearch?**+### How does this differ from Elasticsearch?Elasticsearch is a large piece of software, that takes non-trivial amount of effort to setup, administer, scale and fine-tune.It offers you a few thousand configuration parameters to get to your ideal configuration. So it's better suited for large teams@@ -191,7 +163,7 @@ and smart defaults so it just works well out-of-the-box, without you having to tElasticsearch also runs on the JVM, which by itself can be quite an effort to tune to run optimally. Typesense, on the other hand,is a single light-weight self-contained native binary, so it's simple to setup and operate.-**How does this differ from Algolia?**+### How does this differ from Algolia?Algolia is a proprietary, hosted, search-as-a-service product that works well, when cost is not an issue. From our experience,fast growing sites and apps quickly run into search & indexing limits, accompanied by expensive plan upgrades as they scale.@@ -219,15 +191,22 @@ synonyms, geo spatial searches, personalization & server-based search analytics.With Typesense, we intend to bridge this gap, but in the meantime, please let us knowif any of these are a show stopper for your use case by creating a feature request in our issue tracker.-**Speed is great, but what about the memory footprint?**+### Speed is great, but what about the memory footprint?A fresh Typesense server will consume about 30 MB of memory. As you start indexing documents, the memory use willincrease correspondingly. How much it increases depends on the number and type of fields you index.We've strived to keep the in-memory data structures lean. To give you a rough idea: when 1 millionHacker News titles are indexed along with their points, Typesense consumes 165 MB of memory. The same size of that data-on disk in JSON format is 88 MB. We hope to add better benchmarks on a variety of different data sets soon.-In the mean time, if you have any numbers from your own datasets, please send us a PR!+on disk in JSON format is 88 MB. If you have any numbers from your own datasets that we can add to this section, please send us a PR!++## Benchmarks++We tested a dataset with ~3 million records (Amazon product data) that was ~13GB on disk and we were able to achieve a throughput of **250 concurrent search queries per second** on a 16GB, 8-vCPU 3-node Typesense cluster.++We'd love to benchmark with larger datasets, if we can find large ones in the public domain. If you have any suggestions for structured datasets that are open, please let us know by opening an issue.++We'd also be delighted if you're able to share benchmarks from your own large datasets. Please send us a PR!## Support@@ -248,6 +227,34 @@ If you'd like to get updates when we release new versions, click on the "Watch"We also post updates to our Twitter account about releases and additional topics related to Typesense. Follow us here: [@typesense](https://twitter.com/typesense).+## Build from source++**Building with Docker**++The docker build script takes care of all required dependencies, so it's the easiest way to build Typesense:++```+TYPESENSE_VERSION=nightly ./docker-build.sh --build-deploy-image --create-binary [--clean] [--depclean]+```++**Building on your machine**++Typesense requires the following dependencies:++* C++11 compatible compiler (GCC >= 4.9.0, Apple Clang >= 8.0, Clang >= 3.9.0)+* Snappy+* zlib+* OpenSSL (>=1.0.2)+* curl+* ICU+* brpc+* braft++```+./build.sh --create-binary [--clean] [--depclean]+```++The first build will take some time since other third-party libraries are pulled and built as part of the build process.---© 2016-2020 Typesense Inc.