A modern, feature-rich and highly-tunable Python client library for Scylla Open Source (2.1+) and Apache Cassandra (2.1+) and Scylla Enterprise (2018.1.x+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3.
.. image:: https://github.com/scylladb/python-driver/workflows/Build%20and%20upload%20to%20PyPi/badge.svg?tag=*-scylla :target: https://github.com/scylladb/python-driver/actions?query=workflow%3A%22Build+and+upload+to+PyPi%22+event%3Apush+branch%3A*-scylla
.. image:: https://github.com/scylladb/python-driver/workflows/CI%20Docs/badge.svg?tag=*-scylla :target: https://github.com/scylladb/python-driver/actions?query=workflow%3A%22CI+Docs%22+event%3Apush+branch%3A*-scylla
The driver supports Python versions 3.6-3.11.
.. Note: This driver does not support big-endian systems.
Synchronous <http://python-driver.docs.scylladb.com/stable/api/cassandra/cluster.html#cassandra.cluster.Session.execute>
_ and Asynchronous <http://python-driver.docs.scylladb.com/stable/api/cassandra/cluster.html#cassandra.cluster.Session.execute_async>
_ APIsSimple, Prepared, and Batch statements <http://python-driver.docs.scylladb.com/stable/api/cassandra/query.html#cassandra.query.Statement>
_Connection pooling <http://python-driver.docs.scylladb.com/stable/api/cassandra/cluster.html#cassandra.cluster.Cluster.get_core_connections_per_host>
_Automatic reconnection <http://python-driver.docs.scylladb.com/stable/api/cassandra/policies.html#reconnecting-to-dead-hosts>
_load balancing <http://python-driver.docs.scylladb.com/stable/api/cassandra/policies.html#load-balancing>
and retry policies <http://python-driver.docs.scylladb.com/stable/api/cassandra/policies.html#retrying-failed-operations>
Concurrent execution utilities <http://python-driver.docs.scylladb.com/stable/api/cassandra/concurrent.html>
_Object mapper <http://python-driver.docs.scylladb.com/stable/object-mapper.html>
_Shard awareness <http://python-driver.docs.scylladb.com/stable/scylla-specific.html#shard-awareness>
_Tablet awareness <http://python-driver.docs.scylladb.com/stable/scylla-specific.html#tablet-awareness>
_Installation through pip is recommended::
$ pip install scylla-driver
For more complete installation instructions, see the
installation guide <http://python-driver.docs.scylladb.com/stable/installation.html>
_.
The documentation can be found online here <http://python-driver.docs.scylladb.com/stable/index.html>
_.
Information includes:
Installation <http://python-driver.docs.scylladb.com/stable/installation.html>
_Getting started guide <http://python-driver.docs.scylladb.com/stable/getting-started.html>
_API docs <http://python-driver.docs.scylladb.com/stable/api/index.html>
_Performance tips <http://python-driver.docs.scylladb.com/stable/performance.html>
_The course Using Scylla Drivers <https://university.scylladb.com/courses/using-scylla-drivers/lessons/coding-with-python/>
in Scylla University <https://university.scylladb.com>
explains how to use drivers in different languages to interact with a Scylla cluster.
The lesson, Coding with Python (link), goes over a sample application that, using the Python driver, interacts with a three-node Scylla cluster.
It connects to a Scylla cluster, displays the contents of a table, inserts and deletes data, and shows the contents of the table after each action.
Scylla University <https://university.scylladb.com>
_ includes other training material and online courses which will help you become a Scylla NoSQL database expert.
cqlengine (originally developed by Blake Eggleston and Jon Haddad, with contributions from the
community) is now maintained as an integral part of this package. Refer to
documentation here <http://python-driver.docs.scylladb.com/stable/object-mapper.html>
_.
See CONTRIBUTING <https://github.com/scylladb/python-driver/blob/master/CONTRIBUTING.rst>
_.
Please report any bugs and make any feature requests by clicking the New Issue button in
Github <https://github.com/scylladb/python-driver/issues>
_.
If you would like to contribute, please feel free to send a pull request.
Your best options for getting help with the driver are the
mailing list <https://groups.google.com/forum/#!forum/scylladb-users>
and the Scylla Users Slack channel <https://scylladb-users.slack.com>
.
Copyright DataStax, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.