Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dream11/vertx-aerospike-client
Non-Blocking Rxified Vertx aerospike client
https://github.com/dream11/vertx-aerospike-client
aerospike reactive rxjava2 vertx
Last synced: about 1 month ago
JSON representation
Non-Blocking Rxified Vertx aerospike client
- Host: GitHub
- URL: https://github.com/dream11/vertx-aerospike-client
- Owner: dream11
- License: mit
- Created: 2021-05-13T03:40:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T12:54:01.000Z (10 months ago)
- Last Synced: 2024-09-27T16:04:04.148Z (about 2 months ago)
- Topics: aerospike, reactive, rxjava2, vertx
- Language: Java
- Homepage: https://dream11.github.io/vertx-aerospike-client/
- Size: 66.4 KB
- Stars: 31
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- vertx-awesome - Aerospike - Asynchronous and non-blocking API to interact with Aerospike server. Uses [AerospikeClient's](https://github.com/aerospike/aerospike-client-java) async commands internally and handles the result on the Vert.x Context. (Database Clients)
README
# The Reactive Aerospike Client
[](https://github.com/dream11/vertx-aerospike-client/actions/workflows/ci.yml)
[](https://codecov.io/gh/dream11/vertx-aerospike-client)
## Overview
The Vert.x Aerospike client provides an asynchronous API to interact with aerospike server.
(Internally uses [AerospikeClient's](https://www.aerospike.com/docs/client/java/) async commands and handles the result on vertx-context)
## Usage
Add the following dependency to the *dependencies* section of your build descriptor:
- Maven (in your `pom.xml`):
```xml
io.d11
vertx-aerospike-client
LATEST
```
- Gradle (in your `build.gradle` file):
```
dependencies {
compile 'io.d11:vertx-aerospike-client:x.y.z'
}
```
## Connecting to Aerospike
```java
AerospikeConnectOptions connectOptions = new AerospikeConnectOptions()
.setHosts("my-host")
.setEventLoopSize(16);
// create a shared aerospike client across vertx instance
AerospikeClient client = AerospikeClient.create(vertx, connectOptions);
// create non shared aerospike client
AerospikeClient client = AerospikeClient.createNonShared(vertx, connectOptions);
```
## Configuration
Configuration options for `AerospikeConnectOptions`
| Key | Default | Type | Required | Description |
| --- | --- | --- | --- | --- |
| host | localhost | String | false | Aerospike server host |
| port | 3000 | Integer | false | Aerospike server port |
| eventLoopSize | 2*<#cores> | Integer | false | Number of EventLoop threads |
| maxCommandsInProcess | 100 | Integer | false | Maximum number of commands in process on each EventLoop thread |
| maxCommandsInQueue | 0 | Integer | false | Maximum number of commands in each EventLoop's queue |
| maxConnsPerNode | 2*<#cores>*100 | Integer | false | Maximum number of connections to one server node |
| maxConnectRetries | 2 | Integer | false | Maximum number of retries to connect |
| clientPolicy | | ClientPolicy | false | Aerospike client policy |
### Note on Configuration options:
* Do not set the clientPolicy.eventLoops. Use AerospikeConnectOptions to configure them.
## Running queries
```java
AerospikeClient client = AerospikeClient.create(vertx, connectOptions);
client
.rxGet(policy, key)
.map(record -> {
// Handle record
})...
```
Detailed documentation can be found [here](https://javadoc.io/doc/io.d11/vertx-aerospike-client/latest/index.html).
## Running the tests
To run the test suite:
```shell
mvn clean verify
```
The test suite runs a Docker container from image `aerospike/aerospike-server` using [TestContainers](https://www.testcontainers.org/)
by default.
To run the test suite on a container built from a different docker image:
```shell
mvn clean verify -Daerospike.image=
```