Merge pull request #262 from eclipse/create-oracle-nosql

Create Oracle NoSQL database support

Author: otaviojava

CHANGELOG.adoc

@@ -12,6 +12,10 @@ and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Version
 
 - Update Jakarta Data to version 1.0.0-M3
 
+=== Added
+
+- Include support to Oracle NoSQL database
+
 == [1.0.4] - 2023-12-19
 
 === Fixed

README.adoc

@@ -1054,6 +1054,132 @@ Bson filter = eq("name", "Poliana");
 Stream<Person> stream = template.select(Person.class , filter);
 ----
 
+== Oracle NoSQL
+
+image::https://www.jnosql.org/img/logos/oracle.png[Oracle NoSQL Project,align="center"width=25%,height=25%]
+
+https://www.oracle.com/database/nosql/technologies/nosql/[Oracle NoSQL Database] is a native multi-model database that provides flexible data models for documents, graphs, and key values. You can develop high-performance applications using a user-friendly SQL-like query language or JavaScript extensions.
+
+This API offers support for *Document* and *Key-Value* data types.
+
+=== How To Install
+
+You can use either the Maven or Gradle dependencies:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.eclipse.jnosql.databases</groupId>
+  <artifactId>jnosql-oracle-nosql</artifactId>
+  <version>1.0.5-SNAPSHOT</version>
+</dependency>
+----
+
+=== Configuration
+
+This API provides the ```OracleNoSQLConfigurations``` class to programmatically establish the credentials.
+Please note that you can establish properties using the https://microprofile.io/microprofile-config/[MicroProfile Config] specification.
+
+[cols="Oracle NoSQL Properties"]
+|===
+| Property Name | Description
+
+| `jnosql.oracle.nosql.host` | Specifies the hostname or IP address of the Oracle NoSQL database server.
+
+| `jnosql.oracle.nosql.user` | Specifies the username used to authenticate with the Oracle NoSQL database.
+
+| `jnosql.oracle.nosql.password` | Specifies the password used to authenticate with the Oracle NoSQL database.
+
+| `jnosql.oracle.nosql.table.read.limit` | Specifies the desired throughput of read operations when creating a table using Eclipse JNoSQL.
+
+| `jnosql.oracle.nosql.table.write.limit` | Specifies the desired throughput of write operations when creating a table using Eclipse JNoSQL.
+
+| `jnosql.oracle.nosql.table.storage.gb` | Specifies the maximum storage, in gigabytes, to be consumed by a table created using Eclipse JNoSQL.
+
+| `jnosql.oracle.nosql.table.wait.millis` | Specifies the total amount of time to wait, in milliseconds, when creating a table.
+
+| `jnosql.oracle.nosql.table.delay.millis` | Specifies the amount of time to wait, in milliseconds, between polling attempts when creating a table.
+
+| `jnosql.oracle.nosql.deployment` | Specifies the deployment type for Oracle NoSQL database.
+
+| `jnosql.oracle.nosql.tenant.id` | Specifies the Oracle NoSQL database tenant ID for Cloud deployment.
+
+| `jnosql.oracle.nosql.fingerprint` | Specifies the fingerprint for authentication with Oracle NoSQL database for Cloud deployment.
+
+| `jnosql.oracle.nosql.private.key` | Specifies the private key for authentication with Oracle NoSQL database for Cloud deployment.
+|===
+
+
+
+This is an example using Oracle NoSQL's Document API with MicroProfile Config.
+
+[source,properties]
+----
+jnosql.document.provider=org.eclipse.jnosql.databases.oracle.communication.OracleDocumentConfiguration
+jnosql.document.database=library
+jnosql.oracle.nosql.host=http://localhost:8080
+----
+
+This is an example using Oracle NoSQL's Key-Value API with MicroProfile Config.
+
+[source,properties]
+----
+jnosql.keyvalue.provider=org.eclipse.jnosql.databases.oracle.communication.OracleNoSQLKeyValueConfiguration
+jnosql.keyvalue.database=library
+jnosql.oracle.nosql.host=http://localhost:8080
+----
+
+The config settings are the default behavior; nevertheless, there is an option to do it programmatically. Create a class that implements the `Supplier<ArangoDBDocumentManager>` and then defines it as an `@Alternative` and the `Priority`.
+
+[source,java]
+----
+@ApplicationScoped
+@Alternative
+@Priority(Interceptor.Priority.APPLICATION)
+public class ManagerSupplier implements Supplier<OracleNoSQLDocumentManager> {
+
+    @Produces
+    public OracleNoSQLDocumentManager get() {
+        Settings settings = Settings.builder().put("credential", "value").build();
+        OracleDocumentConfiguration configuration = new OracleDocumentConfiguration();
+        OracleDocumentManagerFactory factory = configuration.apply(settings);
+        return factory.apply("database");
+    }
+}
+----
+
+
+=== Repository
+
+The ```OracleNoSQLRepository``` interface is an extension of the Repository interface that allows execution of SQL via the ```@SQL``` annotation. Also, it's possible to combine with ```@Param``` annotation to execute parameterized SQL queries:
+
+[source,java]
+----
+@Repository
+interface PersonRepository extends OracleNoSQLRepository<Person, String> {
+
+    @SQL("select * from Person")
+    List<Person> findAll();
+
+    @SQL("select * from Person where name = ?")
+    List<Person> findByName(@Param("") String name);
+}
+----
+
+
+=== Template
+
+The ```OracleNoSQLTemplate``` interface is a specialization of the ```DocumentTemplate``` interface that allows using synchronous SQL operation.
+
+[source,java]
+----
+@Inject
+private OracleNoSQLTemplate template;
+...
+List<Person> people = template.sql("select * from people where people.content.name =?", "Ada");
+----
+
+
 == OrientDB
 
 image::https://jnosql.github.io/img/logos/orientdb.png[Orient Project,align="center" width=25%,height=25%]

jnosql-arangodb/src/test/java/org/eclipse/jnosql/databases/arangodb/mapping/ArangoDBExtensionTest.java

@@ -41,7 +41,7 @@ public class ArangoDBExtensionTest {
     private PersonRepository repository;
 
     @Test
-    public void shouldSaveOrientDB() {
+    public void shouldSave() {
         Assertions.assertNotNull(repository);
     }
 }

jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/DefaultCouchbaseDocumentManager.java

@@ -174,7 +174,7 @@ public Stream<DocumentEntity> select(final DocumentQuery query) throws NullPoint
 
             if (!n1QLQuery.hasOnlyIds()) {
                 QueryResult result;
-                if (n1QLQuery.hasParameter()) {
+                if (n1QLQuery.isParameterEmpty()) {
                     result = cluster.query(n1QLQuery.query());
                 } else {
                     result = cluster.query(n1QLQuery.query(), QueryOptions

jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/N1QLBuilder.java

@@ -157,7 +157,7 @@ private void appendCondition(StringBuilder n1ql, JsonObject params,
             condition(documentCondition, query, params, ids);
             if(index == 0){
                  n1ql.append(" ").append(query);
-            } else {
+            } else if(!query.isEmpty()) {
                  n1ql.append(condition).append(query);
             }
             index++;

jnosql-couchbase/src/main/java/org/eclipse/jnosql/databases/couchbase/communication/N1QLQuery.java

@@ -26,12 +26,12 @@ public List<String> ids() {
         return Collections.unmodifiableList(ids);
     }
 
-    public boolean hasParameter() {
+    public boolean isParameterEmpty() {
         return this.params.isEmpty();
     }
 
     public boolean hasOnlyIds() {
-        return hasIds() && hasParameter();
+        return hasIds() && isParameterEmpty();
     }
 
     public boolean hasIds() {

jnosql-memcached/src/main/java/org/eclipse/jnosql/databases/memcached/communication/MemcachedBucketManagerFactory.java

@@ -42,22 +42,22 @@ public void close() {
     }
 
     @Override
-    public Map getMap(String bucketName, Class keyValue, Class valueValue) {
-        throw new UnsupportedOperationException("This method is not supported");
+    public <K, V> Map<K, V> getMap(String bucketName, Class<K> keyValue, Class<V> valueValue) {
+        throw new UnsupportedOperationException("Memcached does not support Map");
     }
 
     @Override
-    public Queue getQueue(String bucketName, Class clazz) {
-        throw new UnsupportedOperationException("This method is not supported");
+    public <T> Queue<T> getQueue(String bucketName, Class<T> type) {
+        throw new UnsupportedOperationException("Memcached does not support queue");
     }
 
     @Override
-    public Set getSet(String bucketName, Class clazz) {
-        throw new UnsupportedOperationException("This method is not supported");
+    public <T>  Set<T>  getSet(String bucketName, Class<T>  type) {
+        throw new UnsupportedOperationException("Memcached does not support set");
     }
 
     @Override
-    public List getList(String bucketName, Class clazz) {
+    public <T> List<T>  getList(String bucketName, Class<T> type) {
         throw new UnsupportedOperationException("This method is not supported");
     }
 }

jnosql-mongodb/src/test/java/org/eclipse/jnosql/databases/mongodb/communication/MongoDBDocumentConfigurationTest.java

@@ -39,7 +39,7 @@ void shouldCreateDocumentManagerFactoryByMap() {
 
 
     @Test
-    void shouldReturnErrorWhendSettingsIsNull() {
+    void shouldReturnErrorWhenSettingsIsNull() {
         DocumentConfiguration configuration = new MongoDBDocumentConfiguration();
         assertThrows(NullPointerException.class, () -> configuration.apply(null));
     }

jnosql-nosql-oracle/pom.xml

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~  Copyright (c) 2022 Contributors to the Eclipse Foundation
+  ~   All rights reserved. This program and the accompanying materials
+  ~   are made available under the terms of the Eclipse Public License v1.0
+  ~   and Apache License v2.0 which accompanies this distribution.
+  ~   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
+  ~   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
+  ~
+  ~   You may elect to redistribute this code under either of these licenses.
+  ~
+  ~   Contributors:
+  ~
+  ~   Otavio Santana
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.eclipse.jnosql.databases</groupId>
+        <artifactId>jnosql-databases-parent</artifactId>
+        <version>1.0.5-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>jnosql-oracle-nosql</artifactId>
+    <description>The Eclipse JNoSQL layer implementation Oracle NoSQL</description>
+    <dependencies>
+        <dependency>
+            <groupId>org.eclipse.jnosql.communication</groupId>
+            <artifactId>jnosql-communication-key-value</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.jnosql.mapping</groupId>
+            <artifactId>jnosql-mapping-key-value</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.jnosql.communication</groupId>
+            <artifactId>jnosql-communication-document</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.jnosql.mapping</groupId>
+            <artifactId>jnosql-mapping-document</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.oracle.nosql.sdk</groupId>
+            <artifactId>nosqldriver</artifactId>
+            <version>5.4.14</version>
+        </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>jnosql-database-commons</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+
+</project>