readme.md

Experimental port of PHP k-samuel/faceted-search v0.3.4

PHP Library https://github.com/k-samuel/faceted-search

Golang version benchmark

(Apple M2 macOS 14.0)

Bench v0.3.4 golang 1.21.5 with parallel aggregates

Items count	Memory	Query	Aggregate & Count	Sort by field	Results Found
10,000	~7Mb	~0.0002 s.	~0.001 s.	~0.0001 s.	907
50,000	~14Mb	~0.001 s.	~0.012 s.	~0.0007 s.	4550
100,000	~21Mb	~0.002 s.	~0.027 s.	~0.001 s.	8817
300,000	~47Mb	~0.008 s.	~0.086 s.	~0.004 s.	26891
1,000,000	~140Mb	~0.030 s.	~0.297 s.	~0.015 s.	90520

Bench like_3.x golang 1.21.5 (clone of k-samuel/faceted-search 3.x algorithm)

Items count	Memory	Query	Aggregate & Count	Sort by field	Results Found
10,000	~7Mb	~0.0004 s.	~0.006 s.	~0.0004 s.	907
50,000	~14Mb	~0.002 s.	~0.031 s.	~0.0008 s.	4550
100,000	~21Mb	~0.004 s.	~0.062 s.	~0.001 s.	8817
300,000	~47Mb	~0.013 s.	~0.213 s.	~0.004 s.	26891
1,000,000	~140Mb	~0.042 s.	~0.800 s.	~0.017 s.	90520

PHP version benchmark

v3.1.0 Bench PHP 8.2.10 + JIT + opcache (no xdebug extension)

ArrayIndex

Items count	Memory	Query	Aggregate & Count	Sort by field	Results Found
10,000	~3Mb	~0.0003 s.	~0.001 s.	~0.0002 s.	907
50,000	~20Mb	~0.001 s.	~0.006 s.	~0.0005 s.	4550
100,000	~40Mb	~0.002 s.	~0.013 s.	~0.001 s.	8817
300,000	~95Mb	~0.006 s.	~0.036 s	~0.002 s.	26891
1,000,000	~329Mb	~0.024 s.	~0.134 s.	~0.009 s.	90520

FixedArrayIndex

Items count	Memory	Query	Aggregate & Count	Sort by field	Results Found
10,000	~2Mb	~0.0005 s.	~0.002 s.	~0.0003 s.	907
50,000	~12Mb	~0.002 s.	~0.012 s.	~0.0007 s.	4550
100,000	~23Mb	~0.006 s.	~0.029 s.	~0.001 s.	8817
300,000	~70Mb	~0.012 s.	~0.072 s.	~0.003 s.	26891
1,000,000	~233Mb	~0.045 s.	~0.257 s.	~0.012 s.	90520

Note

Search index should be created in one thread before using. Currently, Index hash map access not using mutex. It can cause problems in concurrent writes and reads.

Example

    package main

    import (
    "github.com/k-samuel/go-faceted-search/pkg/filter"
    "github.com/k-samuel/go-faceted-search/pkg/index"
    "github.com/k-samuel/go-faceted-search/pkg/search"
    )

    idx := index.NewIndex()
    facet := search.NewSearch(idx)
    // example data
    data := []map[string]interface{}{
        {"color": "black", "size": 7, "group": "A"},
        {"color": "black", "size": 8, "group": "A"},
        {"color": "white", "size": 7, "group": "B"},
        {"color": "yellow", "size": 7, "group": "C"},
        {"color": "black", "size": 7, "group": "C"},
    }
    // Add values using i as recordId
    for i, v := range data {
        idx.Add(int64(i), v)
    }
	
    // create some filters
    filters := []filter.FilterInterface{
        & filter.ValueFilter{FieldName: "color", Values: []string{"black"}},
        & filter.ValueFilter{FieldName: "size", Values: []string{"7"}},
    }
    // find records
    res, _ := facet.Find(filters, []int64{})
    // aggregate filters
    info, _ := facet.AggregateFilters(filters, []int64{})

More examples

Web Server

Test

go test ./test -coverpkg ./pkg/... -v -coverprofile=cover.out && go tool cover -html=cover.out -o cover.html