Download the PHP package friendsofcat/opensearch-scout-driver-plus without Composer

On this page you can find all versions of the php package friendsofcat/opensearch-scout-driver-plus. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package opensearch-scout-driver-plus

OpenSearch Scout Driver Plus

Extension for OpenSearch Scout Driver.

Contents

Features

OpenSearch Scout Driver Plus supports:

Compatibility

The current version of OpenSearch Scout Driver Plus has been tested with the following configuration:

Installation

The library can be installed via Composer:

Note that this library doesn't work without OpenSearch Scout Driver. If it's not installed yet, please follow the installation steps described here. If you already use OpenSearch Scout Driver, I recommend you to update it before installing OpenSearch Scout Driver Plus:

After installing the libraries, you need to add OpenSearch\ScoutDriverPlus\Searchable trait to your models. In case some models already use the standard Laravel\Scout\Searchable trait, you should replace it with the one provided by OpenSearch Scout Driver Plus.

If you want to use OpenSearch Scout Driver Plus with Lumen framework refer to this guide.

Usage

Query

Before you begin searching a model, you should define a query. You can either use a query builder or describe the query with an array:

Each method of OpenSearch\ScoutDriverPlus\Support\Query factory creates a query builder for the respective type. Available methods are listed below:

Search Parameters

When the query is defined, you can begin new search with searchQuery method:

You can then chain other parameters to make your search request more precise:

The builder supports various search parameters and provides a number of useful helpers:

Search Results

You can retrieve search results by chaining the execute method onto the builder:

$searchResult provides easy access to matching hits, models, documents, etc.:

You can get more familiar with the $searchResult object and learn how to paginate the search results on this page.

Custom Routing

If you want to use a custom shard routing for your model, override the searchableRouting method:

Custom routing is automatically applied to all index and delete operations.

Eager Loading Relations

Sometimes you need to index your model with related data:

You can improve the performance of bulk operations by overriding the searchableWith method:

In case you are looking for a way to preload relations for models matching a search query, check the builder's load method documentation.

Multiple Connections

You can configure multiple connections to OpenSearch in the client's configuration file. If you want to change a connection used by a model, you need to override the searchableConnection method:


All versions of opensearch-scout-driver-plus with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
friendsofcat/opensearch-scout-driver Version ^2.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package friendsofcat/opensearch-scout-driver-plus contains the following files

Loading the files please wait ....