Skip to content

Commit

Permalink
added more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dvirsky committed Dec 28, 2016
1 parent 04c2285 commit 986842a
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 12 deletions.
62 changes: 62 additions & 0 deletions docs/Quick_Start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@

# Quick Start Guide for RediSearch:

## Building and running:

```sh
git clone https://github.com/RedisLabsModules/RediSearch.git
cd RediSearch/src
make all

# Assuming you have a redis build from the unstable branch:
/path/to/redis-server --loadmodule ./module.so
```

## Creating an index with fields and weights:

```
127.0.0.1:6379> FT.CREATE myIdx title TEXT 5.0 body TEXT 1.0 url 1.0
OK
```

## Adding documents to the index:
```
127.0.0.1:6379> FT.ADD myIdx doc1 1.0 fields title "hello world" body "lorem ipsum" url "http://redis.io"
OK
```

## Searching the index:

```
127.0.0.1:6379> FT.SEARCH myIdx "hello world" LIMIT 0 10
1) (integer) 1
2) "doc1"
3) 1) "title"
2) "hello world"
3) "body"
4) "lorem ipsum"
5) "url"
6) "http://redis.io"
```

> **NOTE**: Input is expected to be valid utf-8 or ascii. The engine cannot handle wide character unicode at the moment.

## Dropping the index:

```
127.0.0.1:6379> FT.DROP myIdx
OK
```

## Adding and getting Auto-complete suggestions:

```
127.0.0.1:6379> FT.SUGADD autocomplete "hello world" 100
OK
127.0.0.1:6379> FT.SUGGET autocomplete "he"
1) "hello world"
```
33 changes: 33 additions & 0 deletions docs/Stemming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Stemming Support

RediSearch supports stemming - that is adding the base form of a word to the index. This allows
the query for "going" to also return results for "go" and "gone", for example.

The current stemming support is based on the Snowball stemmer library, which supports most European
languages, as well as Arabic and other. We hope to include more languages soon (if you need a specicif
langauge support, please open an issue).

For further details see the [Snowball Stemmer website](http://snowballstem.org/).

## Supported languages:

The following languages are supported, and can be passed to the engine
when indexing or querying, with lowercase letters:

* arabic
* danish
* dutch
* english
* finnish
* french
* german
* hungarian
* italian
* norwegian
* portuguese
* romanian
* russian
* spanish
* swedish
* tamil
* turkish
38 changes: 26 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,31 @@
# Welcome to MkDocs
# Welcome to RediSearch

For full documentation visit [mkdocs.org](http://mkdocs.org).
RediSearch is a Full-Text search over Redis, developed by RedisLabs

## Commands
## Overview

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs help` - Print this help message.
Redisearch impements a search engine on top of redis, but unlike other redis
search libraries, it does not use internal data structures like sorted sets.

## Project layout
Inverted indexes are stored on top of Redis strings using binary encoding,
and not mapped to existing data structures (see [DESIGN.md](DESIGN.md)).

This allows much faster performance, significantly less memory consumption, and
more advanced features like exact phrase matching, that are not possible with
traditional redis search approaches.

## Primary Features:

* Full-Text indexing of multiple fields in documents.
* Incremental indexing without performance loss.
* Document ranking (provided manually by the user at index time).
* Field weights.
* Auto-complete suggestions (with fuzzy prefix suggestions)
* Exact Phrase Search of up to 8 words.
* Stemming based query expansion in [many languages](#stemming-support) (using [Snowball](http://snowballstem.org/)).
* Limiting searches to specific document fields (up to 8 fields supported).
* Numeric filters and ranges.
* Supports any utf-8 encoded text.
* Retrieve full document content or just ids
* Automatically index existing HASH keys as documents.

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,8 @@ site_name: RediSearch Documentation
theme: material


pages:
- 'Overview': 'index.md'
- 'Quick Start': 'Quick_Start.md'
- 'Commands': 'Commands.md'
- 'Stemming Support': Stemming.md

0 comments on commit 986842a

Please sign in to comment.