Phantom

Schema safe, type-safe, reactive Scala driver for Cassandra/Datastax Enterprise

Programming language: Scala

License: Apache License 2.0

Tags: Database    

Latest version: v2.59.0

README

phantom

CI	Test coverage(%)	Code quality	Stable version	ScalaDoc	Chat	Open issues	Average issue resolution time

Reactive type-safe Scala driver for Apache Cassandra/Datastax Enterprise

To stay up-to-date with our latest releases and news, follow us on Twitter: @outworkers.

If you use phantom, please consider adding your company to our list of adopters. Phantom is and will always be open source, but the more adopters our projects have, the more people from our company will actively work to make them better.

Migrating to phantom 2.14.0 and using execution backends.

Please refer to the new docs on query execution to understand the breaking changes in phantom 2.14.0. They will affect all users of phantom, as we further optimise the internals for better performance and to gently prepare 3.0.

Details [here](docs_bkp/querying/execution.md). In short, query generation is no longer coupled with query execution within the framework. That means phantom can natively support different kind of concurrency frameworks in parallel, using different sub-modules. That includes Monix, Twitter Util, Scala Futures, and a few others, some of which only available via phantom-pro.

import com.outworkers.phantom.dsl._ is now required in more places than before. The future method is no longer implementation by query classes, but rather added via implicit augmentation by QueryContext. The return type of the future method is now dependent on which QueryContext you use, so that's why importing is required, without it the necessary implicits will not be in scope by default, or similarly, in some places new implicits are required to specify things specific to an execution backend.

Scala 2.13 support

As of phantom 2.50.0, Scala 2.13 support is officially available, however all support has been dropped for Scala 2.10. To use Scala 2.10 with phantom, please use a version of phantom earlier than 2.5.0. No support or ongoing maintenance will be offered for 2.10 artifacts, as the codebase has undergone significant change to support newer versions, and the various libraries we depend on no longer support this.

Migrating to phantom 2.x.x series

The new series of phantom introduces several key backwards incompatible changes with previous versions. This was done to obtain massive performance boosts and to thoroughly improve user experience with phantom.

Read the [MIGRATION GUIDE](docs_bkp/migrate.md) for more information on how to upgrade.

Available modules

This is a table of the available modules for the various Scala versions. Not all modules are available for all versions just yet, and this is because certain dependencies have yet to be published for Scala 2.12.

Phantom OSS

Module name	Scala 2.11.x	Scala 2.12.x	Scala 2.13.x
phantom-connectors	yes	yes	yes
phantom-dsl	yes	yes	yes
phantom-jdk8	yes	yes	yes
phantom-sbt	no	yes	no
phantom-example	yes	yes	yes
phantom-thrift	yes	yes	yes
phantom-finagle	yes	yes	yes
phantom-streams	yes	yes	no

Phantom Pro subscription edition

Modules marked with "x" are still in beta or pre-publishing mode.

Module name	Scala 2.11.x	Scala 2.12.x	Scala 2.13.x	Release date
phantom-dse	yes	yes	yes	Released
phantom-udt	yes	yes	yes	Released
phantom-autotables	yes	yes	yes	Released
phantom-monix	yes	yes	yes	Released
phantom-docker	x	x	x	Released
phantom-migrations	yes	yes	yes	Released
phantom-graph	x	x	x	April 2020
phantom-spark	x	x	x	July 2020
phantom-solr	x	x	x	July 2020
phantom-native	x	x	x	December 2020
phantom-java-dsl	x	x	x	December 2020

Using phantom

Scala 2.11, 2.12 and 2.13 releases

We publish phantom in 2 formats, stable releases and bleeding edge.

• The stable release is always available on Maven Central and will be indicated by the badge at the top of this readme. The Maven Central badge is pointing at the latest version

• Intermediary releases are available through our Bintray repo available at Resolver.bintrayRepo("outworkers", "oss-releases") or https://dl.bintray.com/outworkers/oss-releases/. The latest version available on our Bintray repository is indicated by the Bintray badge at the top of this readme.

How phantom compares

To compare phantom to similar tools in the Scala/Cassandra category, you can read more [here](docs_bkp/comparison.md).

Latest versions

The latest versions are available here. The badges automatically update when a new version is released.

• Latest stable version: (Maven Central)
• Bleeding edge: (OSS releases on Bintray)

Tutorials on phantom and Cassandra

For ease of use and far better management of documentation, we have decided to export the README.md to a compiled documentation page, now available here.

The following are the current resources available for learning phantom, outside of tests which are very useful in highlighting all the possible features in phantom and how to use them.

This is a list of resources to help you learn phantom and Cassandra:

• [ ] [Quickstart](docs_bkp/quickstart.md)
• [ ] [Official documentation](docs_bkp/README.md)
• [ ] Datastax Introduction to Cassandra.
• [ ] The official Scala API docs for phantom
• [ ] The main Wiki
• [ ] The StackOverflow phantom-dsl tag, which we always monitor!
• [ ] Anything tagged phantom on our blog is a phantom tutorial: phantom tutorials
• [ ] A series on Cassandra: Getting rid of the SQL mentality
• [ ] A series on Cassandra: Indexes and keys
• [ ] A series on Cassandra: Advanced features
• [ ] A series on phantom: Getting started with phantom
• [ ] The Play! Phantom Activator template
• [ ] Thiago's Cassandra + Phantom demo repository

Issues and questions

back to top

We love Cassandra to bits and use it in every bit of our stack. phantom makes it super trivial for Scala users to embrace Cassandra.

Cassandra is highly scalable and it is by far the most powerful database technology available, open source or otherwise.

Phantom is built on top of the Datastax Java Driver, which handles Cassandra connectivity and raw query execution.

We are very happy to help implement missing features in phantom, answer questions about phantom, and occasionally help you out with Cassandra questions! Please use GitHub for any issues or bug reports.

Adopters

Here are a few of the biggest phantom adopters, though the full list is far more comprehensive.

License and copyright

Phantom is distributed under the Apache V2 License.

• Outworkers, Limited is the copyright holder.

• You can use phantom in commercial products or otherwise.

• We strongly appreciate and encourage contributions.

• All paid for features are published and sold separately as phantom-pro, everything that is currently available for free will remain so forever.

If you would like our help with any new content or initiatives, we'd love to hear about it!

Contributors

back to top

Phantom was developed at outworkers as an in-house project. All Cassandra integration at outworkers goes through phantom, and nowadays it's safe to say most Scala/Cassandra users in the world rely on phantom.

• Flavian Alexandru (@alexflav23) - maintainer
• Bartosz Jankiewicz (@bjankie1)
• Benjamin Edwards (@benjumanji)
• Kevin Wright (@kevinwright)
• Eugene Zhulenev (@ezhulenev)
• Michal Matloka (@mmatloka)
• Thiago Pereira (@thiagoandrade6)
• Juan José Vázquez (@juanjovazquez)
• Viktor Taranenko (@viktortnk)
• Stephen Samuel (@sksamuel)
• Evan Chan (@evanfchan)
• Jens Halm (@jenshalm)
• Donovan Levinson (@levinson)

Copyright

back to top

Special thanks to Viktor Taranenko from WhiskLabs, who gave us the original idea, and special thanks to Miles Sabin and team behind Shapeless, where we shamelessly stole all the good patterns from.

Copyright © 2013 - 2017 outworkers.

Contributing to phantom

back to top

Contributions are most welcome! Use GitHub for issues and pull requests and we will happily help out in any way we can!