Reactive type-safe Scala driver for SQL databases
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
docs
morpheus-dsl/src Feature/name upgrade (#16) Mar 15, 2017
morpheus-mysql/src
morpheus-testkit/src/main/scala/com/outworkers/morpheus/testkit
project Upgrading published versions (#17) Mar 20, 2017
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE.txt
README.md
build.sbt
changelog.md
morpheus.graffle Added basic tests and DB specific implementation. Feb 25, 2015
scalastyle-config.xml
sonar-project.properties

README.md

morpheus Build Status Coverage Status Bintray

==============================================================

morpheus

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

Named after the Greek God of Dreams, morpheus is a reactive type-safe Scala DSL for MySQL, Postgres, MSSQL, MariaDB, Oracle and Sybase. "Morpheus" morphs into the SQL implementation of your desire, so instead of implementing a Slick like leaking abstraction, we have instead opted to implement an entire engine for each of the mainstream SQL databases and unify them to offer a consistent fluent DSL experience.

With the single switch of a dependency and an import, morpheus will perform a full feature swap from MySQL to OracleSQL for example. It doesn't have a query compiler, instead it entirely mimics the functionality the database has, so if a method exists in OracleSQL but not in MySQL, you will get a compile time error if you attempt to use it.

There are no renames, no new things to learn, no new features or abstractions like in Slick, just dear old SQL as you've grown to love i or hate it.

Using morpheus

The current version is: val morpheusVersion = Bintray .

Morpheus is actively and avidly developed. It is not yet production ready, so trial at your own risk.

  • 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 managed Bintray repository available at Resolver.bintrayRepo("outworkers", "oss-releases"). The latest version available on our Bintray repository is indicated by the Bintray badge at the top of this readme.

Table of contents

  1. Design philosophy
  2. Integrating Morpheus
  3. Supported databases and documentation

Design philosophy

You're probably wondering how Morpheus fairs compared to the more established players in the Scala SQL market and why we set out to do something new in the first place. To sum it up, we believe Slick is an excellent tool but we do not believe you should learn about our abstractions to get things done. A DSL should auto-magically encode the same syntax and the logic as the tool it's designed for.

Instead of learning about primitives and rules we thought of to abstract away discrepancies between the various SQL implementations, Morpheus features a unique approach, what we call the auto-magical flip. Although at this point in time only MySQL is supported, Morpheus is designed to give you an "all-you-can-eat" buffet through a single import.

As follows: import com.outworkers.morpheus.mysql._.

And done, you can now define tables, query and so on. Say you have something like this:

Recipes.select.distinctRow.where(_.name eqs "test"). DISTINCTROW doesn't exist in the Postgres SELECT statement syntax, but it's a standard thing as far as MySQL is concerned.

Here's how Morpheus operates:

If you change the top level import to: com.outworkers.morpheus.postgres._ and you try to compile the same distinctRow query. But there will be none. The method will simply not exist. Morpheus has now auto-magically performed a full feature swap, changed communication protocol and all underlying settings, and all you get now is Postgres features.

How? Quite a lot of fun magic under the hood, have a look throughout our decently documented codebase for more information. The beauty of it is that you don't have to care. Slick makes it easy to move from one SQL database to the other with less code changes, but if you're well set on a database you already know and love, it may be counter productive to have to learn about a framework when you could use Morpheus and all you need is IDE auto-completes to get lightning fast development productivity.

Oh, and did we mention it's entirely asynchronous and reactive? No JDBC.

Integrating Morpheus

back to top

Morpheus is designed to give you an all-you-can eat buffet through a single import, so all you really have to do is to pick the module corresponding to the database you want to use. At this point in time only MySQL is supported.

If you are using MySQL, you would simply use the following:

libraryDependencies ++= Seq(
  "com.outworkers"  %% "morpheus-mysql"                % morpheusVersion
)

And then you can: import com.outworkers.morpheus.mysql._, which will give you the full set of MySQL methods and features without any overlaps or unsupported operations. Morpheus guarantees you can almost never write an invalid SQL query unless you try really really hard.

Available modules

The full list of available modules is:

libraryDependencies ++= Seq(
  "com.outworkers"  %% "morpheus-dsl"                  % morpheusVersion,
  "com.outworkers"  %% "morpheus-mysql"                % morpheusVersion,
  "com.outworkers"  %% "morpheus-postgres"             % morpheusVersion
)

Contributors

back to top

Morpheus was developed by us from scratch in an attempt to evolve the SQL tooling in the Scala ecosystem to the new level and bring in fully reactive database access while preserving the complete SQL syntax you are used to.

  • Flavian Alexandru @alexflav23
  • Benjamin Edwards @benjumanji

Commercial support

back to top

We, the people behind phantom run a software development house specialised in Scala and NoSQL. If you are after enterprise grade training or support for using phantom, Outworkers is here to help!

We offer a comprehensive range of elite Scala development services, including but not limited to:

  • Software development
  • Remote Scala contractors for hire
  • Advanced Scala and Morpheus training

We are big fans of open source and we will open source every project we can! To read more about our OSS efforts, click here.

Copyright

back to top

Copyright (c) 2012 - 2017 outworkers.