The purpose of this Plugin is to enhance open-search engine with user-domain schema by using GraphQL.
These capabilities include:
- Schema creation
- Code Generation
- Query support
- Endpoint Generation
With Open-Search as the search engine database, the simple-search plugin employs GraphQL Library to allow applications to have their data treated natively from the front-end all the way to storage, avoiding duplicate schema work and ensuring flawless integration between front-end and backend developers.
The simple-schema opensearch plugin-Library allows describing the schema of your data, it can generate an entire executable schema with all the additional types needed to execute queries and mutations to interact with your database.
The simple-schema plugin-Library presents a large feature set for interacting with opensearch database using GraphQL:
- Automatic generation of Queries and Mutations for CRUD interactions
- Various Types, including temporal and spatial types
- Support for both entity and relationship properties
- Extensibility through the @custom directive and/or Custom Resolvers
- Extensive Filtering and Sorting options
- Options for index Autogeneration and Default Values
- Multiple Pagination options
The project is currently under 'Alpha' stage.
Alpha - The code is released with instructions to build. Built distributions of the software may not be available. Some features many not be complete. Additional testing and developement work is planned.
Read the documentation
Once you have installed opensearch, you can install simple-schema from a remote URL or a local file.
- Browse the releases.
- Find a release that matches your version of opensearch. Copy the name of the .zip file.
- Install the plugin using the
opensearch-pluginscript that comes with opensearch.
Example:
opensearch-plugin install https://github.com/opensearch-project/simple-schema/releases-2.4.zip
Read the installation docs for more details.
Read the documentation to learn about
| Test and build |  |
| Code coverage |  |
| Distribution build tests |   |
| Backward compatibility tests |  |
 |
 |
 |
 |
 |
 |
See developer guide and how to contribute to this project.
If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.
For more information, see project website and documentation. If you need help and are unsure where to open an issue, try forums.
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.
This project is licensed under the Apache v2.0 License.
Copyright OpenSearch Contributors. See NOTICE for details.