openstack/deb-python-cassandra-driver
Code Issues Proposed changes

documenting the removal of the cqlengine keyspace

Browse Source
This commit is contained in:
Blake Eggleston
2014-07-03 15:38:04 -07:00
parent d3ce856f91
commit f03bd5b2e5
3 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -3,7 +3,7 @@ cqlengine
cqlengine is a Cassandra CQL 3 Object Mapper for Python
**Users of versions < 0.4, please read this post: [Breaking Changes](https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU)**
**Users of versions < 0.16, the default keyspace 'cqlengine' has been removed. Please read this before upgrading:** [Breaking Changes](https://cqlengine.readthedocs.org/en/latest/topics/models.html#keyspace-change)
[Documentation](https://cqlengine.readthedocs.org/en/latest/)

4
docs/index.rst
View File

@@ -5,9 +5,7 @@
cqlengine documentation
=======================
**Users of versions < 0.4, please read this post before upgrading:** `Breaking Changes`_
.. _Breaking Changes: https://groups.google.com/forum/?fromgroups#!topic/cqlengine-users/erkSNe1JwuU
**Users of versions < 0.16, the default keyspace 'cqlengine' has been removed. Please read this before upgrading:** :ref:`Breaking Changes <keyspace-change>`
cqlengine is a Cassandra CQL 3 Object Mapper for Python

6
docs/topics/models.rst
View File

@@ -169,9 +169,13 @@ Model Attributes
*Optional.* Sets the name of the CQL table for this model. If left blank, the table name will be the name of the model, with it's module name as it's prefix. Manually defined table names are not inherited.
.. _keyspace-change:
.. attribute:: Model.__keyspace__
*Optional.* Sets the name of the keyspace used by this model. Defaults to cqlengine
Sets the name of the keyspace used by this model.
**Prior to cqlengine 0.16, this setting defaulted
to 'cqlengine'. As of 0.16, this field needs to be set on all non-abstract models, or their base classes.**
Table Polymorphism