{"id":422,"date":"2024-09-11T08:06:28","date_gmt":"2024-09-11T08:06:28","guid":{"rendered":"https:\/\/ramansaini.in\/blog\/?p=422"},"modified":"2024-09-11T19:48:17","modified_gmt":"2024-09-11T19:48:17","slug":"working-with-scylladb-queries-using-models-a-comprehensive-guide","status":"publish","type":"post","link":"https:\/\/ramansaini.in\/blog\/working-with-scylladb-queries-using-models-a-comprehensive-guide\/","title":{"rendered":"Working with ScyllaDB Queries Using Models: A Comprehensive Guide"},"content":{"rendered":"\n

ScyllaDB is renowned for its high-performance, distributed NoSQL capabilities, making it a popular choice for handling large-scale data. If you\u2019re working with ScyllaDB, understanding how to leverage models for querying can significantly streamline your data operations. This approach simplifies interactions with the database and enhances productivity. In this guide, we\u2019ll delve into how to use models with ScyllaDB queries, breaking down the latest practices for 2024 to make your data management tasks more efficient and intuitive.<\/p>\n\n\n\n

What Are ScyllaDB Models?<\/h3>\n\n\n\n

In ScyllaDB, models provide an abstraction layer that simplifies database operations. Rather than writing raw queries, you interact with your data through models, which represent the structure of your data and encapsulate the logic for performing operations. Think of models as blueprints or templates that define how your data is organized and manipulated, similar to how a form or template helps standardize information entry.<\/p>\n\n\n\n

Key Concepts of ScyllaDB Models<\/h3>\n\n\n\n

1. Defining Models<\/strong><\/p>\n\n\n\n

Models in ScyllaDB are defined using the cqlengine<\/code> module of the ScyllaDB Python driver. Each model maps to a table in your ScyllaDB database. Here\u2019s a simple example:<\/p>\n\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
from<\/span> cassandra<\/span>.<\/span>cqlengine <\/span>import<\/span> columns<\/span><\/span>\nfrom<\/span> cassandra<\/span>.<\/span>cqlengine<\/span>.<\/span>models <\/span>import<\/span> Model<\/span><\/span>\n<\/span>\nclass<\/span> <\/span>User<\/span>(<\/span>Model<\/span>):<\/span><\/span>\n    user_id <\/span>=<\/span> columns<\/span>.<\/span>UUID<\/span>(<\/span>primary_key<\/span>=True<\/span>)<\/span><\/span>\n    name <\/span>=<\/span> columns<\/span>.<\/span>Text<\/span>()<\/span><\/span>\n    email <\/span>=<\/span> columns<\/span>.<\/span>Text<\/span>()<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
In this example, the User<\/code> model represents a table where each row has a unique user_id<\/code>, a name<\/code>, and an email<\/code>. This structure makes it easy to interact with the data without writing raw CQL queries.<\/p>\n\n\n\n
This is similar to:<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
CREATE TABLE cqlengine<\/span>.<\/span>user<\/span> <\/span>(<\/span><\/span>\n    user_id uuid<\/span>,<\/span><\/span>\n    name text<\/span>,<\/span><\/span>\n    email text<\/span>,<\/span><\/span>\n    PRIMARY <\/span>KEY<\/span> <\/span>(<\/span>user_id<\/span>)<\/span><\/span>\n)<\/span>;<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
2. Querying with Models<\/strong><\/p>\n\n\n\n
Once you\u2019ve defined your models, you can perform queries using a high-level API provided by cqlengine<\/code>. This approach abstracts away the complexities of raw CQL and provides a more intuitive way to interact with your data. Here\u2019s how you can perform various operations:<\/p>\n\n\n\n
Retrieve Data<\/strong>: Use the filter<\/code> method to retrieve data based on specific conditions.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
from<\/span> cassandra<\/span>.<\/span>cqlengine<\/span>.<\/span>query <\/span>import<\/span> DoesNotExist<\/span><\/span>\n<\/span>\ntry<\/span>:<\/span><\/span>\n    user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>get<\/span>(<\/span>user_id<\/span>=<\/span>'<\/span>12345<\/span>'<\/span>)<\/span><\/span>\n    <\/span>print<\/span>(<\/span>user<\/span>.<\/span>name<\/span>,<\/span> user<\/span>.<\/span>email<\/span>)<\/span><\/span>\nexcept<\/span> DoesNotExist<\/span>:<\/span><\/span>\n    <\/span>print<\/span>(<\/span>"<\/span>User not found<\/span>"<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Another method for getting the data is the filter function.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>filter<\/span>(<\/span>user_id<\/span>=<\/span>'<\/span>12345<\/span>'<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Another convenient syntax for the filter is<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>(<\/span>User<\/span>.<\/span>manufacturer <\/span>==<\/span> <\/span>'<\/span>Tesla<\/span>'<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
One of the features of using this ORM for ScyllaDB is we can further extend the filter by calling the filter function further on the model object and adding the new filter expressions dynamically.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> user<\/span>.<\/span>filter<\/span>(<\/span>name<\/span> <\/span>=<\/span> <\/span>'<\/span>Raman<\/span>'<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Paginating<\/strong>: In ScyllaDB, to implement pagination we can use array indexing syntax for start and end of the query.<\/p>\n\n\n\n
List Indexing:<\/strong><\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>all<\/span>()<\/span><\/span>\nq<\/span>[<\/span>0<\/span>]<\/span> <\/span>#returns the first result<\/span><\/span>\nq<\/span>[<\/span>1<\/span>]<\/span> <\/span>#returns the second result<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
List Slicing:<\/strong><\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>all<\/span>()<\/span><\/span>\nq<\/span>[<\/span>1<\/span>:]<\/span> <\/span>#returns all results except the first<\/span><\/span>\nq<\/span>[<\/span>1<\/span>:<\/span>9<\/span>]<\/span> <\/span>#returns a slice of the results<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Query fetch operations function<\/strong><\/p>\n\n\n\n
get()<\/code> returns the object matching the query set.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>filter<\/span>(<\/span>user_id<\/span>=<\/span>'<\/span>12345<\/span>'<\/span>)<\/span><\/span>\nuser <\/span>=<\/span> user<\/span>.<\/span>get<\/span>()<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
first()<\/code> returns the first object of the query set.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>filter<\/span>(<\/span>user_id<\/span>=<\/span>'<\/span>12345<\/span>'<\/span>)<\/span><\/span>\nuser <\/span>=<\/span> user<\/span>.<\/span>first<\/span>()<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
You can read about ScyllaDB filtering in detail here:<\/strong> Understanding ScyllaDB filtering Operators<\/a><\/p>\n\n\n\n
Insert Data<\/strong>: Create new records by instantiating a model and saving it.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
new_user <\/span>=<\/span> User<\/span>.<\/span>create<\/span>(<\/span>user_id<\/span>=<\/span>'<\/span>12345<\/span>'<\/span>,<\/span> <\/span>name<\/span>=<\/span>'<\/span>Raman<\/span>'<\/span>,<\/span> <\/span>email<\/span>=<\/span>'<\/span>john@example.com<\/span>'<\/span>)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
 <\/code>The create<\/code> method both initializes and saves the new user to the database.<\/p>\n\n\n\n
Update Data<\/strong>: Update existing records using the update<\/code> method.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>get<\/span>(<\/span>user_id<\/span>=<\/span>'<\/span>12345<\/span>'<\/span>)<\/span><\/span>\nuser<\/span>.<\/span>name <\/span>=<\/span> <\/span>'<\/span>John Smith<\/span>'<\/span><\/span>\nuser<\/span>.<\/span>save<\/span>()<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
This example fetches a user, updates their name, and saves the changes.<\/p>\n\n\n\n
Delete Data<\/strong>: Remove records with the delete<\/code> method.<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
user <\/span>=<\/span> User<\/span>.<\/span>objects<\/span>.<\/span>get<\/span>(<\/span>user_id<\/span>=<\/span>'<\/span>12345<\/span>'<\/span>)<\/span><\/span>\nuser<\/span>.<\/span>delete<\/span>()<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
This deletes the specified user from the database.<\/p>\n\n\n\n
Latest Information: What\u2019s New in 2024<\/strong><\/p>\n\n\n\n
As of 2024, there are several notable updates and features in ScyllaDB that enhance the use of models:<\/p>\n\n\n\n