Typesense

Typesense is an open source search engine for building delightful search experiences.

• Typo tolerant: Handles typographical errors out-of-the-box.
• Tunable ranking: It's easy to tailor your search results to perfection.
• Simple and delightful: Simple API and delightful out-of-the-box experience.
• Blazing fast: Meticulously designed and optimized for speed.

Installation

You can download the binary packages that we publish for Linux (x86-64) and Mac.

If you use Docker, you can run Typesense from our official Docker image:

docker run -p 8108:8108 -v/tmp/typesense-data:/data typesense/typesense:0.8.0 --data-dir /data --api-key=Hu52dwsas2AdxdE --listen-port 8108

Getting started

A detailed guide is available on Typesense website.

Here's a quick example showcasing how you can create a collection, index a document and search it on Typesense.

Let's create a companies collection:

curl "${TYPESENSE_HOST}/collections" \
       -X POST \
       -H "Content-Type: application/json" \
       -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
       -d '{
             "name": "companies",
             "fields": [
               {"name": "company_name", "type": "string" },
               {"name": "num_employees", "type": "int32" },
               {"name": "country", "type": "string", "facet": true }
             ],
             "token_ranking_field": "num_employees"
          }' 

Now, let's index a document:

curl "${TYPESENSE_HOST}/collections/companies/documents" \
       -X POST \
       -H "Content-Type: application/json" \
       -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
       -d '{
            "id": "124",
            "company_name": "Stark Industries",
            "num_employees": 5215,
            "country": "USA"
          }'

Finally, let's search for the document we just indexed:

curl -H "X-TYPESENSE-API-KEY: ${API_KEY}" \
     "${TYPESENSE_HOST}/collections/companies/documents/search\
     ?q=stork&query_by=company_name&filter_by=num_employees:>100\
     &sort_by=num_employees:desc"

See how the search term has a typo? Typesense handles upto 2 typo errors out-of-the-box.

Building from source

Building on your machine

Typesense requires the following dependencies:

• Snappy
• zlib
• OpenSSL (>=1.0.2)
• curl
• Compiler with good C++11 support (GCC >= 4.9.0, Apple Clang >= 8.0, Clang >= 3.9.0)

$ ./build.sh [--clean] [--depclean]

Building a Docker image

The Docker build script takes care of the required dependencies, so you don't need to install them separately:

$ TYPESENSE_IMG_VERSION=nightly ./docker-build.sh --build-deploy-image [--clean] [--depclean]

© 2016-2018 Wreally Studios Inc.