go lucene

go-lucene

Ein in go geschriebener Lucene-Parser ohne Abhängigkeiten.

Mit diesem Paket können Sie die Suche im Lucene-Stil schnell in Ihre App integrieren und SQL-Filter für eine bestimmte Abfrage generieren. Es gibt keine externen Abhängigkeiten und die Grammatik unterstützt vollständig Apache Lucene 9.4.2.

Standardmäßig unterstützt go-lucene die Postgres-kompatible SQL-Generierung, kann jedoch erweitert werden, um auch verschiedene SQL-Varianten (oder kein SQL) zu unterstützen.

Verwendung

Verwenden Sie lucene.ToPostgres um eine einzelne Zeichenfolge mit allen Ihren Filtern darin zu generieren.

Verwenden Sie lucene.ToParmeterizedPostgres um eine parametrisierte Zeichenfolge mit Argumenten zu generieren, die Sie an Ihre DB-Abfrage übergeben können.

Verwenden Sie die Option lucene.WithDefaultField , um einem Feld reine Literale zuzuordnen.

Reine Saite

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

Parametrisierte Eingabe

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

Standardfelder

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

Erweitern mit einem benutzerdefinierten Treiber

Betten Sie einfach den Base in Ihren benutzerdefinierten Treiber ein und überschreiben Sie die RenderFN mit Ihren eigenen benutzerdefinierten Rendering-Funktionen.

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