Get NoSQL Table Instance

Catalyst NoSQL enables you to fetch an empty table instance of an existing NoSQL table. You can then use this instance to refer to that table and perform all supported table operations. This process will not fire a server-side call.

You can get an instance of your NoSQL table in three ways as described in this section. The nosql reference used in the code snippets below is the component instance created earlier.

Get Instance with Table ID

Get a table instance with the unique ID of the table as shown below.

    

        
copy
        

            

        
    
    

         const tableInstanceA = nosql.table('1234567890'); // Create a table instance with Table ID
    

Get Instance with Table Name

Get a table instance with the table’s name as shown below.

    

        
copy
        

            

        
    
    

         const tableInstanceB = nosql.table('test'); // Create a table instance with the table name
    

Get Instance with Table Details

Get a table instance by specifying the details of the table and resolving it to toJSON() as shown below.

This method provides flexibility by allowing you to duplicate a table object whose instance you already fetched using the Table ID or table name. You can then configure additional details of the table to the instance and use this to refer to the table instead.

    

        
copy
        

            

        
    
    

         const tableInstanceC = nosql.table(tableA.toJSON()); // Create a table instance with table details