api.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912
  1. #!/usr/bin/env python
  2. # Licensed to Cloudera, Inc. under one
  3. # or more contributor license agreements. See the NOTICE file
  4. # distributed with this work for additional information
  5. # regarding copyright ownership. Cloudera, Inc. licenses this file
  6. # to you under the Apache License, Version 2.0 (the
  7. # "License"); you may not use this file except in compliance
  8. # with the License. You may obtain a copy of the License at
  9. #
  10. # http://www.apache.org/licenses/LICENSE-2.0
  11. #
  12. # Unless required by applicable law or agreed to in writing, software
  13. # distributed under the License is distributed on an "AS IS" BASIS,
  14. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. # See the License for the specific language governing permissions and
  16. # limitations under the License.
  17. from future import standard_library
  18. standard_library.install_aliases()
  19. import json
  20. import logging
  21. import sqlparse
  22. import sys
  23. from django.urls import reverse
  24. from django.db.models import Q
  25. from django.utils.translation import ugettext as _
  26. from django.views.decorators.http import require_GET, require_POST
  27. import opentracing.tracer
  28. from azure.abfs.__init__ import abfspath
  29. from desktop.api2 import __paginate
  30. from desktop.conf import TASK_SERVER
  31. from desktop.lib.i18n import smart_str
  32. from desktop.lib.django_util import JsonResponse
  33. from desktop.models import Document2, Document
  34. from indexer.file_format import HiveFormat
  35. from indexer.fields import Field
  36. from notebook.connectors.base import Notebook, QueryExpired, SessionExpired, QueryError, _get_snippet_name
  37. from notebook.connectors.dataeng import DataEngApi
  38. from notebook.connectors.hiveserver2 import HS2Api
  39. from notebook.connectors.oozie_batch import OozieApi
  40. from notebook.decorators import api_error_handler, check_document_access_permission, check_document_modify_permission
  41. from notebook.models import escape_rows, make_notebook, upgrade_session_properties, get_api
  42. from notebook.views import upgrade_session_properties, get_api
  43. if sys.version_info[0] > 2:
  44. import urllib.request, urllib.error
  45. from urllib.parse import unquote as urllib_unquote
  46. else:
  47. from urllib import unquote as urllib_unquote
  48. LOG = logging.getLogger(__name__)
  49. DEFAULT_HISTORY_NAME = ''
  50. @require_POST
  51. @api_error_handler
  52. def create_notebook(request):
  53. response = {'status': -1}
  54. editor_type = request.POST.get('type', 'notebook')
  55. directory_uuid = request.POST.get('directory_uuid')
  56. editor = Notebook()
  57. data = editor.get_data()
  58. if editor_type != 'notebook':
  59. data['name'] = ''
  60. data['type'] = 'query-%s' % editor_type # TODO: Add handling for non-SQL types
  61. data['directoryUuid'] = directory_uuid
  62. editor.data = json.dumps(data)
  63. response['notebook'] = editor.get_data()
  64. response['status'] = 0
  65. return JsonResponse(response)
  66. @require_POST
  67. @check_document_access_permission
  68. @api_error_handler
  69. def create_session(request):
  70. response = {'status': -1}
  71. session = json.loads(request.POST.get('session', '{}'))
  72. properties = session.get('properties', [])
  73. response['session'] = get_api(request, session).create_session(lang=session['type'], properties=properties)
  74. response['status'] = 0
  75. return JsonResponse(response)
  76. @require_POST
  77. @check_document_access_permission
  78. @api_error_handler
  79. def close_session(request):
  80. response = {'status': -1}
  81. session = json.loads(request.POST.get('session', '{}'))
  82. response['session'] = get_api(request, {'type': session['type']}).close_session(session=session)
  83. response['status'] = 0
  84. return JsonResponse(response)
  85. def _execute_notebook(request, notebook, snippet):
  86. response = {'status': -1}
  87. result = None
  88. history = None
  89. historify = (notebook['type'] != 'notebook' or snippet.get('wasBatchExecuted')) and not notebook.get('skipHistorify')
  90. try:
  91. try:
  92. session = notebook.get('sessions') and notebook['sessions'][0] # Session reference for snippet execution without persisting it
  93. if historify:
  94. history = _historify(notebook, request.user)
  95. notebook = Notebook(document=history).get_data()
  96. interpreter = get_api(request, snippet)
  97. if snippet.get('interface') == 'sqlalchemy':
  98. interpreter.options['session'] = session
  99. with opentracing.tracer.start_span('interpreter') as span:
  100. response['handle'] = interpreter.execute(notebook, snippet)
  101. # Retrieve and remove the result from the handle
  102. if response['handle'].get('sync'):
  103. result = response['handle'].pop('result')
  104. finally:
  105. if historify:
  106. _snippet = [s for s in notebook['snippets'] if s['id'] == snippet['id']][0]
  107. if 'handle' in response: # No failure
  108. _snippet['result']['handle'] = response['handle']
  109. _snippet['result']['statements_count'] = response['handle'].get('statements_count', 1)
  110. _snippet['result']['statement_id'] = response['handle'].get('statement_id', 0)
  111. _snippet['result']['handle']['statement'] = response['handle'].get('statement', snippet['statement']).strip() # For non HS2, as non multi query yet
  112. else:
  113. _snippet['status'] = 'failed'
  114. if history: # If _historify failed, history will be None. If we get Atomic block exception, something underneath interpreter.execute() crashed and is not handled.
  115. history.update_data(notebook)
  116. history.save()
  117. response['history_id'] = history.id
  118. response['history_uuid'] = history.uuid
  119. if notebook['isSaved']: # Keep track of history of saved queries
  120. response['history_parent_uuid'] = history.dependencies.filter(type__startswith='query-').latest('last_modified').uuid
  121. except QueryError as ex: # We inject the history information from _historify() to the failed queries
  122. if response.get('history_id'):
  123. ex.extra['history_id'] = response['history_id']
  124. if response.get('history_uuid'):
  125. ex.extra['history_uuid'] = response['history_uuid']
  126. if response.get('history_parent_uuid'):
  127. ex.extra['history_parent_uuid'] = response['history_parent_uuid']
  128. raise ex
  129. # Inject and HTML escape results
  130. if result is not None:
  131. response['result'] = result
  132. response['result']['data'] = escape_rows(result['data'])
  133. response['status'] = 0
  134. return response
  135. @require_POST
  136. @check_document_access_permission
  137. @api_error_handler
  138. def execute(request, engine=None):
  139. notebook = json.loads(request.POST.get('notebook', '{}'))
  140. snippet = json.loads(request.POST.get('snippet', '{}'))
  141. with opentracing.tracer.start_span('notebook-execute') as span:
  142. span.set_tag('user-id', request.user.username)
  143. response = _execute_notebook(request, notebook, snippet)
  144. span.set_tag(
  145. 'query-id',
  146. response['handle']['guid'] if response.get('handle') and response['handle'].get('guid') else None
  147. )
  148. return JsonResponse(response)
  149. @require_POST
  150. @check_document_access_permission
  151. @api_error_handler
  152. def check_status(request):
  153. response = {'status': -1}
  154. notebook = json.loads(request.POST.get('notebook', '{}'))
  155. snippet = json.loads(request.POST.get('snippet', '{}'))
  156. if not snippet:
  157. nb_doc = Document2.objects.get_by_uuid(user=request.user, uuid=notebook['id'])
  158. notebook = Notebook(document=nb_doc).get_data()
  159. snippet = notebook['snippets'][0]
  160. try:
  161. with opentracing.tracer.start_span('notebook-check_status') as span:
  162. span.set_tag('user-id', request.user.username)
  163. span.set_tag(
  164. 'query-id',
  165. snippet['result']['handle']['guid'] if snippet['result'].get('handle') and snippet['result']['handle'].get('guid') else None
  166. )
  167. response['query_status'] = get_api(request, snippet).check_status(notebook, snippet)
  168. response['status'] = 0
  169. except SessionExpired:
  170. response['status'] = 'expired'
  171. raise
  172. except QueryExpired:
  173. response['status'] = 'expired'
  174. raise
  175. finally:
  176. if response['status'] == 0 and snippet['status'] != response['query_status']:
  177. status = response['query_status']['status']
  178. elif response['status'] == 'expired':
  179. status = 'expired'
  180. else:
  181. status = 'failed'
  182. if notebook['type'].startswith('query') or notebook.get('isManaged'):
  183. nb_doc = Document2.objects.get(id=notebook['id'])
  184. if nb_doc.can_write(request.user):
  185. nb = Notebook(document=nb_doc).get_data()
  186. if status != nb['snippets'][0]['status']:
  187. nb['snippets'][0]['status'] = status
  188. nb_doc.update_data(nb)
  189. nb_doc.save()
  190. return JsonResponse(response)
  191. @require_POST
  192. @check_document_access_permission
  193. @api_error_handler
  194. def fetch_result_data(request):
  195. response = {'status': -1}
  196. notebook = json.loads(request.POST.get('notebook', '{}'))
  197. snippet = json.loads(request.POST.get('snippet', '{}'))
  198. rows = json.loads(request.POST.get('rows', '100'))
  199. start_over = json.loads(request.POST.get('startOver', 'false'))
  200. with opentracing.tracer.start_span('notebook-fetch_result_data') as span:
  201. response['result'] = get_api(request, snippet).fetch_result(notebook, snippet, rows, start_over)
  202. span.set_tag('user-id', request.user.username)
  203. span.set_tag(
  204. 'query-id',
  205. snippet['result']['handle']['guid'] if snippet['result'].get('handle') and snippet['result']['handle'].get('guid') else None
  206. )
  207. # Materialize and HTML escape results
  208. if response['result'].get('data') and response['result'].get('type') == 'table' and not response['result'].get('isEscaped'):
  209. response['result']['data'] = escape_rows(response['result']['data'])
  210. response['result']['isEscaped'] = True
  211. response['status'] = 0
  212. return JsonResponse(response)
  213. @require_POST
  214. @check_document_access_permission
  215. @api_error_handler
  216. def fetch_result_metadata(request):
  217. response = {'status': -1}
  218. notebook = json.loads(request.POST.get('notebook', '{}'))
  219. snippet = json.loads(request.POST.get('snippet', '{}'))
  220. with opentracing.tracer.start_span('notebook-fetch_result_metadata') as span:
  221. response['result'] = get_api(request, snippet).fetch_result_metadata(notebook, snippet)
  222. span.set_tag('user-id', request.user.username)
  223. span.set_tag(
  224. 'query-id',
  225. snippet['result']['handle']['guid'] if snippet['result'].get('handle') and snippet['result']['handle'].get('guid') else None
  226. )
  227. response['status'] = 0
  228. return JsonResponse(response)
  229. @require_POST
  230. @check_document_access_permission
  231. @api_error_handler
  232. def fetch_result_size(request):
  233. response = {'status': -1}
  234. notebook = json.loads(request.POST.get('notebook', '{}'))
  235. snippet = json.loads(request.POST.get('snippet', '{}'))
  236. with opentracing.tracer.start_span('notebook-fetch_result_size') as span:
  237. response['result'] = get_api(request, snippet).fetch_result_size(notebook, snippet)
  238. span.set_tag('user-id', request.user.username)
  239. span.set_tag(
  240. 'query-id',
  241. snippet['result']['handle']['guid'] if snippet['result'].get('handle') and snippet['result']['handle'].get('guid') else None
  242. )
  243. response['status'] = 0
  244. return JsonResponse(response)
  245. @require_POST
  246. @check_document_access_permission
  247. @api_error_handler
  248. def cancel_statement(request):
  249. response = {'status': -1}
  250. notebook = json.loads(request.POST.get('notebook', '{}'))
  251. nb_doc = Document2.objects.get_by_uuid(user=request.user, uuid=notebook['uuid'])
  252. notebook = Notebook(document=nb_doc).get_data()
  253. snippet = notebook['snippets'][0]
  254. with opentracing.tracer.start_span('notebook-cancel_statement') as span:
  255. response['result'] = get_api(request, snippet).cancel(notebook, snippet)
  256. span.set_tag('user-id', request.user.username)
  257. span.set_tag(
  258. 'query-id',
  259. snippet['result']['handle']['guid'] if snippet['result'].get('handle') and snippet['result']['handle'].get('guid') else None
  260. )
  261. response['status'] = 0
  262. return JsonResponse(response)
  263. @require_POST
  264. @check_document_access_permission
  265. @api_error_handler
  266. def get_logs(request):
  267. response = {'status': -1}
  268. notebook = json.loads(request.POST.get('notebook', '{}'))
  269. snippet = json.loads(request.POST.get('snippet', '{}'))
  270. startFrom = request.POST.get('from')
  271. startFrom = int(startFrom) if startFrom else None
  272. size = request.POST.get('size')
  273. size = int(size) if size else None
  274. full_log = smart_str(request.POST.get('full_log', ''))
  275. db = get_api(request, snippet)
  276. with opentracing.tracer.start_span('notebook-get_logs') as span:
  277. logs = smart_str(db.get_log(notebook, snippet, startFrom=startFrom, size=size))
  278. span.set_tag('user-id', request.user.username)
  279. span.set_tag(
  280. 'query-id',
  281. snippet['result']['handle']['guid'] if snippet['result'].get('handle') and snippet['result']['handle'].get('guid') else None
  282. )
  283. full_log += logs
  284. jobs = db.get_jobs(notebook, snippet, full_log)
  285. response['logs'] = logs.strip()
  286. response['progress'] = min(db.progress(notebook, snippet, logs=full_log), 99) if snippet['status'] != 'available' and snippet['status'] != 'success' else 100
  287. response['jobs'] = jobs
  288. response['isFullLogs'] = db.get_log_is_full_log(notebook, snippet)
  289. response['status'] = 0
  290. return JsonResponse(response)
  291. def _save_notebook(notebook, user):
  292. notebook_type = notebook.get('type', 'notebook')
  293. save_as = False
  294. if notebook.get('parentSavedQueryUuid'): # We save into the original saved query, not into the query history
  295. notebook_doc = Document2.objects.get_by_uuid(user=user, uuid=notebook['parentSavedQueryUuid'])
  296. elif notebook.get('id'):
  297. notebook_doc = Document2.objects.get(id=notebook['id'])
  298. else:
  299. notebook_doc = Document2.objects.create(name=notebook['name'], uuid=notebook['uuid'], type=notebook_type, owner=user)
  300. Document.objects.link(notebook_doc, owner=notebook_doc.owner, name=notebook_doc.name, description=notebook_doc.description, extra=notebook_type)
  301. save_as = True
  302. if notebook.get('directoryUuid'):
  303. notebook_doc.parent_directory = Document2.objects.get_by_uuid(user=user, uuid=notebook.get('directoryUuid'), perm_type='write')
  304. else:
  305. notebook_doc.parent_directory = Document2.objects.get_home_directory(user)
  306. notebook['isSaved'] = True
  307. notebook['isHistory'] = False
  308. notebook['id'] = notebook_doc.id
  309. _clear_sessions(notebook)
  310. notebook_doc1 = notebook_doc._get_doc1(doc2_type=notebook_type)
  311. notebook_doc.update_data(notebook)
  312. notebook_doc.search = _get_statement(notebook)
  313. notebook_doc.name = notebook_doc1.name = notebook['name']
  314. notebook_doc.description = notebook_doc1.description = notebook['description']
  315. notebook_doc.save()
  316. notebook_doc1.save()
  317. return notebook_doc, save_as
  318. @api_error_handler
  319. @require_POST
  320. @check_document_modify_permission()
  321. def save_notebook(request):
  322. response = {'status': -1}
  323. notebook = json.loads(request.POST.get('notebook', '{}'))
  324. notebook_doc, save_as = _save_notebook(notebook, request.user)
  325. response['status'] = 0
  326. response['save_as'] = save_as
  327. response.update(notebook_doc.to_dict())
  328. response['message'] = request.POST.get('editorMode') == 'true' and _('Query saved successfully') or _('Notebook saved successfully')
  329. return JsonResponse(response)
  330. def _clear_sessions(notebook):
  331. notebook['sessions'] = [_s for _s in notebook['sessions'] if _s['type'] in ('scala', 'spark', 'pyspark', 'sparkr', 'r')]
  332. def _historify(notebook, user):
  333. query_type = notebook['type']
  334. name = notebook['name'] if (notebook['name'] and notebook['name'].strip() != '') else DEFAULT_HISTORY_NAME
  335. is_managed = notebook.get('isManaged') == True # Prevents None
  336. if is_managed and Document2.objects.filter(uuid=notebook['uuid']).exists():
  337. history_doc = Document2.objects.get(uuid=notebook['uuid'])
  338. else:
  339. history_doc = Document2.objects.create(
  340. name=name,
  341. type=query_type,
  342. owner=user,
  343. is_history=True,
  344. is_managed=is_managed
  345. )
  346. # Link history of saved query
  347. if notebook['isSaved']:
  348. parent_doc = Document2.objects.get(uuid=notebook.get('parentSavedQueryUuid') or notebook['uuid']) # From previous history query or initial saved query
  349. notebook['parentSavedQueryUuid'] = parent_doc.uuid
  350. history_doc.dependencies.add(parent_doc)
  351. if not is_managed:
  352. Document.objects.link(
  353. history_doc,
  354. name=history_doc.name,
  355. owner=history_doc.owner,
  356. description=history_doc.description,
  357. extra=query_type
  358. )
  359. notebook['uuid'] = history_doc.uuid
  360. _clear_sessions(notebook)
  361. history_doc.update_data(notebook)
  362. history_doc.search = _get_statement(notebook)
  363. history_doc.save()
  364. return history_doc
  365. def _get_statement(notebook):
  366. if notebook['snippets'] and len(notebook['snippets']) > 0:
  367. return Notebook.statement_with_variables(notebook['snippets'][0])
  368. return ''
  369. @require_GET
  370. @api_error_handler
  371. @check_document_access_permission
  372. def get_history(request):
  373. response = {'status': -1}
  374. doc_type = request.GET.get('doc_type')
  375. doc_text = request.GET.get('doc_text')
  376. page = min(int(request.GET.get('page', 1)), 100)
  377. limit = min(int(request.GET.get('limit', 50)), 100)
  378. is_notification_manager = request.GET.get('is_notification_manager', 'false') == 'true'
  379. if is_notification_manager:
  380. docs = Document2.objects.get_tasks_history(user=request.user)
  381. else:
  382. docs = Document2.objects.get_history(doc_type='query-%s' % doc_type, user=request.user)
  383. if doc_text:
  384. docs = docs.filter(Q(name__icontains=doc_text) | Q(description__icontains=doc_text) | Q(search__icontains=doc_text))
  385. # Paginate
  386. docs = docs.order_by('-last_modified')
  387. response['count'] = docs.count()
  388. docs = __paginate(page, limit, queryset=docs)['documents']
  389. history = []
  390. for doc in docs:
  391. notebook = Notebook(document=doc).get_data()
  392. if 'snippets' in notebook:
  393. statement = notebook['description'] if is_notification_manager else _get_statement(notebook)
  394. history.append({
  395. 'name': doc.name,
  396. 'id': doc.id,
  397. 'uuid': doc.uuid,
  398. 'type': doc.type,
  399. 'data': {
  400. 'statement': statement[:1001] if statement else '',
  401. 'lastExecuted': notebook['snippets'][0].get('lastExecuted', -1),
  402. 'status': notebook['snippets'][0]['status'],
  403. 'parentSavedQueryUuid': notebook.get('parentSavedQueryUuid', '')
  404. } if notebook['snippets'] else {},
  405. 'absoluteUrl': doc.get_absolute_url(),
  406. })
  407. else:
  408. LOG.error('Incomplete History Notebook: %s' % notebook)
  409. response['history'] = sorted(history, key=lambda row: row['data']['lastExecuted'], reverse=True)
  410. response['message'] = _('History fetched')
  411. response['status'] = 0
  412. return JsonResponse(response)
  413. @require_POST
  414. @api_error_handler
  415. @check_document_modify_permission()
  416. def clear_history(request):
  417. response = {'status': -1}
  418. notebook = json.loads(request.POST.get('notebook'), '{}')
  419. doc_type = request.POST.get('doc_type')
  420. is_notification_manager = request.POST.get('is_notification_manager', 'false') == 'true'
  421. if is_notification_manager:
  422. history = Document2.objects.get_tasks_history(user=request.user)
  423. else:
  424. history = Document2.objects.get_history(doc_type='query-%s' % doc_type, user=request.user)
  425. response['updated'] = history.delete()
  426. response['message'] = _('History cleared !')
  427. response['status'] = 0
  428. return JsonResponse(response)
  429. @require_GET
  430. @check_document_access_permission
  431. def open_notebook(request):
  432. response = {'status': -1}
  433. notebook_id = request.GET.get('notebook')
  434. notebook = Notebook(document=Document2.objects.get(id=notebook_id))
  435. notebook = upgrade_session_properties(request, notebook)
  436. response['status'] = 0
  437. response['notebook'] = notebook.get_json()
  438. response['message'] = _('Notebook loaded successfully')
  439. @require_POST
  440. @check_document_access_permission
  441. def close_notebook(request):
  442. response = {'status': -1, 'result': []}
  443. notebook = json.loads(request.POST.get('notebook', '{}'))
  444. for session in [_s for _s in notebook['sessions'] if _s['type'] in ('scala', 'spark', 'pyspark', 'sparkr', 'r')]:
  445. try:
  446. response['result'].append(get_api(request, session).close_session(session))
  447. except QueryExpired:
  448. pass
  449. except Exception as e:
  450. LOG.exception('Error closing session %s' % str(e))
  451. for snippet in [_s for _s in notebook['snippets'] if _s['type'] in ('hive', 'impala')]:
  452. try:
  453. if snippet['status'] != 'running':
  454. response['result'].append(get_api(request, snippet).close_statement(notebook, snippet))
  455. else:
  456. LOG.info('Not closing SQL snippet as still running.')
  457. except QueryExpired:
  458. pass
  459. except Exception as e:
  460. LOG.exception('Error closing statement %s' % str(e))
  461. response['status'] = 0
  462. response['message'] = _('Notebook closed successfully')
  463. return JsonResponse(response)
  464. @require_POST
  465. @check_document_access_permission
  466. def close_statement(request):
  467. response = {'status': -1}
  468. # Passed by check_document_access_permission but unused by APIs
  469. notebook = json.loads(request.POST.get('notebook', '{}'))
  470. nb_doc = Document2.objects.get_by_uuid(user=request.user, uuid=notebook['uuid'])
  471. notebook = Notebook(document=nb_doc).get_data()
  472. snippet = notebook['snippets'][0]
  473. try:
  474. with opentracing.tracer.start_span('notebook-close_statement') as span:
  475. response['result'] = get_api(request, snippet).close_statement(notebook, snippet)
  476. span.set_tag('user-id', request.user.username)
  477. span.set_tag(
  478. 'query-id',
  479. snippet['result']['handle']['guid'] if snippet['result'].get('handle') and snippet['result']['handle'].get('guid') else None
  480. )
  481. except QueryExpired:
  482. pass
  483. response['status'] = 0
  484. response['message'] = _('Statement closed !')
  485. return JsonResponse(response)
  486. @require_POST
  487. @check_document_access_permission
  488. @api_error_handler
  489. def autocomplete(request, server=None, database=None, table=None, column=None, nested=None):
  490. response = {'status': -1}
  491. # Passed by check_document_access_permission but unused by APIs
  492. notebook = json.loads(request.POST.get('notebook', '{}'))
  493. snippet = json.loads(request.POST.get('snippet', '{}'))
  494. try:
  495. autocomplete_data = get_api(request, snippet).autocomplete(snippet, database, table, column, nested)
  496. response.update(autocomplete_data)
  497. except QueryExpired:
  498. pass
  499. response['status'] = 0
  500. return JsonResponse(response)
  501. @require_POST
  502. @check_document_access_permission
  503. @api_error_handler
  504. def get_sample_data(request, server=None, database=None, table=None, column=None):
  505. response = {'status': -1}
  506. # Passed by check_document_access_permission but unused by APIs
  507. notebook = json.loads(request.POST.get('notebook', '{}'))
  508. snippet = json.loads(request.POST.get('snippet', '{}'))
  509. async = json.loads(request.POST.get('async', 'false'))
  510. operation = json.loads(request.POST.get('operation', '"default"'))
  511. sample_data = get_api(request, snippet).get_sample_data(snippet, database, table, column, async=async, operation=operation)
  512. response.update(sample_data)
  513. response['status'] = 0
  514. return JsonResponse(response)
  515. @require_POST
  516. @check_document_access_permission
  517. @api_error_handler
  518. def explain(request):
  519. response = {'status': -1}
  520. notebook = json.loads(request.POST.get('notebook', '{}'))
  521. snippet = json.loads(request.POST.get('snippet', '{}'))
  522. response = get_api(request, snippet).explain(notebook, snippet)
  523. return JsonResponse(response)
  524. @require_POST
  525. @api_error_handler
  526. def format(request):
  527. response = {'status': 0}
  528. statements = request.POST.get('statements', '')
  529. response['formatted_statements'] = sqlparse.format(statements, reindent=True, keyword_case='upper') # SQL only currently
  530. return JsonResponse(response)
  531. @require_POST
  532. @check_document_access_permission
  533. @api_error_handler
  534. def export_result(request):
  535. response = {'status': -1, 'message': _('Success')}
  536. # Passed by check_document_access_permission but unused by APIs
  537. notebook = json.loads(request.POST.get('notebook', '{}'))
  538. snippet = json.loads(request.POST.get('snippet', '{}'))
  539. data_format = json.loads(request.POST.get('format', '"hdfs-file"'))
  540. destination = urllib_unquote(json.loads(request.POST.get('destination', '""')))
  541. overwrite = json.loads(request.POST.get('overwrite', 'false'))
  542. is_embedded = json.loads(request.POST.get('is_embedded', 'false'))
  543. start_time = json.loads(request.POST.get('start_time', '-1'))
  544. api = get_api(request, snippet)
  545. if data_format == 'hdfs-file': # Blocking operation, like downloading
  546. if request.fs.isdir(destination):
  547. if notebook.get('name'):
  548. destination += '/%(name)s.csv' % notebook
  549. else:
  550. destination += '/%(type)s-%(id)s.csv' % notebook
  551. if overwrite and request.fs.exists(destination):
  552. request.fs.do_as_user(request.user.username, request.fs.rmtree, destination)
  553. response['watch_url'] = api.export_data_as_hdfs_file(snippet, destination, overwrite)
  554. response['status'] = 0
  555. request.audit = {
  556. 'operation': 'EXPORT',
  557. 'operationText': 'User %s exported to HDFS destination: %s' % (request.user.username, destination),
  558. 'allowed': True
  559. }
  560. elif data_format == 'hive-table':
  561. if is_embedded:
  562. sql, success_url = api.export_data_as_table(notebook, snippet, destination)
  563. task = make_notebook(
  564. name=_('Export %s query to table %s') % (snippet['type'], destination),
  565. description=_('Query %s to %s') % (_get_snippet_name(notebook), success_url),
  566. editor_type=snippet['type'],
  567. statement=sql,
  568. status='ready',
  569. database=snippet['database'],
  570. on_success_url=success_url,
  571. last_executed=start_time,
  572. is_task=True
  573. )
  574. response = task.execute(request)
  575. else:
  576. notebook_id = notebook['id'] or request.GET.get('editor', request.GET.get('notebook'))
  577. response['watch_url'] = reverse('notebook:execute_and_watch') + '?action=save_as_table&notebook=' + str(notebook_id) + '&snippet=0&destination=' + destination
  578. response['status'] = 0
  579. request.audit = {
  580. 'operation': 'EXPORT',
  581. 'operationText': 'User %s exported to Hive table: %s' % (request.user.username, destination),
  582. 'allowed': True
  583. }
  584. elif data_format == 'hdfs-directory':
  585. if destination.lower().startswith("abfs"):
  586. destination = abfspath(destination)
  587. if is_embedded:
  588. sql, success_url = api.export_large_data_to_hdfs(notebook, snippet, destination)
  589. task = make_notebook(
  590. name=_('Export %s query to directory') % snippet['type'],
  591. description=_('Query %s to %s') % (_get_snippet_name(notebook), success_url),
  592. editor_type=snippet['type'],
  593. statement=sql,
  594. status='ready-execute',
  595. database=snippet['database'],
  596. on_success_url=success_url,
  597. last_executed=start_time,
  598. is_task=True
  599. )
  600. response = task.execute(request)
  601. else:
  602. notebook_id = notebook['id'] or request.GET.get('editor', request.GET.get('notebook'))
  603. response['watch_url'] = reverse('notebook:execute_and_watch') + '?action=insert_as_query&notebook=' + str(notebook_id) + '&snippet=0&destination=' + destination
  604. response['status'] = 0
  605. request.audit = {
  606. 'operation': 'EXPORT',
  607. 'operationText': 'User %s exported to HDFS directory: %s' % (request.user.username, destination),
  608. 'allowed': True
  609. }
  610. elif data_format in ('search-index', 'dashboard'):
  611. # Open the result in the Dashboard via a SQL sub-query or the Import wizard (quick vs scalable)
  612. if is_embedded:
  613. notebook_id = notebook['id'] or request.GET.get('editor', request.GET.get('notebook'))
  614. if data_format == 'dashboard':
  615. engine = notebook['type'].replace('query-', '')
  616. response['watch_url'] = reverse('dashboard:browse', kwargs={'name': notebook_id}) + '?source=query&engine=%(engine)s' % {'engine': engine}
  617. response['status'] = 0
  618. else:
  619. sample = get_api(request, snippet).fetch_result(notebook, snippet, rows=4, start_over=True)
  620. for col in sample['meta']:
  621. col['type'] = HiveFormat.FIELD_TYPE_TRANSLATE.get(col['type'], 'string')
  622. response['status'] = 0
  623. response['id'] = notebook_id
  624. response['name'] = _get_snippet_name(notebook)
  625. response['source_type'] = 'query'
  626. response['target_type'] = 'index'
  627. response['target_path'] = destination
  628. response['sample'] = list(sample['data'])
  629. response['columns'] = [
  630. Field(col['name'], col['type']).to_dict() for col in sample['meta']
  631. ]
  632. else:
  633. notebook_id = notebook['id'] or request.GET.get('editor', request.GET.get('notebook'))
  634. response['watch_url'] = reverse('notebook:execute_and_watch') + '?action=index_query&notebook=' + str(notebook_id) + '&snippet=0&destination=' + destination
  635. response['status'] = 0
  636. if response.get('status') != 0:
  637. response['message'] = _('Exporting result failed.')
  638. return JsonResponse(response)
  639. @require_POST
  640. @check_document_access_permission
  641. @api_error_handler
  642. def statement_risk(request):
  643. response = {'status': -1, 'message': ''}
  644. notebook = json.loads(request.POST.get('notebook', '{}'))
  645. snippet = json.loads(request.POST.get('snippet', '{}'))
  646. api = HS2Api(request.user, snippet)
  647. response['query_complexity'] = api.statement_risk(notebook, snippet)
  648. response['status'] = 0
  649. return JsonResponse(response)
  650. @require_POST
  651. @check_document_access_permission
  652. @api_error_handler
  653. def statement_compatibility(request):
  654. response = {'status': -1, 'message': ''}
  655. notebook = json.loads(request.POST.get('notebook', '{}'))
  656. snippet = json.loads(request.POST.get('snippet', '{}'))
  657. source_platform = request.POST.get('sourcePlatform')
  658. target_platform = request.POST.get('targetPlatform')
  659. api = get_api(request, snippet)
  660. response['query_compatibility'] = api.statement_compatibility(notebook, snippet, source_platform=source_platform, target_platform=target_platform)
  661. response['status'] = 0
  662. return JsonResponse(response)
  663. @require_POST
  664. @check_document_access_permission
  665. @api_error_handler
  666. def statement_similarity(request):
  667. response = {'status': -1, 'message': ''}
  668. notebook = json.loads(request.POST.get('notebook', '{}'))
  669. snippet = json.loads(request.POST.get('snippet', '{}'))
  670. source_platform = request.POST.get('sourcePlatform')
  671. api = get_api(request, snippet)
  672. response['statement_similarity'] = api.statement_similarity(notebook, snippet, source_platform=source_platform)
  673. response['status'] = 0
  674. return JsonResponse(response)
  675. @require_POST
  676. @check_document_access_permission
  677. @api_error_handler
  678. def get_external_statement(request):
  679. response = {'status': -1, 'message': ''}
  680. notebook = json.loads(request.POST.get('notebook', '{}'))
  681. snippet = json.loads(request.POST.get('snippet', '{}'))
  682. if snippet.get('statementType') == 'file':
  683. response['statement'] = _get_statement_from_file(request.user, request.fs, snippet)
  684. elif snippet.get('statementType') == 'document':
  685. notebook = Notebook(Document2.objects.get_by_uuid(user=request.user, uuid=snippet['associatedDocumentUuid'], perm_type='read'))
  686. response['statement'] = notebook.get_str()
  687. response['status'] = 0
  688. return JsonResponse(response)
  689. def _get_statement_from_file(user, fs, snippet):
  690. script_path = snippet['statementPath']
  691. if script_path:
  692. script_path = script_path.replace('hdfs://', '')
  693. if fs.do_as_user(user, fs.isfile, script_path):
  694. return fs.do_as_user(user, fs.read, script_path, 0, 16 * 1024 ** 2)
  695. @require_POST
  696. @api_error_handler
  697. def describe(request, database, table=None, column=None):
  698. response = {'status': -1, 'message': ''}
  699. notebook = json.loads(request.POST.get('notebook', '{}'))
  700. source_type = request.POST.get('source_type', '')
  701. snippet = {'type': source_type}
  702. describe = get_api(request, snippet).describe(notebook, snippet, database, table, column=column)
  703. response.update(describe)
  704. return JsonResponse(response)