Download the PHP
package jobtech/jt-opensearch-support without Composer
On this page you can find all versions of the php package
jobtech/jt-opensearch-support. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
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.
Informations about the package jt-opensearch-support
# Jobtech OpenSearch Support
This package makes it easy to communicate with OpenSearch
## Installation
Install the package in your application using composer
Publish vendor
This is the content of the published config file:
## Usage
Create own index that implements
Declare in opensearch.php file your indices
Configure the connection parameters to OpenSearch, as host and basicAuthentication.
There is the possibility of adding a prefix to the indexes that are created with this package.
The prefix is then handled automatically by the package.
## API
### existsIndex
Returns whether or not an index already exists.
### getIndex
This operation returns information on an index.
### createIndex
An empty index can be created for later use.
When creating an index, it is possible to specify its mappings, settings and aliases.
### putIndexSettings
Index-level settings can be updated. Dynamic index settings can be changed at any time, whereas static settings cannot be changed after the index has been created.
### putIndexMappings
It is possible to create or add mappings and fields to an index.
This operation cannot be used to update mappings that already correspond to existing data in the index.
### deleteIndex
This operation delete an index.
### openIndex
A closed index can be opened, allowing data to be added or searched within the index.
### closeIndex
This operation closes an index. Once an index is closed, it is no longer possible to add data to it or search for data within the index.
### retrieveDocument
This api permit to retrieve a document with information and data, from index with specified id.
### createDocument
It allows a document to be created with its data and a specific id.
### createDocumentWithoutId
It allows a document to be created with its data and without a specific id.
### createDocumentFrom
Allows you to create a document from an array of specific parameters.,
### updateDocument
It is possible to update the fields of a document in a specific index. Is it possible specify new data to be included in the index.
### upsertDocument
Upsert is an operation that conditionally either updates an existing document or inserts a new one based on information in the object.
### deleteDocument
This operation delete a document.
### countDocument
Returns how many document there are in the index.
### search
Allows a search request to be made to search for data in the cluster according to the required parameters.
### searchWithPagination
Allows a search request to be made to search for data in the cluster according to the required parameters.
Everything is returned with a pagination.
## Testing
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [SECURITY](SECURITY.md) on how to report security vulnerabilities.
## Credits
- [Alessandro Romano](https://github.com/Dasheel)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
All versions of jt-opensearch-support with dependencies
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 jobtech/jt-opensearch-support contains the following files
Loading the files please wait ....
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.