Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dropwizard/dropwizard-cassandra
A convenience library for Apache Cassandra integration in a Dropwizard service.
https://github.com/dropwizard/dropwizard-cassandra
cassandra dropwizard
Last synced: 3 months ago
JSON representation
A convenience library for Apache Cassandra integration in a Dropwizard service.
- Host: GitHub
- URL: https://github.com/dropwizard/dropwizard-cassandra
- Owner: dropwizard
- License: apache-2.0
- Created: 2019-05-09T20:59:13.000Z (over 5 years ago)
- Default Branch: release/4.0.x
- Last Pushed: 2024-05-09T04:54:47.000Z (8 months ago)
- Last Synced: 2024-05-09T05:39:13.506Z (8 months ago)
- Topics: cassandra, dropwizard
- Language: Java
- Homepage:
- Size: 384 KB
- Stars: 4
- Watchers: 8
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dropwizard-cassandra
[](https://github.com/dropwizard/dropwizard-cassandra/actions/workflows/build.yml)
[](https://sonarcloud.io/dashboard?id=dropwizard_dropwizard-cassandra)
[](https://maven-badges.herokuapp.com/maven-central/io.dropwizard.modules/dropwizard-cassandra/)
Provides easy integration for Dropwizard applications with the Datastax Cassandra java driver..
This bundle comes with out-of-the-box support for:
* YAML-based configuration and built-in strongly typed configuration validation
* Cluster connection lifecycle management
* Cluster health checks
* Metrics integration for Cassandra driver stats using your applications `MetricRegistry`
## Future improvements
* Schema migrations functionality, similar to what flyway and liquibase offer for SQL databases.
## Dropwizard Version Support Matrix
| dropwizard-cassandra | Dropwizard v1.3.x | Dropwizard v2.0.x | Dropwizard v2.1.x | Dropwizard v3.0.x | Dropwizard v4.0.x |
|----------------------|--------------------|--------------------|--------------------|--------------------|--------------------|
| v1.3.x | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: |
| v1.4.x | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: |
| v2.0.x | :question: | :white_check_mark: | :white_check_mark: | :x: | :x: |
| v3.0.x | :x: | :x: | :x: | :white_check_mark: | :x: |
| v4.0.x | :x: | :x: | :x: | :x: | :white_check_mark: |
## Usage
Add dependency on library.
Maven:
```xml
io.dropwizard.modules
dropwizard-cassandra
4.0.0
```
Gradle:
```groovy
compile "io.dropwizard.modules:dropwizard-cassandra:4.0.0"
```
### Usage
##### Minimal
```
cassandra:
type: basic
contactPoints:
- host: localhost
port: 9041
loadBalancingPolicy:
type: default
localDataCenter: DC1
```
#### Comprehensive
```
cassandra:
type: basic
sessionName: name
sessionKeyspaceName: keyspace
requestOptionsFactory:
requestTimeout:5s
requestConsistency: local
requestPageSize: 12
requestSerialConsistency: local
requestDefaultIdempotence: true
metricsEnabled: true
protocolVersion:
type: default
version: V5
ssl:
type: default
cipherSuites: ["a", "b"]
hostValidation: true
keyStorePassword: keyStorePassword
keyStorePath: keyStorePath
trustStorePassword: trustStorePassword
trustStorePath: trustStorePath
compression: lz4
contactPoints:
- host: localhost
port: 9041
authProvider:
type: plain-text
username: admin
password: hunter2
retryPolicy:
type: default
speculativeExecutionPolicy:
type: constant
delay: 1s
maxSpeculativeExecutions: 3
poolingOptions:
maxRequestsPerConnection: 5
maxRemoteConnections: 10
maxLocalConnections: 20
heartbeatInterval: 5s
connectionConnectTimeout: 10s
addressTranslator:
type: ec2-multi-region
timestampGenerator:
type: atomic
reconnectionPolicyFactory:
type: exponential
baseConnectionDelay: 10s
maxReconnectionDelay: 30s
loadBalancingPolicy:
type: default
localDataCenter: local
dataCenterFailoverAllowLocalConsistencyLevels: true
slowAvoidance: true
dcFailoverMaxNodesPerRemoteDc: 2
cassandraOptions: # to add options which are not supported by default. Full list can be found at https://docs.datastax.com/en/developer/java-driver/4.11/manual/core/
- type: long
name: advanced.protocol.max-frame-length
value: 12
sessionMetrics:
- continuous-cql-requests
nodeMetrics:
- bytes-sent
schema:
agreementIntervalMilliseconds: 200
agreementTimeoutSeconds: 10
agreementWarnOnFailure: true
```
#### Note on Multi-Environment Configuration
If you have different contact points per deployment environment your application runs in, it may be easier to avoid having to define multiple YAML files per environment by inserting a placeholder in your YAML file that you then override in each environment (via whatever means you normally override config values, whether that's properties, environment variables, or whatever else), and then override that placeholder with a single entry JSON string defining all contact points, to avoid having to deal with YAML lists.
```
contactPoints: [${commaSeparatedContactPoints}]
commaSeparatedContactPoints = {"host": "host1", "port": "9142"}, {"host": "host2", "port": "9142"}
```
### Acknowledgements
This library was originally built to extend https://github.com/composable-systems/dropwizard-cassandra, but was forked due to some
needs that were unmet (for instance, being able to define different `CassandraFactory` implementations, if a modified client is used), and
due to lack of maintenance. Big thanks to @stuartgunter for his module, which inspired this one heavily, and for which this module borrows
a lot of ideas and code.