ZCQL

Introduction

ZCQL is Catalyst’s own query language that is similar to MySQL or PostGres. Catalyst supports ZCQL query language to perform data manipulations in the Catalyst Data Store.

You can perform the following operations on the tables in your Data Store using ZCQL:

Retrieval: Obtaining records from existing tables
Insertion: Inserting records into the existing columns of an existing table
Updating: Updating the value of existing columns in an existing table
Deletion: Deleting records from an existing table

You can execute a variety of DML queries using ZCQL to obtain or manipulate data based on specific criteria by using various clauses and statements such as the SQL Join clauses, Groupby statements, OrderBy statements, and the WHERE and HAVING clauses. ZCQL also supports several built-in SQL numeric functions that help you execute arithmetic operations easily.

You can implement ZCQL queries in your Catalyst application’s source code, such as in the functions or the client component. For example, you pass a ZCQL query in a function’s body to retrieve data from a table in the Data Store and process it further.

The Catalyst console also provides a ZCQL query execution window, where you can execute queries and view the responses. This allows you to test ZCQL queries easily, before implementing them in your application.

SDK and API documentation

Catalyst offers ZCQL in the Java, Node.js, Python, Web, Android, iOS, and Flutter SDK packages, and as an API. For code samples on executing ZCQL queries in these programming environments, refer to these help pages:

Note:

From December 01st, 2024, all your current projects in all your Orgs present in the Development Environment will be automatically mapped to ZCQL V2 Parser.
From April 01st, 2025, all the projects present in all Orgs that have already been mapped to ZCQL V2 Parser in Development Environment will be automatically mapped to ZCQL V2 Parser in the Production Environment, if and when production is enabled for the project.
To use ZCQL V2 in your code, you need to set the appropriate environment variable as shown in this help document.

You can refer to Catalyst Tutorials to get an idea of ZCQL’s implementation in the function or client code of the applications.

Benefits

Can perform data retrieval, insertion, updating, and deletion operations in the Catalyst Data Store
Similarity to MySQL ensures ease of use and there is no separate learning curve
Can test the execution of the queries in the console before implementing them in the application
Can pass a ZCQL query in an API’s body using the SDKs
Can perform arithmetic and numerical operations on the result set using the ZCQL built-in functions

Last Updated 2024-09-12 18:16:13 +0530 +0530

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit