Scout-style API
search, where, orderBy, paginate; migration is mostly a trait swap.
Scout / Eloquent + Rust + Go
Full-text searchfor Eloquent models
Nine engines, six frameworks plus plain PHP, all behind one query and indexing API.
One API, swap engines without touching app code
The Searchable trait wires the model, observer and query builder together; every search request ends at the shared Engine contract.
The config root resolves from the Webman plugin path, SCOUT_CONFIG_KEY, Yii params or Scout::configure(), so the same code runs on six frameworks and plain PHP.
- Scout-compatible query builder
- Nine engines, one contract
- Queued or synchronous indexing
9Search engines
6Frameworks
v2.2.0Version
Sniffy
Sniffy, a scout dog with a magnifier: it sniffs out documents, buries them in the index and tracks them back on demand.
One sniff, and documents line up.Search, indexing and engines, each in place
Only one contract sits between models, the builder and engines.
Nine search engines
OpenSearch, Elasticsearch, Meilisearch and six more engines.
Advanced queries
Time ranges, geo distance, full text, KNN vector ranking and facet aggregations.
Automatic index sync
saved, deleted and restored events trigger writes, with soft-deleted documents.
Queued indexing
Async with Webman Redis Queue; logs and falls back to sync when missing.
Six framework hosts
Webman, Laravel, Hyperf, ThinkPHP, Yii2, Yii3 and plain PHP.
The same capability in Rust and Go
Beyond PHP, the same search capability ships as Rust and Go implementations.
Rust
v0.9.0
rust-scout
Search abstraction for Rust
Eight backends behind one Engine trait, zero-dependency in-memory default, no app changes.
- Eight search backends
- Chainable queries
- Index lifecycle
Go
v1.4.0
go-scout
Scout-style sync for Go
Syncs model saves, deletes and restores to search, with nine engines and sixteen driver names.
- Nine search engines
- In-process async queue
- Sixteen driver names
From engines to multi-framework delivery
Version entries come from real commits and releases.
v2.2.0
Laravel 13 support
Supports Laravel 13 and symfony/console 8, keeping dependency resolution current.
v2.1.6
console 8 compatibility fix
Fixes installation failures and fatal errors under symfony/console 8.x.
v2.1.0
Plain PHP and review fixes
Adds a plain PHP configuration entry and the project pet, plus a review round of fixes.
v2.0.0
Multi-framework support
Adds multi-framework integration support and the matching documentation.
Architecture and design
Click an image to enlarge.
Install and use
Install first, then run a minimal example.
Install
composer require erikwang2013/webman-scoutMinimal example
use Erikwang2013\WebmanScout\Searchable;
use support\Model;
class Product extends Model
{
use Searchable;
public function searchableAs(): string
{
return 'products';
}
}
$products = Product::search('phone')
->where('status', 1)
->paginate(15);Install
cargo add rust-scout
cargo add tokio --features macros,rt
cargo add serde_jsonMinimal example
use rust_scout::{Engine, EngineManager, ScoutConfig, SearchBuilder, SearchDocument};
#[tokio::main]
async fn main() -> rust_scout::Result<()> {
let engine = EngineManager::new(ScoutConfig::collection()).engine()?;
let doc = SearchDocument::new("book-1", serde_json::json!({
"title": "Programming Rust"
}))?;
engine.update(&[doc]).await?;
let result = engine
.search(SearchBuilder::new("rust").within("default").take(10))
.await?;
println!("total = {}", result.total);
Ok(())
}Install
go get github.com/erikwang2013/go-scoutMinimal example
type Post struct { ID int; Title string }
func (p Post) ScoutKey() any { return p.ID }
func (p Post) TableName() string { return "posts" }
func (p Post) ShouldBeSearchable() bool { return p.Title != "" }
func (p Post) ToSearchableArray() map[string]any { return map[string]any{"title": p.Title} }
func main() {
ctx := context.Background()
s := scout.NewWithConfig(scout.DefaultConfig())
engines.Register(s.Manager)
sr := s.Searchable(&Post{}, scout.NewMemorySource(Post{ID: 1}))
_, _ = sr.MakeAllSearchable(ctx, 0)
_, _ = sr.Search(ctx, "Go", nil).Take(10).Get(ctx)
}Twelve moods of Sniffy
Hover for a moment and its mood changes.