Skip to content

Update Getting Started docs to reference Scylla instead of Cassandra #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dkropachev merged 1 commit into from
Jan 31, 2026
+9 −9
Merged

Update Getting Started docs to reference Scylla instead of Cassandra #672

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ First, make sure you have the driver properly :doc:`installed <installation>`.

Connecting to a Cluster
-----------------------
Before we can start executing any queries against a Cassandra cluster we need to setup
Before we can start executing any queries against a Scylla cluster we need to setup
an instance of :class:`~.Cluster`. As the name suggests, you will typically have one
instance of :class:`~.Cluster` for each Cassandra cluster you want to interact
instance of :class:`~.Cluster` for each Scylla cluster you want to interact
with.

First, make sure you have the Cassandra driver properly :doc:`installed <installation>`.
First, make sure you have the Scylla driver properly :doc:`installed <installation>`.

Connecting to Cassandra
+++++++++++++++++++++++
Connecting to Scylla
++++++++++++++++++++
The simplest way to create a :class:`~.Cluster` is like this:

.. code-block:: python
Expand All @@ -22,7 +22,7 @@ The simplest way to create a :class:`~.Cluster` is like this:

cluster = Cluster()

This will attempt to connection to a Cassandra instance on your
This will attempt to connect to a Scylla instance on your
local machine (127.0.0.1). You can also specify a list of IP
addresses for nodes in your cluster:

Expand Down Expand Up @@ -121,7 +121,7 @@ way to execute a query is to use :meth:`~.Session.execute()`:
for user_row in rows:
print(user_row.name, user_row.age, user_row.email)

This will transparently pick a Cassandra node to execute the query against
This will transparently pick a Scylla node to execute the query against
and handle any retries that are necessary if the operation fails.

By default, each row in the result set will be a
Expand Down Expand Up @@ -160,10 +160,10 @@ frequently run queries.

Prepared Statements
-------------------
Prepared statements are queries that are parsed by Cassandra and then saved
Prepared statements are queries that are parsed by Scylla and then saved
for later use. When the driver uses a prepared statement, it only needs to
send the values of parameters to bind. This lowers network traffic
and CPU utilization within Cassandra because Cassandra does not have to
and CPU utilization within Scylla because Scylla does not have to
re-parse the query each time.

To prepare a query, use :meth:`.Session.prepare()`:
Expand Down