Get NoSQL Table Metadata

You can get the metadata of a single Catalyst NoSQL table or of all tables in your project as described below.

Get Metadata of Single Table

The metadata of a single table in Catalyst NoSQL can be obtained in two ways as mentioned in this page. The response will contain details of the table configuration, such as the partition key and sort key, TTL attribute, and more.

The nosql reference used in the code snippets below is the component instance created to perform these operations.

Get Table Metadata with Table ID

You can fetch the metadata of a NoSQL table in your project by referring to its unique Table ID using the method getTable() as given below.

    

        
copy
        

            

        
    
    

         // Create a NoSQL instance
const nosql = app.nosql();
// Get table metadata using the Table ID
const tableA = await nosql.getTable('124567890'); 
    

Get Table Metadata with Table Name

You can fetch the metadata of a NoSQL table in your project by referring the table name using the method getTable() as given below.

    

        
copy
        

            

        
    
    

         // Create a NoSQL instance
const nosql = app.nosql();
// Get table metadata using the table name
const tableB = await nosql.getTable('EmpTable'); 
    

Get Metadata of All Tables

Catalyst enables you to fetch the metadata of all the tables in your project using the getAllTable() method as shown below.

    

        
copy
        

            

        
    
    

         // Get metadata of all tables
const allTables = await nosql.getAllTable();