Skip to content

Commit 4e107a5

Browse files
committed
docs: create documentation to oracle nosql configurations
Signed-off-by: Otavio Santana <[email protected]>
1 parent 8ef6844 commit 4e107a5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,20 @@ public enum OracleNoSQLConfigurations implements Supplier<String> {
7676
/**
7777
* Specifies the deployment type for Oracle NoSQL database.
7878
* Default value: {@link DeploymentType#ON_PREMISES}
79+
* <p>
80+
* When ON_PREMISES is selected for deployment:
81+
* - Credentials required: USER (username) and HOST (hostname or IP address).
82+
* - Connection is established without authentication if USER and HOST are not provided.
83+
* </p>
84+
* <p>
85+
* When CLOUD is selected for deployment:
86+
* - Credentials required: PRIVATE_KEY (private key file path), FINGERPRINT (fingerprint of the public key),
87+
* TENANT (Oracle Cloud tenant ID), USER (Oracle Cloud username), and PASSWORD (Oracle Cloud password).
88+
* - If any of these credentials are not provided, the configuration will be read from a configuration file.
89+
* For more information, see:
90+
* <a href="https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkgettingstarted.htm#Configur">
91+
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkgettingstarted.htm#Configur</a>
92+
* </p>
7993
*/
8094
DEPLOYMENT("jnosql.oracle.nosql.deployment"),
8195
/**

0 commit comments

Comments
 (0)