Skip to content

Commit

Permalink
docs: update query documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
otaviojava committed Apr 29, 2023
1 parent 2fc2915 commit de83479
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion spec/src/main/asciidoc/chapters/api/query.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,13 @@

==== Querying by Text with the Mapping API

Jakarta NoSQL provides query by text that you can execute. Furthermore, there is the option to explore a prepared statement query. Jakarta NoSQL does not provide any query support. Thus, any vendor might have diverse queries.
Query by text is a powerful feature in the Jakarta NoSQL API that allows Java developers to perform CRUD operations on NoSQL databases using a text-based query language. Although the syntax may vary between different NoSQL vendors, the Jakarta NoSQL API provides a standard set of interfaces and methods that simplify performing CRUD operations through text queries.

Apart from supporting static queries, the Jakarta NoSQL API offers an API for dynamic queries. This feature enables developers to bind parameters to a query at runtime, making the queries more flexible and adaptable to changing requirements.

It is important to note that the Jakarta NoSQL specification does not specify the query syntax. Instead, each NoSQL vendor can define their query syntax and return types, allowing them to tailor their syntax to their platform's unique features and capabilities. This flexibility enables vendors to provide robust and efficient query capabilities that meet the needs of their users.

Overall, the Jakarta NoSQL API's support for query by text provides Java developers with a flexible and intuitive way to perform CRUD operations on NoSQL databases. Although the query syntax is vendor-specific, the common interfaces and methods provided by the Jakarta NoSQL API make it easy to work with any NoSQL database that supports queries by text. The ability to dynamically bind parameters to a query at runtime adds extra flexibility, allowing developers to adapt their queries to changing requirements.

===== Key-Value Database Types

Expand Down

0 comments on commit de83479

Please sign in to comment.