Improve this page

Quick-start

This guide will take you through the process of installing Xapiand and familiarize you with the concepts that will allow you to use search and storage indexes. DON’T PANIC, it will take just a few minutes.

---

Installing and Running

Using Docker

# Run from Docker with *very-very-very* verbose output:
docker run -p 8880:8880 --rm dubalu/xapiand:0.40.0 -vvvv

Using Homebrew under macOS

# Install with Homebrew:
~ $ brew install Kronuz/tap/xapiand

# Run in foreground with *very-very-very* verbose output:
~ $ xapiand -vvvv

You can also check the Installation section for more details.

High Verbosity
For testing, we recommend running with *very-very-very* verbose output, which can be specified by using -vvvv or --verbosity=4. This will log all full requests and will also turn on pretty, human, echo and comments options. See Options for more details.

---

Indexing

Let’s try and index some twitter like information. First, let’s create a twitter user, and add some tweets (the twitter index will be created automatically):

PUT /twitter/user/Kronuz
{
  "name": "German M. Bravo"
}

PUT /twitter/tweet/1
{
  "user": "Kronuz",
  "postDate": "2016-11-15T13:12:00",
  "message": "Trying out Xapiand, so far, so good... so what!"
}

PUT /twitter/tweet/2
{
  "user": "Kronuz",
  "postDate": "2016-10-15T10:31:18",
  "message": "Another tweet, will it be indexed?"
}

You can dig a little deeper in the Data Manipulation section.

---

Searching

Now, let’s see if the information that was added by GETting it:

GET /twitter/user/Kronuz

GET /twitter/tweet/1

GET /twitter/tweet/2

Let’s find all the tweets that Kronuz posted:

SEARCH /twitter/tweet/?q=user:Kronuz

You can find out more in the Data Exploration section.

Back

Next