Merge pull request #25 from sightmachine/DATA-868

Data 868

Author: siddharthvelotio

README.md

@@ -81,6 +81,15 @@ Similarly, if you need to use your own CA Certificates, set the CURL_CA_BUNDLE e
 CURL_CA_BUNDLE="/path/to/my/certificates"
 ```
 
+### Selecting database schema
+By default, the production pipeline schema will be considered to retrive data from the tenant.
+To select a particular development pipeline schema you can use following function call:
+
+```
+db_schema = pipeline_id 
+cli.select_db_schema(schema_name=db_schema)
+```
+
 ### Retrieving Data
 
 The typical workflow for getting data from Sight Machine is:

examples/Query Examples.ipynb

@@ -50,6 +50,28 @@
     "columns = cli.get_machine_schema(machines[0])['display'].to_list()"
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Selecting a Particular Development Pipeline schema\n",
+    "\n",
+    "You can select development pipeline schema using following code example:\n",
+    "\n",
+    "Note:- By default, the production pipeline schema will be considered to retrive data from the tenant"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "db_schema = 'pipeline_id' \n",
+    "cli.select_db_schema(schema_name=db_schema)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -2069,11 +2091,9 @@
   }
  ],
  "metadata": {
-  "interpreter": {
-   "hash": "767d51c1340bd893661ea55ea3124f6de3c7a262a8b4abca0554b478b1e2ff90"
-  },
   "kernelspec": {
-   "display_name": "Python 3.7.5 64-bit ('usr')",
+   "display_name": "Python 3",
+   "language": "python",
    "name": "python3"
   },
   "language_info": {
@@ -2086,9 +2106,14 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.5"
+   "version": "3.10.9"
   },
-  "orig_nbformat": 2
+  "orig_nbformat": 2,
+  "vscode": {
+   "interpreter": {
+    "hash": "b0fa6594d8f4cbf19f97940f81e996739fb7646882a419484c72d19e05852a7e"
+   }
+  }
  },
  "nbformat": 4,
  "nbformat_minor": 2

smsdk/Auth/auth.py

@@ -22,7 +22,7 @@
 SM_AUTH_HEADER_SECRET_ID = RESOURCE_CONFIG["auth_header-api-secret"]
 SM_AUTH_HEADER_SECRET_ID_OLD = RESOURCE_CONFIG["auth_header-api-secret_old"]
 SM_AUTH_HEADER_KEY_ID = RESOURCE_CONFIG["auth_header-api-key"]
-
+X_SM_DB_SCHEMA = RESOURCE_CONFIG["x_sm_db_schema"]
 
 class Authenticator(MaSession):
     """

smsdk/client.py

@@ -12,7 +12,7 @@
     from pandas.io.json import json_normalize
 
 from smsdk.utils import get_url
-from smsdk.Auth.auth import Authenticator
+from smsdk.Auth.auth import Authenticator, X_SM_DB_SCHEMA
 from smsdk.tool_register import smsdkentities
 from smsdk.client_v0 import ClientV0
 
@@ -115,6 +115,9 @@ def __init__(self, tenant, site_domain="sightmachine.io", protocol = "https"):
         # Setup Authenticator
         self.auth = Authenticator(self)
         self.session = self.auth.session
+    
+    def select_db_schema(self, schema_name):
+        self.session.headers.update({X_SM_DB_SCHEMA:schema_name})
 
     def get_data_v1(self, ename, util_name, normalize=True, *args, **kwargs):
         """

smsdk/client_v0.py

@@ -699,7 +699,6 @@ def get_machine_type_names(self, clean_strings_out=True):
         query_params = {'_only': ['source_type', 'source_type_clean'],
                         '_order_by': 'source_type_clean'}
         machine_types = self.get_data('machine_type', 'get_machine_types', normalize=True, **query_params)
-
         if clean_strings_out:
             return machine_types['source_type_clean'].to_list()
         else:

smsdk/config/message_config.json

@@ -2,6 +2,7 @@
   "auth_header-api-secret": "X-SM-API-Secret",
   "auth_header-api-secret_old": "X-SM-API-Key",
   "auth_header-api-key": "X-SM-API-Key-Id",
+  "x_sm_db_schema":"x-sm-db-schema",
   "keywords": {
     "KEYWORD_MISSING_ACCOUNT": "No such account",
     "KEYWORD_INCORRECT_PASSWORD": "password does not match",

smsdk/ma_session.py

@@ -21,6 +21,7 @@
 SM_AUTH_HEADER_SECRET_ID = RESOURCE_CONFIG["auth_header-api-secret"]
 SM_AUTH_HEADER_SECRET_ID_OLD = RESOURCE_CONFIG["auth_header-api-secret_old"]
 SM_AUTH_HEADER_KEY_ID = RESOURCE_CONFIG["auth_header-api-key"]
+X_SM_DB_SCHEMA = RESOURCE_CONFIG['x_sm_db_schema']
 
 import logging
 log = logging.getLogger(__name__)