Get Component Instance

Catalyst NoSQL is a fully managed non-relational, NoSQL data storage feature that enables you to store the semi-structured, unstructured, and disparate data of your applications. Catalyst supports document-type data storage in the key-value pair based JSON format.

The Catalyst NoSQL Python SDK package enables you to perform CRUD data operations on your NoSQL tables in your project. You can fetch the metadata of your NoSQL tables, create NoSQL items of various supported data types, and insert, update, fetch, or delete items in a specific table. You can also query tables or indexes of tables by specifying query conditions.

Early Access Note

NoSQL is currently only available in the early access mode. You will need to install the beta version of the Python SDK. The details are given below:

Installation procedure:

1. You can install the beta version of zcatalyst-sdk from testpypi using the command below. Refer to this help doc for the installation steps.

    

        
copy
        

            

        
    
    

         python3 -m pip install --extra-index-url https://test.pypi.org/simple/ zcatalyst-sdk==1.0.0rc3"
    

2. You must modify the requirements.txt to install the zcatalyst-sdk v1.0.0rc3 during serve and deploy from the CLI as shown below:

    

        
copy
        

            

        
    
    

         --extra-index-url https://test.pypi.org/simple/
zcatalyst-sdk==1.0.0rc3
    

Create a NoSQL Instance

A component instance is an object that can be used to access the pre-defined configurations specific to a particular component.

You can create a NoSQL object to perform SDK operations in Python as shown below. This will not fire a server-side call. We will refer to this nosql instance in various code snippets of working with NoSQL.

The app reference used to create the NoSQL instance is the Python object returned as the response during the SDK initialization.

    

        
copy
        

            

        
    
    

          #Create a NoSQL instance
nosql = app.nosql()