Added get definition route

Author: Synicix

dj_gui_api_server/DJConnector.py

@@ -94,7 +94,7 @@ def list_tables(jwt_payload, schema_name):
         table_name (string): Table name under the given schema, must be in camel case
 
     Returns:
-        (tuples)
+        list<tuples_as_dicts>: a list of tuples in dict form
     """
     @staticmethod
     def fetch_tuples(jwt_payload, schema_name, table_name):
@@ -103,6 +103,24 @@ def fetch_tuples(jwt_payload, schema_name, table_name):
         schema_virtual_module = dj.create_virtual_module(schema_name, schema_name)
         return getattr(schema_virtual_module, table_name).fetch(as_dict=True)
 
+    """
+    Get the table definition
+
+    Parameters:
+        jwt_payload (dict): Dictionary containing databaseAddress, username and password strings
+        schema_name (string): Schema name where to find the table under
+        table_name (string): Table name under the given schema, must be in camel case
+
+    Returns:
+        string: definition of the table
+    """
+    @staticmethod
+    def get_table_definition(jwt_payload, schema_name, table_name):
+        DJConnector.set_datajoint_config(jwt_payload)
+        
+        schema_virtual_module = dj.create_virtual_module(schema_name, schema_name)
+        return getattr(schema_virtual_module, table_name).describe()
+
     """
     Method to set credentials for database
     
@@ -119,6 +137,7 @@ def set_datajoint_config(jwt_payload):
         dj.config['database.password'] = jwt_payload['password']
 
         dj.conn(reset=True)
+    
     """
     Helper method for converting snake to camel case
 

dj_gui_api_server/DJGUIAPIServer.py

@@ -114,7 +114,7 @@ def list_tables(jwt_payload):
     body: (html:POST:JSON): {"schemaName": <schema_name>, "tableName": <table_name>} (NOTE: Table name must be in CamalCase)
 
 Returns:
-    dict(tuples=[tuples_as_dicts])
+    dict(table_definition=table_definition): table_definition will be in string format
     or
     dict(error=<error_message>): With error message of why it failed
 """
@@ -127,5 +127,27 @@ def fetch_tuples(jwt_payload):
     except Exception as e:
         return str(e), 500
 
+"""
+Route to get table definition
+
+Parameters:
+    header: (html:GET:Authorization): Must include in format of: bearer <JWT-Token>
+    body: (html:POST:JSON): {"schemaName": <schema_name>, "tableName": <table_name>} (NOTE: Table name must be in CamalCase)
+
+Returns:
+    string: The table definition
+    or
+    dict(error=<error_message>): With error message of why it failed
+
+"""
+@app.route('/api/get_table_definition', methods=['POST'])
+@protected_route
+def get_table_definition(jwt_payload):
+    try:
+        table_definition = DJConnector.get_table_definition(jwt_payload, request.json["schemaName"], request.json["tableName"])
+        return table_definition
+    except Exception as e:
+        return str(e), 500
+
 if __name__ == '__main__':
     app.run(host='0.0.0.0', port=5000)