https://github.com/47degrees/sbt-embedded-cassandra

Simple plugin for starting an embedded Cassandra instance from SBT
https://github.com/47degrees/sbt-embedded-cassandra

Last synced: 6 months ago
JSON representation

Simple plugin for starting an embedded Cassandra instance from SBT

• Host: GitHub
• URL: https://github.com/47degrees/sbt-embedded-cassandra
• Owner: 47degrees
• License: apache-2.0
• Archived: true
• Created: 2017-10-10T12:55:35.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-23T08:34:15.000Z (almost 5 years ago)
• Last Synced: 2024-05-20T22:27:54.943Z (about 2 years ago)
• Language: Scala
• Size: 188 KB
• Stars: 9
• Watchers: 49
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
**THIS PROJECT IS DISCONTINUED — USE AT YOUR OWN RISK**

It has been a fun and great project but it's time for us to move on. Check out our recent work that we are doing with Scala and follow us on Github and Twitter for new and exciting open source projects. Thanks for your continuing support. If you wish to take on maintenance of this library please contact us through the issue tracker.

[![Maven Central](https://img.shields.io/badge/maven%20central-0.0.6-green.svg)](https://repo1.maven.org/maven2/com/47deg/sbt-embedded-cassandra_2.12_1.0) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/47degrees/sbt-embedded-cassandra/master/LICENSE) [![GitHub Issues](https://img.shields.io/github/issues/47degrees/sbt-embedded-cassandra.svg)](https://github.com/47degrees/sbt-embedded-cassandra/issues)

# sbt-embedded-cassandra

**sbt-embedded-cassandra** is an SBT plugin that allows to you to start an embedded Cassandra instance.

 

The goal of this project is to provide a way to add integration tests using Cassandra, supporting the latest versions and keeping the plugin simple as possible. 

## Usage

### Add to plugins.sbt

```scala

addSbtPlugin("com.47deg" % "sbt-embedded-cassandra" % "0.0.7")

```

### Start Cassandra from SBT

```bash

> embeddedCassandraStart

```

## Customization

* `embeddedCassandraWorkingDirectorySetting: File`: Output directory for Cassandra. `target/Cassandra` by default.

* `embeddedCassandraPropertiesSetting: Map[String, String]`: Properties to replace in the `cassandra.yml` template. Internally, the plugin will add a new property to the map named `workingDirectory` with the value of the previous setting.

* `embeddedCassandraConfigFileSetting: Option[File]`: Defines a custom template config file, `None` by default. When this setting is `None` it will use the following [template from the resources](embedded-cassandra-core/src/main/resources/basic-cassandra-conf.yml) 

* `embeddedCassandraCQLFileSetting: Option[File]`: Defines a CQL file with statements ended with `;` that will be executed after starting the service.

## Supported Cassandra version

Check the version of [`cassandra-all`](http://mvnrepository.com/artifact/org.apache.cassandra/cassandra-all) library currenly supported and take a look to the current [issues](https://github.com/47degrees/sbt-embedded-cassandra/issues) to stay informed about latest improvements and limitations. 

## sbt-embedded-cassandra in the wild not found

If you wish to add your library here please consider a PR to include it.

# Copyright

sbt-embedded-cassandra is designed and developed by 47 Degrees

Copyright (C) 2017-2018 47 Degrees.