https://github.com/stackrox/bleve

https://github.com/stackrox/bleve

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/stackrox/bleve
• Owner: stackrox
• License: apache-2.0
• Created: 2019-08-01T16:04:00.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-09-07T15:05:30.000Z (over 3 years ago)
• Last Synced: 2025-03-02T17:26:11.527Z (11 months ago)
• Language: Go
• Size: 12.9 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

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

[![Build Status](https://travis-ci.org/blevesearch/bleve.svg?branch=master)](https://travis-ci.org/blevesearch/bleve) [![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)

modern text indexing in go - [blevesearch.com](http://www.blevesearch.com/)

Try out bleve live by [searching the bleve website](http://www.blevesearch.com/search/?q=bleve).

## Features

* Index any go data structure (including JSON)

* Intelligent defaults backed up by powerful configuration

* Supported field types:

    * Text, Numeric, Date

* Supported query types:

    * Term, Phrase, Match, Match Phrase, Prefix

    * Conjunction, Disjunction, Boolean

    * Numeric Range, Date Range

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

* tf-idf Scoring

* Search result match highlighting

* Supports Aggregating Facets:

    * Terms Facet

    * Numeric Range Facet

    * Date Range Facet

## Discussion

Discuss usage and development of bleve in the [google group](https://groups.google.com/forum/#!forum/bleve).

## Indexing

```go

message := struct{

	Id   string

	From string

	Body string

}{

	Id:   "example",

	From: "marty.schoch@gmail.com",

	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)

```

## License

Apache License Version 2.0