Skip to content

Add runtimeMappings and fields support to SearchParameters (with tests) #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
babenkoivan merged 3 commits into from
Feb 16, 2026
Merged

Add runtimeMappings and fields support to SearchParameters (with tests) #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db0b239
Add runtimeMappings and fields methods to SearchParameters
jariesdev Feb 14, 2026
a35cf00
Add tests for runtimeMappings and fields methods in SearchParameters
jariesdev Feb 14, 2026
22d1a25
Update README with runtimeMappings example in SearchParameters
jariesdev Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,21 @@ $searchParameters->scriptFields([
],
]);

// runtime mappings
$searchParameters->runtimeMappings([
'day_of_week' => [
'type' => 'long',
'script' => [
'lang' => 'painless',
'source' => 'doc[params.field] * params.multiplier',
'params' => [
'field' => 'my_field',
'multiplier' => 2,
],
],
],
]);

// boost indices
$searchParameters->indicesBoost([
['my-alias' => 1.4],
Expand Down
12 changes: 12 additions & 0 deletions src/Search/SearchParameters.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,18 @@ public function scriptFields(array $scriptFields): self
return $this;
}

public function runtimeMappings(array $runtimeFields): self
{
$this->params['body']['runtime_mappings'] = $runtimeFields;
return $this;
}

public function fields(array $fields): self
{
$this->params['body']['fields'] = $fields;
return $this;
}

public function searchType(string $searchType): self
{
$this->params['search_type'] = $searchType;
Expand Down
46 changes: 46 additions & 0 deletions tests/Unit/Search/SearchParametersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,41 @@ public function test_array_casting_with_script_fields(): void
], $searchParameters->toArray());
}

public function test_array_casting_with_runtime_mappings(): void
{
$searchParameters = (new SearchParameters())->runtimeMappings([
'day_of_week' => [
'type' => 'long',
'script' => [
'lang' => 'painless',
'source' => 'doc[params.field] * params.multiplier',
'params' => [
'field' => 'my_field',
'multiplier' => 2,
],
],
],
]);

$this->assertEquals([
'body' => [
'runtime_mappings' => [
'day_of_week' => [
'type' => 'long',
'script' => [
'lang' => 'painless',
'source' => 'doc[params.field] * params.multiplier',
'params' => [
'field' => 'my_field',
'multiplier' => 2,
],
],
],
],
],
], $searchParameters->toArray());
}

public function test_array_casting_with_min_score(): void
{
$searchParameters = (new SearchParameters())->minScore(0.5);
Expand All @@ -325,6 +360,17 @@ public function test_array_casting_with_min_score(): void
], $searchParameters->toArray());
}

public function test_array_casting_with_fields(): void
{
$searchParameters = (new SearchParameters())->fields(['my_field']);

$this->assertEquals([
'body' => [
'fields' => ['my_field'],
],
], $searchParameters->toArray());
}

public function test_array_casting_with_search_type(): void
{
$searchParameters = (new SearchParameters())->searchType('query_then_fetch');
Expand Down
Loading