README.rst 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. Cloudera Navigator Optimizer Api SDK
  2. ==============================================
  3. This package provides a API SDK for Cloudera Navigator Optimizer.
  4. Install the package
  5. ====================
  6. sudo pip install navoptapi-0.1.0.tar.gz
  7. Example Usage for the Api
  8. =========================
  9. * Import the module
  10. from navoptapi.api_lib import *
  11. * Create NavOpt object passing hostname/address, access key and private key:
  12. nav = ApiLib("navopt", "127.0.0.1", "e0819f3a-1e6f-4904-be69-4ftrf56983", "-----BEGIN PRIVATE KEY-----\ngm9aeam8fgZ5VXPbXRo9EYepZcWPWeYO1WjPyI\nF17opGTl9M/2H+kXmsmyPwLBSQE96Q==\n-----END PRIVATE KEY-----")
  13. * Upload a file to NavOpt:
  14. resp = nav.call_api("upload", {"tenant" : "6bd23dea-13aa-ce13-4a6d-1614151428fc", "fileLocation": "/Users/harshil/Downloads/tmpbUMdbb.csv", "sourcePlatform": "hive", "colDelim": ",", "rowDelim": "\n", "headerFields": [{"count": 0, "coltype": "SQL_ID", "use": True, "tag": "", "name": "SQL_ID"}, {"count": 0, "coltype": "NONE", "use": True, "tag": "", "name": "ELAPSED_TIME"}, {"count": 0, "coltype": "SQL_QUERY", "use": True, "tag": "", "name": "SQL_FULLTEXT"}]})
  15. print resp
  16. * Get Status of the upload:
  17. resp = nav.call_api("uploadStatus", {"tenant" : "6bd23dea-13aa-ce13-4a6d-1614151428fc", "workloadId": "10661f8a-83e1-4ff7-b2be-fabb2ee971bd"})
  18. print json.dumps(resp.json(), indent=2)
  19. * Get Top Tables for a workload:
  20. resp = nav.call_api("getTopTables", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53"})
  21. print json.dumps(resp.json(), indent=2)
  22. * Get Top Databases for a workload:
  23. resp = nav.call_api("getTopDataBases", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53"})
  24. print json.dumps(resp.json(), indent=2)
  25. * Get Top Queries for a workload:
  26. resp = nav.call_api("getTopQueries", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53"})
  27. print json.dumps(resp.json(), indent=2)
  28. * Get Top Columns for a workload:
  29. resp = nav.call_api("getTopColumns", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53", "dbTableList":["default.sample_07"]})
  30. print json.dumps(resp.json(), indent=2)
  31. * Get Top Filters for a workload:
  32. resp = nav.call_api("getTopFilters", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53", "dbTableList":["default.sample_07"]})
  33. print json.dumps(resp.json(), indent=2)
  34. * Get Top Aggregates for a workload:
  35. resp = nav.call_api("getTopAggs", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53", "dbTableList":["default.sample_07"]})
  36. print json.dumps(resp.json(), indent=2)
  37. * Get Top Joins for a workload:
  38. resp = nav.call_api("getTopJoins", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53", "dbTableList":["default.sample_07"]})
  39. print json.dumps(resp.json(), indent=2)
  40. * Get Query Compatibility:
  41. resp = nav.call_api("getQueryCompatible", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53", "query":"select supplier.s_acctbal, supplier.s_name, nation.n_name, part.p_partkey, part.p_mfgr, supplier.s_address, supplier.s_phone, supplier.s_comment from part, supplier, partsupp, nation, region where part.p_partkey = partsupp.ps_partkey and supplier.s_suppkey = partsupp.ps_suppkey and part.p_size = 15 and part.p_type like '%BRASS' and supplier.s_nationkey = nation.n_nationkey and nation.n_regionkey = region.r_regionkey and region.r_name = 'EUROPE' and partsupp.ps_supplycost = ( select min(partsupp.ps_supplycost) from partsupp, supplier, nation, region where part.p_partkey = partsupp.ps_partkey and supplier.s_suppkey = partsupp.ps_suppkey and supplier.s_nationkey = nation.n_nationkey and nation.n_regionkey = region.r_regionkey and region.r_name = 'EUROPE' ) order by supplier.s_acctbal desc, nation.n_name, supplier.s_name, part.p_partkey", "sourcePlatform":"teradata", "targetPlatform":"hive"})
  42. print json.dumps(resp.json(), indent=2)
  43. * Get Query Risk Analysis:
  44. resp = nav.call_api("getQueryRisk", {"tenant" : "d6d54b73-2bab-e413-5376-a805f5d4ae53", "query": "select * from web_logs limit 10"})
  45. print json.dumps(resp.json(), indent=2)