zymap/oxia-java

A Java client library for Oxia

Oxia Java

Overview

This project comprises JDK language compatible modules for the Oxia service. It provides the following capabilities:

• Client for the Oxia service
• OpenTelemetry Metrics integration with the client
• Testcontainer for integration testing with a local Oxia service
• Performance Test Tool for performance testing with an Oxia service.

Build

Requirements:

• JDK 17
• Maven 3.8.6+

Common build actions:

Action	Command
Full build and test	mvn clean verify
Skip tests	mvn clean verify -DskipTests
Skip Jacoco test coverage check	mvn clean verify -Djacoco.skip
Skip Spotless formatting check	mvn clean verify -Dspotless.check.skip
Format code	mvn spotless:apply
Generate license headers	mvn license:format

Release

1. Go to the release workflow
2. Click the gray Run workflow button on the righthand side
3. Choose:
   • use workflow from: branch master
   • Git repository: streamnative/oxia-java
   • JDK version: 17
4. Click the green Run workflow button

Questions

• Q: Why do we publish it in streamnative-ci?
  A: streamnative-ci repo has some secrets and scripts to use streamnative bot account
• Q: What can I do if want to put the release nar package to pulsar-cloud image?
  A: Ask the EE team to add the release version in the images/dependencies.json file in the streamnative-ci repo