OpenSearch Specific Queries

OpenSearch offers a rich set of query capabilities, including geospatial queries and regex-based searches, which go beyond the traditional query types found in SQL databases. The Laravel-opensearch integration provides a seamless interface to leverage these powerful features directly within your Laravel models.

---

GeoBox

The filterGeoBox method allows you to retrieve documents based on geospatial data, specifically targeting documents where a geo-point field falls within a defined “box” on a map. This is particularly useful for applications requiring location-based filtering, such as finding all events within a specific geographical area.

// Define the top-left and bottom-right coordinates of the box
$topLeft = [-10, 10]; // [latitude, longitude]
$bottomRight = [10, -10]; // [latitude, longitude]

// Retrieve UserLogs where 'agent.geo' falls within the defined box
$logs = UserLog::where('status', 7)->filterGeoBox('agent.geo', $topLeft, $bottomRight)->get();

{
    "index": "user_logs",
    "body": {
        "query": {
            "bool": {
                "must": [
                    {
                        "match": {
                            "status": 7
                        }
                    }
                ],
                "filter": {
                    "geo_bounding_box": {
                        "agent.geo": {
                            "top_left": [
                                -10,
                                10
                            ],
                            "bottom_right": [
                                10,
                                -10
                            ]
                        }
                    }
                }
            }
        },
        "_source": [
            "*"
        ]
    }
}

DSL

---

GeoPoint

The filterGeoPoint method filters results based on their proximity to a given point, specified by latitude and longitude, within a certain radius.

// Specify the central point and radius
$point = [0, 0]; // [latitude, longitude]
$distance = '20km';

// Retrieve UserLogs where 'agent.geo' is within 20km of the specified point
$logs = UserLog::where('status', 7)->filterGeoPoint('agent.geo', $distance, $point)->get();

{
    "index": "user_logs",
    "body": {
        "query": {
            "bool": {
                "must": [
                    {
                        "match": {
                            "status": 7
                        }
                    }
                ],
                "filter": {
                    "geo_distance": {
                        "distance": "20km",
                        "agent.geo": {
                            "lat": 0,
                            "lon": 0
                        }
                    }
                }
            }
        },
        "_source": [
            "*"
        ]
    }
}

DSL

The $distance parameter is a string combining a numeric value and a distance unit (e.g., km for kilometers, mi for miles). Refer to the opensearch documentation on distance units for more information.

Note

The field must be of type geo for both filterGeoBox and filterGeoPoint methods otherwise your shards will fail, make sure to set the geo field in your migration, ex:

Schema::create('user_logs',function (IndexBlueprint $index){
$index->geo('agent.geo');
});

For more details, see Migrations

---

Where Exact

This method allows you to query for exact case-sensitive matches within a field. This is useful when you need to find a specific value. Keep in mind that the field will also need to have a keyword mapping.

Under the hood, this method uses the term query from opensearch’s Query DSL.

return Person::whereExact('name', 'John Smith')->get();

This will only return the documents where the name field is exactly ‘John Smith’. ‘john smith’ or ‘John’ will not be returned.

{
    "index": "people",
    "body": {
        "query": {
            "term": {
                "name.keyword": "John Smith"
            }
        },
        "_source": [
            "*"
        ]
    }
}

DSL

---

Where Phrase

This method allows you to query for exact phrases within a field. This is useful when you need to search for a specific sequence of words within a text field.

Under the hood, this method uses the match_phrase query from opensearch’s Query DSL.

return Person::wherePhrase('description', 'loves espressos')->get();

This will only return the documents where the description field contains the exact phrase ‘loves espressos’. Individual tokens like ‘loves’ or ‘espressos’ will not be returned in isolation.

{
    "index": "people",
    "body": {
        "query": {
            "match_phrase": {
                "description": "loves espressos"
            }
        },
        "_source": [
            "*"
        ]
    }
}

DSL

---

Where Phrase Prefix

Similar to WherePhrase, this method allows you to query for exact phrases where the last word starts with a particular prefix.

Under the hood, this method uses the match_phrase_prefix query from opensearch’s Query DSL.

return Person::wherePhrasePrefix('description', 'loves es')->get();

This will only return the documents where the description field contains the the phrase ‘loves es…’. Ex: ‘loves espresso’, ‘loves essays’ and ‘loves eskimos’ etc

{
    "index": "people",
    "body": {
        "query": {
            "match_phrase_prefix": {
                "description": "loves es"
            }
        },
        "_source": [
            "*"
        ]
    }
}

DSL

---

Where Timestamp

This method allows you to query for timestamps on a known field and will sanitize the input to ensure it is a valid timestamp for both seconds and milliseconds.

return Product::whereTimestamp('last_viewed', '<=', 1713911889521)->get();

This will only return the documents where the last_viewed field is less than or equal to the timestamp 1713911889521 ms.

{
    "index": "products",
    "body": {
        "query": {
            "range": {
                "last_viewed": {
                    "lte": 1713911889521
                }
            }
        },
        "_source": [
            "*"
        ]
    }
}

DSL

---

Where Regex

The WhereRegex method allows you to query for documents based on a regular expression pattern within a field.

$regex1 = Product::whereRegex('color', 'bl(ue)?(ack)?')->get();
$regex2 = Product::whereRegex('color', 'bl...*')->get();

The first example will return documents where the color field matches the pattern ‘bl(ue)?(ack)?’, which means it can be ‘blue’ or ‘black’. The second example will return documents where the color field matches the pattern ‘bl…*’, which means it starts with ‘bl’ and has at least three more characters. Both should return Blue or Black from the colors field.

{
    "index": "products",
    "body": {
        "query": {
            "regexp": {
                "color": {
                    "value": "bl(ue)?(ack)?"
                }
            }
        },
        "_source": [
            "*"
        ]
    }
}
{
    "index": "products",
    "body": {
        "query": {
            "regexp": {
                "color": {
                    "value": "bl...*"
                }
            }
        },
        "_source": [
            "*"
        ]
    }
}

DSL

---

RAW DSL Queries

For scenarios where you need the utmost flexibility and control over your opensearch queries, the Laravel-opensearch integration provides the capability to directly use opensearch’s Query DSL (Domain Specific Language). The results will still be returned as collections of Eloquent models.

$bodyParams = [
  'query' => [
    'match' => [
      'color' => 'silver',
    ],
  ],
];

return Product::rawSearch($bodyParams); //Will search within the products index

return Product::rawSearch($bodyParams,true); //Will return the raw response from opensearch

The DSL example above uses the match query to search for products with the color ‘silver’

Explain

---

RAW Aggregation Queries

Similar to raw search queries, you can also execute raw aggregation queries using opensearch’s Aggregation DSL. This allows you to perform complex aggregations on your data and retrieve the results in a structured format.

$body = [
    'aggs' => [
        'price_ranges' => [
            'range' => [
                'field'  => 'price',
                'ranges' => [
                    ['to' => 100],
                    ['from' => 100, 'to' => 500],
                    ['from' => 500, 'to' => 1000],
                    ['from' => 1000],
                ],

            ],
            'aggs'  => [
                'sales_over_time' => [
                    'date_histogram' => [
                        'field'          => 'datetime',
                        'fixed_interval' => '1d',
                    ],

                ],
            ],
        ],
    ],
];
return Product::rawAggregation($body);

The aggregation example above uses the range aggregation to group products into price ranges and the date_histogram aggregation to group sales over time within each price range.

Explain

---

To DSL

This method returns the parsed DSL query from the query builder. This can be useful when you need to inspect the raw query being generated by the query builder.

$query = Product::where('price', '>', 100)->toDSL();

This will return the raw DSL query generated by the query builder instance.

Explain

Note

toDsl() and the inherited toSQL() are the same method. You can use them interchangeably.

---