Skip to content

Commit ed71e0b

Browse files
committed
docs: enhance documentation
Signed-off-by: Otavio Santana <[email protected]>
1 parent a26811b commit ed71e0b

File tree

2 files changed

+38
-25
lines changed

2 files changed

+38
-25
lines changed

README.adoc

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1058,13 +1058,13 @@ Stream<Person> stream = template.select(Person.class , filter);
10581058

10591059
image::https://www.jnosql.org/img/logos/oracle.png[Oracle NoSQL Project,align="center"width=25%,height=25%]
10601060

1061-
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.
1061+
[Oracle NoSQL Database](https://www.oracle.com/database/nosql/technologies/nosql/) is a versatile multi-model database offering flexible data models for documents, graphs, and key-value pairs. It empowers developers to build high-performance applications using a user-friendly SQL-like query language or JavaScript extensions.
10621062

1063-
This API offers support for *Document* and *Key-Value* data types.
1063+
This API provides support for *Document* and *Key-Value* data types.
10641064

1065-
=== How To Install
1065+
=== Installation
10661066

1067-
You can use either the Maven or Gradle dependencies:
1067+
You can include Oracle NoSQL as a dependency using either Maven or Gradle:
10681068

10691069
[source,xml]
10701070
----
@@ -1077,41 +1077,54 @@ You can use either the Maven or Gradle dependencies:
10771077

10781078
=== Configuration
10791079

1080-
This API provides the ```OracleNoSQLConfigurations``` class to programmatically establish the credentials.
1081-
Please note that you can establish properties using the https://microprofile.io/microprofile-config/[MicroProfile Config] specification.
1080+
The API offers the `OracleNoSQLConfigurations` class to programmatically set up credentials. It also supports configuration via the [MicroProfile Config](https://microprofile.io/microprofile-config/) specification.
10821081

10831082
[cols="Oracle NoSQL Properties"]
10841083
|===
10851084
| Property Name | Description
10861085

1087-
| `jnosql.oracle.nosql.host` | Specifies the hostname or IP address of the Oracle NoSQL database server.
1086+
| `jnosql.oracle.nosql.host` | Hostname or IP address of the Oracle NoSQL database server.
10881087

1089-
| `jnosql.oracle.nosql.user` | Specifies the username used to authenticate with the Oracle NoSQL database.
1088+
| `jnosql.oracle.nosql.user` | Username for Oracle NoSQL database authentication.
10901089

1091-
| `jnosql.oracle.nosql.password` | Specifies the password used to authenticate with the Oracle NoSQL database.
1090+
| `jnosql.oracle.nosql.password` | Password for Oracle NoSQL database authentication.
10921091

1093-
| `jnosql.oracle.nosql.table.read.limit` | Specifies the desired throughput of read operations when creating a table using Eclipse JNoSQL.
1092+
| `jnosql.oracle.nosql.table.read.limit` | Desired throughput of read operations when creating tables with Eclipse JNoSQL.
10941093

1095-
| `jnosql.oracle.nosql.table.write.limit` | Specifies the desired throughput of write operations when creating a table using Eclipse JNoSQL.
1094+
| `jnosql.oracle.nosql.table.write.limit` | Desired throughput of write operations when creating tables with Eclipse JNoSQL.
10961095

1097-
| `jnosql.oracle.nosql.table.storage.gb` | Specifies the maximum storage, in gigabytes, to be consumed by a table created using Eclipse JNoSQL.
1096+
| `jnosql.oracle.nosql.table.storage.gb` | Maximum storage in gigabytes for tables created with Eclipse JNoSQL.
10981097

1099-
| `jnosql.oracle.nosql.table.wait.millis` | Specifies the total amount of time to wait, in milliseconds, when creating a table.
1098+
| `jnosql.oracle.nosql.table.wait.millis` | Total waiting time in milliseconds when creating a table.
11001099

1101-
| `jnosql.oracle.nosql.table.delay.millis` | Specifies the amount of time to wait, in milliseconds, between polling attempts when creating a table.
1100+
| `jnosql.oracle.nosql.table.delay.millis` | Time between polling attempts in milliseconds when creating a table.
11021101

1103-
| `jnosql.oracle.nosql.deployment` | Specifies the deployment type for Oracle NoSQL database.
1102+
| `jnosql.oracle.nosql.tenant.id` | Tenant ID for Oracle NoSQL database in a Cloud deployment.
11041103

1105-
| `jnosql.oracle.nosql.tenant.id` | Specifies the Oracle NoSQL database tenant ID for Cloud deployment.
1104+
| `jnosql.oracle.nosql.fingerprint` | Fingerprint for authentication with Oracle NoSQL database in a Cloud deployment.
11061105

1107-
| `jnosql.oracle.nosql.fingerprint` | Specifies the fingerprint for authentication with Oracle NoSQL database for Cloud deployment.
1106+
| `jnosql.oracle.nosql.private.key` | Private key for authentication with Oracle NoSQL database in a Cloud deployment.
11081107

1109-
| `jnosql.oracle.nosql.private.key` | Specifies the private key for authentication with Oracle NoSQL database for Cloud deployment.
1110-
|===
1108+
| `jnosql.oracle.nosql.compartment` | Compartment name in Oracle Cloud Infrastructure.
1109+
1110+
| `jnosql.oracle.nosql.namespace` | Namespace name in Oracle NoSQL on-premises.
1111+
1112+
| `jnosql.oracle.nosql.deployment` | Specifies the deployment type for Oracle NoSQL database. You can choose from the following options:
11111113

1114+
- `ON_PREMISES`: Represents an on-premises deployment where software solutions are deployed and managed within an organization's physical premises or data centers.
11121115

1116+
- `CLOUD_API_KEY`: Represents a cloud deployment using API key for authentication and authorization.
11131117

1114-
This is an example using Oracle NoSQL's Document API with MicroProfile Config.
1118+
- `CLOUD_INSTANCE_PRINCIPAL`: Represents a cloud deployment using instance principal for authentication and authorization.
1119+
1120+
- `CLOUD_RESOURCE_PRINCIPAL`: Represents a cloud deployment using resource principal for authentication and authorization.
1121+
1122+
- `CLOUD_INSTANCE_OBO_USER`: Represents a cloud deployment using instance principal for delegation with an OBO token.
1123+
|===
1124+
1125+
Below are examples using Oracle NoSQL's Document API and Key-Value API with MicroProfile Config.
1126+
1127+
**Document API Example:**
11151128

11161129
[source,properties]
11171130
----
@@ -1120,7 +1133,7 @@ jnosql.document.database=library
11201133
jnosql.oracle.nosql.host=http://localhost:8080
11211134
----
11221135

1123-
This is an example using Oracle NoSQL's Key-Value API with MicroProfile Config.
1136+
**Key-Value API Example:**
11241137

11251138
[source,properties]
11261139
----
@@ -1129,7 +1142,7 @@ jnosql.keyvalue.database=library
11291142
jnosql.oracle.nosql.host=http://localhost:8080
11301143
----
11311144

1132-
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`.
1145+
Although these are the default configuration settings, you have the option to configure them programmatically. Create a class that implements `Supplier<OracleNoSQLDocumentManager>`, annotate it with `@Alternative`, and set the priority using `@Priority`.
11331146

11341147
[source,java]
11351148
----
@@ -1151,7 +1164,7 @@ public class ManagerSupplier implements Supplier<OracleNoSQLDocumentManager> {
11511164

11521165
=== Repository
11531166

1154-
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:
1167+
The `OracleNoSQLRepository` interface extends the Repository interface and allows executing SQL queries using the `@SQL` annotation. You can also combine it with the `@Param` annotation for parameterized SQL queries:
11551168

11561169
[source,java]
11571170
----
@@ -1169,7 +1182,7 @@ interface PersonRepository extends OracleNoSQLRepository<Person, String> {
11691182

11701183
=== Template
11711184

1172-
The ```OracleNoSQLTemplate``` interface is a specialization of the ```DocumentTemplate``` interface that allows using synchronous SQL operation.
1185+
The `OracleNoSQLTemplate` interface, an extension of the `DocumentTemplate`, enables synchronous SQL operations.
11731186

11741187
[source,java]
11751188
----

jnosql-nosql-oracle/src/main/java/org/eclipse/jnosql/databases/oracle/communication/OracleNoSQLConfigurations.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ public enum OracleNoSQLConfigurations implements Supplier<String> {
116116
/**
117117
* Define the compartment name in Oracle NoSQL on-premise.
118118
*/
119-
NAMESPACE("jnosql.oracle.nosql.compartment");
119+
NAMESPACE("jnosql.oracle.nosql.namespace");
120120

121121

122122
private final String configuration;

0 commit comments

Comments
 (0)