Update JSON-API.adoc Search Functionality Enhanced with LIKE Operator (Since v7.10.x) #678
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## API Endpoint Update: Enhanced Search Functionality with LIKE Operator (Since v7.10.x) This update introduces enhanced search capabilities to the API endpoint, allowing users to leverage the `LIKE` operator for more flexible and powerful data retrieval. The `LIKE` operator enables pattern-matching searches within string fields, supporting the use of wildcards for broader or more specific queries. This feature has been available since version 7.10.x of the API. ### Key Changes: - **Support for `LIKE` operator:** The API endpoint now accepts search queries that include the `LIKE` operator, enabling users to perform pattern-based searches on relevant fields. - **Wildcard characters:** The implementation supports the use of wildcard characters such as `%` (matches zero or more characters) and `_` (matches any single character) within `LIKE` queries, providing greater flexibility in defining search patterns. - **Improved search accuracy:** By utilizing the `LIKE` operator, users can refine their search queries to retrieve more relevant results, reducing the need for extensive filtering or post-processing. - **Enhanced documentation:** The API documentation has been updated to include detailed information on how to use the `LIKE` operator, including examples of various search patterns and their expected outcomes. ### Benefits: - **Increased search flexibility:** The addition of the `LIKE` operator empowers users to perform more complex and nuanced searches, accommodating a wider range of data retrieval needs. - **Enhanced user experience:** The improved search functionality simplifies the process of finding specific data within the API, leading to a more efficient and user-friendly experience. - **Greater data insights:** By enabling more precise searches, the `LIKE` operator facilitates the discovery of valuable insights and trends hidden within the data. ### Usage Examples: - To find all records where the `name` field starts with "John", use the following query: `name LIKE 'John%'` - To find all records where the `city` field contains the word "York", use the following query: `city LIKE '%York%'` - To find all records where the `product_code` field matches the pattern "ABC-123-X", where X can be any single character, use the following query: `product_code LIKE 'ABC-123_X'` This feature has been available since version 7.10.x of the API. We believe that this update will significantly enhance the capabilities of the API endpoint and provide users with a more powerful and versatile tool for data retrieval.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
API Endpoint Update: Enhanced Search Functionality with LIKE Operator (Since v7.10.x)
This update introduces enhanced search capabilities to the API endpoint, allowing users to leverage the
LIKEoperator for more flexible and powerful data retrieval. TheLIKEoperator enables pattern-matching searches within string fields, supporting the use of wildcards for broader or more specific queries. This feature has been available since version 7.10.x of the API.Key Changes:
LIKEoperator: The API endpoint now accepts search queries that include theLIKEoperator, enabling users to perform pattern-based searches on relevant fields.%(matches zero or more characters) and_(matches any single character) withinLIKEqueries, providing greater flexibility in defining search patterns.LIKEoperator, users can refine their search queries to retrieve more relevant results, reducing the need for extensive filtering or post-processing.LIKEoperator, including examples of various search patterns and their expected outcomes.Benefits:
LIKEoperator empowers users to perform more complex and nuanced searches, accommodating a wider range of data retrieval needs.LIKEoperator facilitates the discovery of valuable insights and trends hidden within the data.Usage Examples:
namefield starts with "John", use the following query:name LIKE 'John%'cityfield contains the word "York", use the following query:city LIKE '%York%'product_codefield matches the pattern "ABC-123-X", where X can be any single character, use the following query:product_code LIKE 'ABC-123_X'This feature has been available since version 7.10.x of the API. We believe that this update will significantly enhance the capabilities of the API endpoint and provide users with a more powerful and versatile tool for data retrieval.