Categorygithub.com/mkawserm/bdodb
modulepackage
0.1.2
Repository: https://github.com/mkawserm/bdodb.git
Documentation: pkg.go.dev

# README

bdodb

Build Status Go Report Card Coverage Status


Package bdodb is a badger based backend database for bleve with all the customization options provided by the badger

Usage

➜ go get github.com/mkawserm/bdodb .


package main

import (
    "fmt"
    "github.com/blevesearch/bleve"
    "github.com/blevesearch/bleve/index/upsidedown"
    "github.com/mkawserm/bdodb"
)

func main() { 
    // create or open bleveIndex
    index, err := bdodb.BleveIndex("/tmp/bdodb", bleve.NewIndexMapping(), upsidedown.Name, nil)
    
    message := struct{
        Id   string
        Body string
    }{
        Id:   "custom_id", 
        Body: "bleve indexing with badger using bdodb",
    }
    
    // index message data 
    err = index.Index(message.Id, message)
    if err !=nil {
        panic(err)
    }
    
    // search for some text 
    query := bleve.NewQueryStringQuery("bdodb")
    search := bleve.NewSearchRequest(query)
    if searchResults, err := index.Search(search); err == nil {
        fmt.Println(searchResults)
    } else {
        fmt.Println(err)
    }
}

# Functions

BleveIndex a helper function that open (creates if not exists a new) bleve index.
NewStore returns a registry.KVStoreConstructor.

# Constants

EngineName is the name of this engine in blevesearch.

# Variables

DefaultLogger is the default logger for bdodb Set different logger to modify the logging behavior.

# Structs

Config manages Logger and EncryptionKey option for the badger backend.
Iterator implements bleve store iterator.
Reader implements bleve store Reader interface.
Store implements bleve store.
Writer implements bleve store Writer interface.

# Interfaces

Logger interface.