Skip to content

Commit 9ca411f

Browse files
authored
update README.md (#64)
1 parent be576e2 commit 9ca411f

File tree

1 file changed

+35
-21
lines changed

1 file changed

+35
-21
lines changed

README.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The project consists of following modules
3333
- kvstore-IT (All tests for kvstore, and all TestBase/Util classes, depends
3434
on kvstore.jar)
3535
- kvclient-IT (kvclient tests, depends on kvclient and kvstore-IT for compilation)
36-
- kvquery-IT (QTF tests, depends on kvstore, kvstore-IT and com.oracle.nosql.common:qtf)
36+
- kvquery-IT (QTF tests, depends on kvstore, kvstore-IT)
3737
- kvdatacheck-IT (Datacheck unit test, depends on kvstore and kvstore-IT)
3838
- kvtif-IT (Text Index Feeder tests, depends on kvstore-IT)
3939
- coverage-report (Run jacoco coverage report)
@@ -60,12 +60,13 @@ To build all KV artifacts and copy them with dependencies to a single folder:
6060
mvn [clean] package
6161
```
6262

63-
> [!NOTE] You can find the folder under `packaging/target/`. Above command will
64-
build and package all modules, but it will skip tests execution by default.
63+
> [!NOTE]
64+
> You can find the folder under `packaging/target/`. Above command will build
65+
> and package all modules, but it will skip tests execution by default.
6566
6667
## Running Tests
6768

68-
### Running tests for all modules
69+
### Running tests for all modules in async mode
6970

7071
```bash
7172
mvn -fn -PIT verify
@@ -90,21 +91,24 @@ mvn -P it.kvdatacheck verify
9091
mvn -P it.kvtif verify
9192
```
9293

93-
> [!NOTE] It is possible to combine the test profiles.
94+
> [!TIP]
95+
> It is possible to combine the test profiles.
9496
> If you need to run both kvclient and kvquery tests, use:
9597
> `mvn -P it.kvclient,it.kvquery verify`
9698
9799
## Documentation
98100

99-
General documentation about the Oracle NoSQL Database and the Oracle NoSQL Database Cloud Service can be found in these locations:
101+
General documentation about the Oracle NoSQL Database and the Oracle NoSQL
102+
Database Cloud Service can be found in these locations:
100103

101-
* [Oracle NoSQL Database Cloud Service](https://docs.oracle.com/en/cloud/paas/nosql-cloud/)
102-
* [Oracle NoSQL Database On Premise](https://docs.oracle.com/en/database/other-databases/nosql-database/)
104+
- [Oracle NoSQL Database Cloud Service](https://docs.oracle.com/en/cloud/paas/nosql-cloud/)
105+
- [Oracle NoSQL Database On Premise](https://docs.oracle.com/en/database/other-databases/nosql-database/)
103106

104107
## Oracle NoSQL SDK
105108

106-
The Oracle NoSQL SDK drivers provide interfaces, documentation, and examples to help develop applications that connect to
107-
the Oracle NoSQL Database Cloud Service or Oracle NoSQL Database.
109+
The Oracle NoSQL SDK drivers provide interfaces, documentation, and examples
110+
to help develop applications that connect to the Oracle NoSQL Database Cloud
111+
Service or Oracle NoSQL Database.
108112

109113
- [Oracle NoSQL SDK for Java](https://github.com/oracle/nosql-java-sdk)
110114
- [Node.js for Oracle NoSQL Database](https://github.com/oracle/nosql-node-sdk)
@@ -117,10 +121,14 @@ the Oracle NoSQL Database Cloud Service or Oracle NoSQL Database.
117121
## Oracle NoSQL Plugins
118122

119123
Oracle NoSQL Database Plugins enhances your experience of building an application:
120-
- [Oracle NoSQL Database IntelliJ Plugin](https://github.com/oracle/nosql-intellij-plugin). The Intellij plugins is hosted in GitHub.
121-
- [Oracle NoSQL Database Visual Studio Plugin](https://marketplace.visualstudio.com/items?itemName=Oracle.nosql-vscode). The Visual Studio Marketplace hosts a Visual Studios plugin for NoSQL
124+
125+
- [Oracle NoSQL Database IntelliJ Plugin](https://github.com/oracle/nosql-intellij-plugin).
126+
The Intellij plugins is hosted in GitHub.
127+
- [Oracle NoSQL Database Visual Studio Plugin](https://marketplace.visualstudio.com/items?itemName=Oracle.nosql-vscode).
128+
The Visual Studio Marketplace hosts a Visual Studios plugin for NoSQL
122129

123130
You can use Oracle NoSQL Database plugins to:
131+
124132
- View the tables in a well-defined tree structure with Table Explorer.
125133
- View information on columns, indexes, primary key(s), and shard key(s) for a table.
126134
- Create tables using form-based schema entry or supply DDL statements.
@@ -130,23 +138,29 @@ You can use Oracle NoSQL Database plugins to:
130138
- and much more
131139

132140
## Container image on GitHub repository
133-
This [GitHub repository](https://github.com/oracle/docker-images/tree/main/NoSQL) contains Dockerfiles, documentation and samples to build container images for Oracle NoSQL.
134141

135-
**Highlights**
136-
137-
1. This container image can be used by application developers who need to develop and unit test their Oracle NoSQL Database applications.
138-
2. Behind the scene, we are using KVlite, and I added HTTP Proxy support
139-
3. This container image was built on open-source NoSQL and published in GitHub Container Registry.
140-
4. Users can clone this repository and build their image or pull the image directly from the GitHub Container Registry
141-
5. There are 2 container images available, one using a secure configuration and one using a non-secure configuration
142+
This [GitHub repository](https://github.com/oracle/docker-images/tree/main/NoSQL)
143+
contains Dockerfiles, documentation and samples to build container images for
144+
Oracle NoSQL.
142145

146+
### Highlights
143147

148+
1. This container image can be used by application developers who need to
149+
develop and unit test their Oracle NoSQL Database applications.
150+
2. Behind the scene, we are using KVlite, and I added HTTP Proxy support
151+
3. This container image was built on open-source NoSQL and published in GitHub
152+
Container Registry.
153+
4. Users can clone this repository and build their image or pull the image
154+
directly from the GitHub Container Registry
155+
5. There are 2 container images available, one using a secure configuration
156+
and one using a non-secure configuration
144157

145158
## Help
146159

147160
There are a few ways to get help or report issues:
148161

149-
- Open an issue in the [Issues](https://github.com/oracle/nosql/issues) page or start a [Discussion](https://github.com/oracle/nosql/discussions).
162+
- Open an issue in the [Issues](https://github.com/oracle/nosql/issues) page
163+
or start a [Discussion](https://github.com/oracle/nosql/discussions).
150164
- Post your question on the [Oracle NoSQL Database Community](https://forums.oracle.com/ords/apexds/domain/dev-community/category/nosql_database?tags=nosql-database-discussions).
151165
- Please send email to: [NoSQL help mailbox](mailto:nosql_mb@oracle.com)
152166

0 commit comments

Comments
 (0)