Aho-Corasick on Redis, with one API across multiple topologies.

Getting Started

ACOR requires Go 1.23 or newer and Redis 3.0 or newer.

go get -u github.com/skyoo2003/acor

package main

import (
  "fmt"

  "github.com/skyoo2003/acor/pkg/acor"
)

func main() {
  ac, err := acor.Create(&acor.AhoCorasickArgs{
    Addr: "localhost:6379",
    Name: "sample",
  })
  if err != nil {
    panic(err)
  }
  defer ac.Close()

  _, _ = ac.Add("he")
  _, _ = ac.Add("her")
  matched, _ := ac.Find("he is her")
  fmt.Println(matched)
}

Redis Topologies

• Standalone: use Addr for a single Redis server.
• Sentinel: use Addrs with MasterName for failover-aware access.
• Cluster: use Addrs with DB left at 0.
• Ring: use RingAddrs with shard-to-address mappings.

sentinelArgs := &acor.AhoCorasickArgs{
  Addrs:      []string{"localhost:26379", "localhost:26380"},
  MasterName: "mymaster",
  Name:       "sample",
}

clusterArgs := &acor.AhoCorasickArgs{
  Addrs: []string{"localhost:7000", "localhost:7001", "localhost:7002"},
  Name:  "sample",
}

ringArgs := &acor.AhoCorasickArgs{
  RingAddrs: map[string]string{
    "shard-1": "localhost:7000",
    "shard-2": "localhost:7001",
  },
  Name: "sample",
}

CLI Commands

• add <keyword> inserts a keyword into the collection.
• remove <keyword> removes a keyword and prunes related trie state.
• find <input> and find-index <input> return matches or match offsets.
• suggest <input> and suggest-index <input> return prefix suggestions and their offsets.
• info returns keyword and node counts.
• flush clears stored trie state.

HTTP and gRPC Adapters

The HTTP handler exposes JSON endpoints on /v1/* plus /healthz.

• POST /v1/add
• POST /v1/remove
• POST /v1/find
• POST /v1/find-index
• POST /v1/suggest
• POST /v1/suggest-index
• GET /v1/info
• POST /v1/flush

The gRPC service name is acor.server.v1.Acor and mirrors the same operations.

Development Workflow

Run local checks with:

make test
make build

CI runs on pushes and pull requests against master. Releases are tag-based, and the GitHub Pages site is built from the Hugo source in docs/.

Source code is MIT licensed. Contributions should include tests when behavior changes.