Files
deb-python-cassandra-driver/docs/index.rst
2015-02-09 14:37:52 -06:00

75 lines
2.1 KiB
ReStructuredText

Python Cassandra Driver
=======================
A Python client driver for `Apache Cassandra <http://cassandra.apache.org>`_.
This driver works exclusively with the Cassandra Query Language v3 (CQL3)
and Cassandra's native protocol. Cassandra 1.2+ is supported.
The core driver supports Python 2.6, 2.7, 3.3, and 3.4. The object mapper is presently supported in 2.7+.
This driver is open source under the
`Apache v2 License <http://www.apache.org/licenses/LICENSE-2.0.html>`_.
The source code for this driver can be found on `GitHub <http://github.com/datastax/python-driver>`_.
Contents
--------
:doc:`installation`
How to install the driver.
:doc:`getting_started`
A guide through the first steps of connecting to Cassandra and executing queries.
:doc:`object_mapper`
Introduction to the integrated object mapper, cqlengine
:doc:`api/index`
The API documentation.
:doc:`upgrading`
A guide to upgrading versions of the driver.
:doc:`performance`
Tips for getting good performance.
:doc:`query_paging`
Notes on paging large query results.
:doc:`user_defined_types`
Working with Cassandra 2.1's user-defined types.
:doc:`security`
An overview of the security features of the driver.
.. toctree::
:hidden:
api/index
installation
getting_started
upgrading
performance
query_paging
security
user_defined_types
object_mapper
Getting Help
------------
Please send questions to the `mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_.
Alternatively, you can use IRC. Connect to the #datastax-drivers channel on irc.freenode.net.
If you don't have an IRC client, you can use `freenode's web-based client <http://webchat.freenode.net/?channels=#datastax-drivers>`_.
Reporting Issues
----------------
Please report any bugs and make any feature requests on the
`JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_ issue tracker.
If you would like to contribute, please feel free to open a pull request.
Indices and Tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`