Getting Started

The simplest way to get started with bleve is to use the standard go get operation:

  1. go get github.com/blevesearch/bleve/...

This will build a pure Go version of bleve and install the command-line utility.

Your first bleve program

Create a new package, edit main.go and paste:

  1. package main
  3. import (
  4.     "fmt"
  6.     "github.com/blevesearch/bleve"
  7. )
  9. func main() {
  10.     // open a new index
  11.     mapping := bleve.NewIndexMapping()
  12.     index, err := bleve.New("example.bleve", mapping)
  13.     if err != nil {
  14.         fmt.Println(err)
  15.         return
  16.     }
  18.     data := struct {
  19.         Name string
  20.     }{
  21.         Name: "text",
  22.     }
  24.     // index some data
  25.     index.Index("id", data)
  27.     // search for some text
  28.     query := bleve.NewMatchQuery("text")
  29.     search := bleve.NewSearchRequest(query)
  30.     searchResults, err := index.Search(search)
  31.     if err != nil {
  32.         fmt.Println(err)
  33.         return
  34.     }
  35.     fmt.Println(searchResults)
  36. }

This should compile, run, and return one search hit for the item added.