go lucene

allez-lucène

Un analyseur Lucene écrit en Go sans dépendances.

Avec ce package, vous pouvez rapidement intégrer la recherche de style Lucene dans votre application et générer des filtres SQL pour une requête particulière. Il n'y a pas de dépendances externes et la grammaire prend entièrement en charge Apache Lucene 9.4.2.

Go-lucene prend en charge la génération SQL conforme à Postgres, mais il peut également être étendu pour prendre en charge différentes versions de SQL (ou pas de SQL).

Usage

Utilisez lucene.ToPostgres pour générer une seule chaîne contenant tous vos filtres.

Utilisez lucene.ToParmeterizedPostgres pour générer une chaîne paramétrée avec des arguments que vous pouvez transmettre à votre requête DB.

Utilisez l'option lucene.WithDefaultField pour associer des littéraux nus à un champ.

Chaîne pure

 // 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;
` 

Entrée paramétrée

 // 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 )

Champs par défaut

 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;
` 

Extension avec un pilote personnalisé

Intégrez simplement le pilote Base dans votre pilote personnalisé et remplacez les RenderFN par vos propres fonctions de rendu personnalisées.

 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;
	`
}