Download the PHP package friendsofcat/opensearch-adapter without Composer

On this page you can find all versions of the php package friendsofcat/opensearch-adapter. 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?

Example code of friendsofcat/opensearch-adapter

Informations about the package opensearch-adapter

OpenSearch Adapter

OpenSearch Adapter is an adapter for the official PHP OpenSearch client. It's designed to simplify basic index and document operations.

Contents

Compatibility

The current version of OpenSearch Adapter has been tested with the following configuration:

Installation

The library can be installed via Composer:

Configuration

OpenSearch Adapter uses friendsofcat/opensearch-client as a dependency. To change the client settings you need to publish the configuration file first:

In the newly created config/opensearch.client.php file you can define the default connection name and describe multiple connections using configuration hashes. Please, refer to the opensearch-client documentation for more details.

Index Management

\OpenSearch\Adapter\Indices\IndexManager is used to manipulate indices.

Create

Create an index, either with the default settings and mapping:

or configured according to your needs:

Alternatively, you can create an index using raw input:

Drop

Delete an index:

Put Mapping

Update an index mapping using builder:

or using raw input:

Put Settings

Update an index settings using builder:

or using raw input:

Exists

Check if an index exists:

Open

Open an index:

Close

Close an index:

Put Alias

Create an alias:

The same with raw input:

Get Aliases

Get index aliases:

Delete Alias

Delete an alias:

Connection

Switch OpenSearch connection:

Document Management

\OpenSearch\Adapter\Documents\DocumentManager is used to manage and search documents.

Index

Add a document to the index:

There is also an option to refresh index immediately:

Finally, you can set a custom routing:

Delete

Remove a document from the index:

If you want the index to be refreshed immediately pass true as the third argument:

You can also set a custom routing:

Finally, you can delete documents using query:

Search

Search documents in the index:

Connection

Switch OpenSearch connection:

All versions of opensearch-adapter with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
friendsofcat/opensearch-client Version ^2.0
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-adapter contains the following files

Loading the files please wait ....