go lucene

go-lucene

Um analisador lucene escrito em go sem dependências.

Com este pacote você pode integrar rapidamente a pesquisa no estilo lucene dentro do seu aplicativo e gerar filtros sql para uma consulta específica. Não há dependências externas e a gramática oferece suporte total ao Apache Lucene 9.4.2.

O go-lucene pronto para uso oferece suporte à geração de sql compatível com postgres, mas também pode ser estendido para suportar diferentes sabores de sql (ou nenhum sql).

Uso

Use lucene.ToPostgres para gerar uma única string com todos os seus filtros nela.

Use lucene.ToParmeterizedPostgres para gerar uma string parametrizada com argumentos que você pode passar para sua consulta de banco de dados.

Use a opção lucene.WithDefaultField para associar literais simples a um campo.

Corda Pura

 // suppose you want a query for red apples that are not honey crisp or granny smith and are older than 5 months old
myQuery := `color:red AND NOT (type:"honey crisp" OR type:"granny smith") AND age_in_months:[5 TO *]`
filter , err := lucene . ToPostgres ( myQuery )
if err != nil {
    // handle error
}

SQLTemplate := `
SELECT *
FROM apples
WHERE %s
LIMIT 10;
`
sqlQuery := fmt . Sprintf ( SQLTemplate , filter )

// sqlQuery is:
`

SELECT *
FROM apples
WHERE
    (
		("color" = 'red') AND 
		(
			NOT(
				("type" = 'honey crisp') OR 
				("type" = 'granny smith')
			)
		)
	) AND 
	("age_in_months" >= 5)
LIMIT 10;
` 

Entrada parametrizada

 // suppose you want a query for red apples that are not honey crisp or granny smith and are older than 5 months old
myQuery := `color:red AND NOT (type:"honey crisp" OR type:"granny smith") AND age_in_months:[5 TO *]`
filter , params , err := lucene . ToParameterizedPostgres ( myQuery )
if err != nil {
    // handle error
}

SQLTemplate := `
SELECT *
FROM apples
WHERE %s
LIMIT 10;
`
sqlQuery := fmt . Sprintf ( SQLTemplate , filter )

db . Query ( sqlQuery , params )

Campos padrão

 myQuery := "red OR green"
filter , err := lucene . ToPostgres (
	myQuery , lucene . WithDefaultField ( "appleColor" ))
if err != nil {
    // handle error
}

SQLTemplate := `
SELECT *
FROM apples
WHERE %s
LIMIT 10;
`
sqlQuery := fmt . Sprintf ( SQLTemplate , filter )

// sqlQuery is:
`
SELECT *
FROM apples
WHERE
    ("appleColor" = 'red') OR ("appleColor" = 'green')
LIMIT 10;
` 

Estendendo com um driver personalizado

Basta incorporar o driver Base em seu driver personalizado e substituir o RenderFN por suas próprias funções de renderização personalizadas.

 import (
	"github.com/grindlemire/go-lucene"
	"github.com/grindlemire/go-lucene/pkg/driver"
	"github.com/grindlemire/go-lucene/pkg/lucene/expr"
)

type MyDriver struct {
	driver. Base
}
// Suppose we want a customer driver that is postgres but uses "==" rather than "=" for an equality check.
func NewMyDriver () MyDriver {
	// register your new custom render functions. Each render function
	// takes a left and optionally right rendered string and returns the rendered
	// output string for the entire expression.
	fns := map [expr. Operator ]driver. RenderFN {
		expr . Equals : myEquals ,
	}

	// iterate over the existing base render functions and swap out any that you want to
	for op , sharedFN := range driver . Shared {
		_ , found := fns [ op ]
		if ! found {
			fns [ op ] = sharedFN
		}
	}

	// return the new driver ready to use
	return MyDriver {
		driver. Base {
			RenderFNs : fns ,
		},
	}
}

// Suppose we wanted to implement equals using a "==" operator instead of "="
func myEquals ( left , right string ) ( string , error ) {
	return left + " == " + right , nil
}

...
func main () {
	// create a new instance of the driver
	driver := NewMyDriver ()

	// render an expression
	expr , _ := lucene . Parse ( `color:red AND NOT (type:"honey crisp" OR type:"granny smith") AND age_in_months:[5 TO *]` )
	filter , _ := driver . Render ( expr )
	
	SQLTemplate := `
	SELECT *
	FROM apples
	WHERE %s
	LIMIT 10;
	`
	sqlQuery := fmt . Sprintf ( SQLTemplate , filter )

	// sqlQuery is:
	`

	SELECT *
	FROM apples
	WHERE
		(
			("color" == 'red') AND 
			(
				NOT(
					("type" == 'honey crisp') OR 
					("type" == 'granny smith')
				)
			)
		) AND 
		("age_in_months" >= 5)
	LIMIT 10;
	`
}