spameri/elastic-query

There is no license information available for the latest version (v2.0.0-alpha.3) of this package.

Objects instead of arrays for querying to ElasticSearch.

Maintainers

Details

github.com/Spameri/ElasticQuery

Source

Issues

Installs: 41 867

Dependents: 1

Suggesters: 0

Security: 0

Stars: 6

Watchers: 1

Forks: 4

Open Issues: 1

pkg:composer/spameri/elastic-query

v2.0.0-alpha.3 2024-08-15 15:58 UTC

Requires

Requires (Dev)

Unknown License dd59c4eeb4235863f44ffc527ce87b300c0e3071

  • Václav Čevela <vcevela.woop@gmail.com>

This package is auto-updated.

Last update: 2025-12-23 00:56:52 UTC

README

A PHP library that converts Elasticsearch query DSL into strongly-typed PHP objects. Instead of building queries as arrays, use type-safe classes that mirror the Elasticsearch documentation.

Features

  • Type-safe queries - Full-text, term-level, compound, geo, and nested queries
  • Aggregations - Metric (min, max, avg) and bucket (terms, histogram, range, filter) aggregations
  • Response mapping - Automatic mapping of Elasticsearch responses to typed objects
  • Index mapping - Define index settings, analyzers, tokenizers, and filters
  • Function scoring - Custom scoring with field value factors, weights, and random scores
  • Highlighting - Search result highlighting support
  • Pagination & sorting - Options for size, offset, scroll, and geo-distance sorting

Requirements

  • PHP 8.2 or higher

Installation

Install via Composer:

composer require spameri/elastic-query

Quick Start

use Spameri\ElasticQuery\ElasticQuery;
use Spameri\ElasticQuery\Query\ElasticMatch;
use Spameri\ElasticQuery\Query\Term;

// Create a query
$query = new ElasticQuery();

// Add a must query (AND condition)
$query->addMustQuery(new ElasticMatch('title', 'Elasticsearch'));

// Add a filter (cached, no scoring)
$query->addFilter(new Term('status', 'published'));

// Set pagination
$query->options()->changeSize(10);
$query->options()->changeFrom(0);

// Convert to array for Elasticsearch client
$body = $query->toArray();

Documentation

Learn more in the documentation:

License

MIT