scylla-driver

Scylla Python Driver

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/actions/workflows/build-push.yml/badge.svg?branch=master :target: https://github.com/scylladb/python-driver/actions/workflows/build-push.yml?query=event%3Apush+branch%3Amaster

.. image:: https://github.com/scylladb/python-driver/actions/workflows/docs-pages.yaml/badge.svg?branch=master :target: https://github.com/scylladb/python-driver/actions/workflows/docs-pages.yaml?query=event%3Apush+branch%3Amaster

.. image:: https://github.com/scylladb/python-driver/actions/workflows/integration-tests.yml/badge.svg?branch=master :target: https://github.com/scylladb/python-driver/actions/workflows/integration-tests.yml?query=event%3Apush+branch%3Amaster

The driver supports Python versions 3.6-3.11.

.. Note: This driver does not support big-endian systems.

Features

• 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>_ APIs
• Simple, Prepared, and Batch statements <http://python-driver.docs.scylladb.com/stable/api/cassandra/query.html#cassandra.query.Statement>_
• Asynchronous IO, parallel execution, request pipelining
• Connection pooling <http://python-driver.docs.scylladb.com/stable/api/cassandra/cluster.html#cassandra.cluster.Cluster.get_core_connections_per_host>_
• Automatic node discovery
• Automatic reconnection <http://python-driver.docs.scylladb.com/stable/api/cassandra/policies.html#reconnecting-to-dead-hosts>_
• Configurable 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

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>_.

Documentation

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>_

Training

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.

Object Mapper

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>_.

Contributing

See CONTRIBUTING <https://github.com/scylladb/python-driver/blob/master/CONTRIBUTING.rst>_.

Error Handling

While originally written for the Java driver, users may reference the Cassandra error handling done right blog <https://www.datastax.com/blog/cassandra-error-handling-done-right>_ for resolving error handling scenarios with Apache Cassandra.

Reporting Problems

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.

Getting Help

You can ask questions on ScyllaDB Community Forum <https://forum.scylladb.com/>_ and the Scylla Users Slack channel <https://scylladb-users.slack.com>_.

License

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.