Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/blevesearch/bleve

A modern text/numeric/geo-spatial/vector indexing library for go
https://github.com/blevesearch/bleve

Last synced: about 1 month ago
JSON representation

A modern text/numeric/geo-spatial/vector indexing library for go

Lists

README 

        
# ![bleve](docs/bleve.png) bleve



[![Tests](https://github.com/blevesearch/bleve/workflows/Tests/badge.svg?branch=master&event=push)](https://github.com/blevesearch/bleve/actions?query=workflow%3ATests+event%3Apush+branch%3Amaster)

[![Coverage Status](https://coveralls.io/repos/github/blevesearch/bleve/badge.svg?branch=master)](https://coveralls.io/github/blevesearch/bleve?branch=master)

[![GoDoc](https://godoc.org/github.com/blevesearch/bleve?status.svg)](https://godoc.org/github.com/blevesearch/bleve)

[![Join the chat at https://gitter.im/blevesearch/bleve](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/blevesearch/bleve?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![codebeat](https://codebeat.co/badges/38a7cbc9-9cf5-41c0-a315-0746178230f4)](https://codebeat.co/projects/github-com-blevesearch-bleve)

[![Go Report Card](https://goreportcard.com/badge/blevesearch/bleve)](https://goreportcard.com/report/blevesearch/bleve)

[![Sourcegraph](https://sourcegraph.com/github.com/blevesearch/bleve/-/badge.svg)](https://sourcegraph.com/github.com/blevesearch/bleve?badge)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)



A modern text indexing library in go



## Features



* Index any go data structure (including JSON)

* Intelligent defaults backed up by powerful configuration

* Supported field types:

    * Text, Numeric, Datetime, Boolean

* Supported query types:

    * Term, Phrase, Match, Match Phrase, Prefix, Fuzzy

    * Conjunction, Disjunction, Boolean (must/should/must_not)

    * Term Range, Numeric Range, Date Range

    * [Geo Spatial](https://github.com/blevesearch/bleve/blob/master/geo/README.md)

    * Simple [query string syntax](http://www.blevesearch.com/docs/Query-String-Query/) for human entry

* [tf-idf](https://en.wikipedia.org/wiki/Tf-idf) Scoring

* Query time boosting

* Search result match highlighting with document fragments

* Aggregations/faceting support:

    * Terms Facet

    * Numeric Range Facet

    * Date Range Facet



## Indexing



```go

message := struct{

	Id   string

	From string

	Body string

}{

	Id:   "example",

	From: "[email protected]",

	Body: "bleve indexing is easy",

}



mapping := bleve.NewIndexMapping()

index, err := bleve.New("example.bleve", mapping)

if err != nil {

	panic(err)

}

index.Index(message.Id, message)

```



## Querying



```go

index, _ := bleve.Open("example.bleve")

query := bleve.NewQueryStringQuery("bleve")

searchRequest := bleve.NewSearchRequest(query)

searchResult, _ := index.Search(searchRequest)

```



## Command Line Interface



To install the CLI for the latest release of bleve, run:



```bash

$ go install github.com/blevesearch/bleve/v2/cmd/bleve@latest

```



```

$ bleve --help

Bleve is a command-line tool to interact with a bleve index.



Usage:

  bleve [command]



Available Commands:

  bulk        bulk loads from newline delimited JSON files

  check       checks the contents of the index

  count       counts the number documents in the index

  create      creates a new index

  dictionary  prints the term dictionary for the specified field in the index

  dump        dumps the contents of the index

  fields      lists the fields in this index

  help        Help about any command

  index       adds the files to the index

  mapping     prints the mapping used for this index

  query       queries the index

  registry    registry lists the bleve components compiled into this executable

  scorch      command-line tool to interact with a scorch index



Flags:

  -h, --help   help for bleve



Use "bleve [command] --help" for more information about a command.

```



## Text Analysis



Bleve includes general-purpose analyzers (customizable) as well as pre-built text analyzers for the following languages:



Arabic (ar), Bulgarian (bg), Catalan (ca), Chinese-Japanese-Korean (cjk), Kurdish (ckb), Danish (da), German (de), Greek (el), English (en), Spanish - Castilian (es), Basque (eu), Persian (fa), Finnish (fi), French (fr), Gaelic (ga), Spanish - Galician (gl), Hindi (hi), Croatian (hr), Hungarian (hu), Armenian (hy), Indonesian (id, in), Italian (it), Dutch (nl), Norwegian (no), Polish (pl), Portuguese (pt), Romanian (ro), Russian (ru), Swedish (sv), Turkish (tr)



## Text Analysis Wizard



[bleveanalysis.couchbase.com](https://bleveanalysis.couchbase.com)



## Discussion/Issues



Discuss usage/development of bleve and/or report issues here:

* [Github issues](https://github.com/blevesearch/bleve/issues)

* [Google group](https://groups.google.com/forum/#!forum/bleve)



## License



Apache License Version 2.0