Spring/spring-data-cassandra
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor README updates & typo fixes

Browse Source
This commit is contained in:
Matthew Adams
2014-01-27 09:32:45 -08:00
parent 065ad436fc
commit 845bf75854
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -11,6 +11,8 @@ the development team feedback. We hope this iterative approach produces the mos
There are two modules included in the ``spring-data-cassandra`` repository: ``spring-cassandra`` and ``spring-data-cassandra``.
_Note: we are considering consolidating both modules into one for convenience._
#### Module ``spring-cassandra``
This is the low-level core template framework, like the ones you are used to using on all your Spring projects. Our
@@ -19,9 +21,13 @@ This is the low-level core template framework, like the ones you are used to usi
This includes persistence exception translation, Spring JavaConfig and XML configuration support. Define your Spring beans to setup your
Cassandra ``Cluster`` object, then create your ``Session`` and you are ready to interact with Cassandra using the ``CqlTemplate``.
The module also offers convenient builder pattern classes to easily specify the creation, alteration, and dropping of keyspaces via a fluent API. They are intended to be used with generators that produce CQL that can then be easily executed by ``CqlTemplate``. See test class ``CreateTableCqlGeneratorTests`` for examples. Don't forget to check out class ``MapBuilder`` for easy creation of Cassandra ``TableOption`` values.table operation builders for ``CREATE TABLE``, ``ALTER TABLE``, and ``DROP TABLE`` operations.
The module also offers convenient builder pattern classes to easily specify the creation, alteration, and dropping of keyspaces via a fluent API. They are intended to be used with generators that produce CQL that can then be easily executed by ``CqlTemplate``. See test class ``CreateTableCqlGeneratorTests`` for examples. Don't forget to check out class ``MapBuilder`` for easy creation of Cassandra ``TableOption`` values. The builders & CQL generators for ``CREATE TABLE``, ``ALTER TABLE``, and ``DROP TABLE`` operations are
Additionally, there's support for Spring JavaConfig and a Spring Cassandra XML namespace, making it easy to configure your context to work Cassandra, including XML namespace support for automatic keyspace creations, drops & more.
* ``CreateTableSpecification`` & ``CreateTableCqlGenerator``,
* ``AlterTableSpecification`` & ``AlterTableCqlGenerator``, and
* ``DropTableSpecification`` & ``DropTableCqlGenerator``, respectively.
The support for Spring JavaConfig and a Spring Cassandra XML namespace makes it easy to configure your context to work with Cassandra, including XML namespace support for automatic keyspace creations, drops & more, which can be convenient when writing integration tests.
#### Module ``spring-data-cassandra``
@@ -31,8 +37,6 @@ _Note: The code in the ``spring-data-cassandra`` module is a work in progress an
We are actively working on its completion, but wanted to make the lower level Cassandra template functionality available to the Spring and Cassandra communities.
_Note: we are considering consolidating both modules into one for convenience._
#### Best practices
We have worked closely with the DataStax Driver Engineering team to ensure that our implementation around their native