Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdphilip/laravel-opensearch
An OpenSearch implementation of Laravel's Eloquent ORM
https://github.com/pdphilip/laravel-opensearch
eloquent-orm laravel opensearch
Last synced: 3 days ago
JSON representation
An OpenSearch implementation of Laravel's Eloquent ORM
- Host: GitHub
- URL: https://github.com/pdphilip/laravel-opensearch
- Owner: pdphilip
- License: mit
- Created: 2024-04-28T21:39:53.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-11-05T09:37:32.000Z (3 months ago)
- Last Synced: 2024-11-24T20:42:37.363Z (2 months ago)
- Topics: eloquent-orm, laravel, opensearch
- Language: PHP
- Homepage: https://opensearch.pdphilip.com/
- Size: 110 KB
- Stars: 24
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel-OpenSearch
[](https://packagist.org/packages/pdphilip/laravel-opensearch)
[](https://packagist.org/packages/pdphilip/opensearch)
> **This package has been built off the back of the original [Elasticsearch version](https://github.com/pdphilip/laravel-elasticsearch) of this package**
>
> **The starting point of this package was forked from `v4.0.1` with over 2 years of development**
[OpenSearch](https://opensearch.net/) is a distributed, community-driven, Apache 2.0-licensed, 100% open-source search and analytics suite used for a broad set of use cases like real-time application monitoring, log analytics, and website
search.
### An OpenSearch implementation of Laravel's Eloquent ORM
This package extends Laravel's Eloquent model and query builder with seamless integration of OpenSearch functionalities. Designed to feel native to Laravel, this package enables you to work with Eloquent models while leveraging the
powerful search and analytics capabilities of OpenSearch.
Examples:
```php
$logs = UserLog::where('created_at','>=',Carbon::now()->subDays(30))->get();
```
```php
$updates = UserLog::where('status', 1)->update(['status' => 4]);
```
```php
$updates = UserLog::where('status', 1)->paginate(50);
```
```php
$profiles = UserProfile::whereIn('country_code',['US','CA'])->orderByDesc('last_login')->take(10)->get();
```
```php
$deleted = UserProfile::where('state','unsubscribed')->where('updated_at','<=',Carbon::now()->subDays(90))->delete();
```
```php
$search = UserProfile::phrase('loves espressos')->highlight()->search();
```
---
> ### Read the [Documentation](https://opensearch.pdphilip.com/)
---
## Installation
**Laravel 10 & 11 (main):**
```bash
composer require pdphilip/opensearch
```
| Laravel Version | Command | Maintained |
|-----------------|--------------------------------------------|------------|
| Laravel 10 & 11 | `composer require pdphilip/opensearch:~2 ` | ✅ |
| Laravel 8 & 9 | `composer require pdphilip/opensearch:~1` | ✅ |
## Configuration
1. Set up your `.env` with the following OpenSearch settings:
```ini
OS_HOSTS="http://opensearch:9200"
OS_USERNAME=
OS_PASSWORD=
OS_INDEX_PREFIX=my_app
OS_SIG_V4_PROVIDER=
OS_SIG_V4_REGION=
OS_SIG_V4_SERVICE=
OS_SSL_CERT=
OS_SSL_CERT_PASSWORD=
OS_SSL_KEY=
OS_SSL_KEY_PASSWORD=
OS_OPT_VERIFY_SSL=true
OS_OPT_RETRIES=
OS_OPT_SNIFF_ON_START=
OS_OPT_PORT_HOST_HEADERS=
OS_ERROR_INDEX=
```
For multiple nodes, pass in as comma-separated:
```ini
OS_HOSTS="http://opensearch-node1:9200,http://opensearch-node2:9200,http://opensearch-node3:9200"
```
2. In `config/database.php`, add the opensearch connection:
```php
'opensearch' => [
'driver' => 'opensearch',
'hosts' => explode(',', env('OS_HOSTS', 'http://localhost:9200')),
'basic_auth' => [
'username' => env('OS_USERNAME', ''),
'password' => env('OS_PASSWORD', ''),
],
'sig_v4' => [
'provider' => env('OS_SIG_V4_PROVIDER'),
'region' => env('OS_SIG_V4_REGION'),
'service' => env('OS_SIG_V4_SERVICE'),
],
'ssl' => [
'cert' => env('OS_SSL_CERT', ''),
'cert_password' => env('OS_SSL_CERT_PASSWORD', ''),
'key' => env('OS_SSL_KEY', ''),
'key_password' => env('OS_SSL_KEY_PASSWORD', ''),
],
'index_prefix' => env('OS_INDEX_PREFIX', false),
'options' => [
'ssl_verification' => env('OS_OPT_VERIFY_SSL', true),
'retires' => env('OS_OPT_RETRIES'),
'sniff_on_start' => env('OS_OPT_SNIFF_ON_START'),
'port_in_host_header' => env('OS_OPT_PORT_HOST_HEADERS'),
],
'error_log_index' => env('OS_ERROR_INDEX', false),
],
```
### 3. If packages are not autoloaded, add the service provider:
For **Laravel 10 and below**:
```php
//config/app.php
'providers' => [
...
...
PDPhilip\OpenSearch\OpenSearchServiceProvider::class,
...
```
For **Laravel 11**:
```php
//bootstrap/providers.php