parquet_flask/v1/query_data_doms.py (100 lines of code) (raw):
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from copy import deepcopy
from flask_restx import Resource, Namespace, fields
from flask import request
from parquet_flask.io_logic.query_v2 import QueryProps, QUERY_PROPS_SCHEMA
from parquet_flask.io_logic.query_v4 import QueryV4
from parquet_flask.utils.general_utils import GeneralUtils
api = Namespace('query_data_doms', description="Querying data")
LOGGER = logging.getLogger(__name__)
query_model = api.model('query_data_doms', {
'startIndex': fields.Integer(required=True, example=0),
'itemsPerPage': fields.Integer(required=True, example=0),
'minDepth': fields.Float(required=True, example=-65.34),
'maxDepth': fields.Float(required=True, example=-65.34),
'startTime': fields.String(required=True, example='2020-01-01T00:00:00Z'),
'endTime': fields.String(required=True, example='2020-01-31T00:00:00Z'),
'platform': fields.String(required=True, example='30,3B'),
'provider': fields.Integer(required=True, example=0),
'project': fields.Integer(required=True, example=0),
'columns': fields.String(required=False, example='latitudes, longitudes'),
'variable': fields.String(required=False, example='air_pressure, relative_humidity'),
'bbox': fields.String(required=True, example='-45, 175, -30, 180'), # west, south, east, north
})
@api.route('', methods=["get", "post"], strict_slashes=False)
@api.route('/', methods=["get", "post"], strict_slashes=False)
class IngestParquet(Resource):
def __init__(self, api=None, *args, **kwargs):
super().__init__(api, args, kwargs)
self.__start_from = 0
self.__size = 0
def __calculate_4_ranges(self, total_result):
if self.__size == 0:
return {
'first': 0,
'last': 0,
'prev': 0,
'next': 0,
}
div, mod = divmod(total_result, self.__size)
if mod > 0:
div += 1
page_info = {
'first': 0,
'last': div - 1,
'prev': 0 if self.__start_from == 0 else self.__start_from - 1,
}
page_info['next'] = page_info['last'] if self.__start_from == page_info['last'] else self.__start_from + 1
return page_info
def __replace_start_from(self, new_start_from):
new_args = deepcopy(dict(request.args))
new_args['startIndex'] = new_start_from
return '&'.join([f'{k}={v}' for k, v in new_args.items()])
def __execute_query(self, payload):
"""
TODO: transform the results to:
{
"last": "url",
"prev": "url",
"next": "url",
"first": "url",
"results": ["results"],
"total": "number
}
:param payload:
:return:
"""
is_valid, json_error = GeneralUtils.is_json_valid(payload, QUERY_PROPS_SCHEMA)
if not is_valid:
return {'message': 'invalid request body', 'details': str(json_error)}, 400
try:
query = QueryV4(QueryProps().from_json(payload))
result_set = query.search()
LOGGER.debug(f'search params: {payload}b')
page_info = self.__calculate_4_ranges(result_set['total'])
result_set['last'] = f'{request.base_url}?{self.__replace_start_from(page_info["last"])}'.replace('http://', 'https://')
result_set['first'] = f'{request.base_url}?{self.__replace_start_from(page_info["first"])}'.replace('http://', 'https://')
result_set['next'] = f'{request.base_url}?{self.__replace_start_from(page_info["next"])}'.replace('http://', 'https://')
result_set['prev'] = f'{request.base_url}?{self.__replace_start_from(page_info["prev"])}'.replace('http://', 'https://')
return result_set, 200
except Exception as e:
LOGGER.exception(f'failed to query parquet. cause: {str(e)}')
return {'message': 'failed to query parquet', 'details': str(e)}, 500
@api.expect()
def get(self):
self.__start_from = int(request.args.get('startIndex', '0'))
self.__size = int(request.args.get('itemsPerPage', '10'))
query_json = {
'start_from': self.__start_from,
'size': self.__size,
}
if 'startTime' in request.args:
query_json['min_time'] = request.args.get('startTime')
if 'endTime' in request.args:
query_json['max_time'] = request.args.get('endTime')
if 'minDepth' in request.args:
query_json['min_depth'] = float(request.args.get('minDepth'))
if 'maxDepth' in request.args:
query_json['max_depth'] = float(request.args.get('maxDepth'))
if 'bbox' in request.args:
bounding_box = GeneralUtils.gen_float_list_from_comma_sep_str(request.args.get('bbox'), 4)
query_json['min_lat_lon'] = [bounding_box[1], bounding_box[0]]
query_json['max_lat_lon'] = [bounding_box[3], bounding_box[2]]
if 'platform' in request.args:
query_json['platform_code'] = [k.strip() for k in request.args.get('platform').strip().split(',')]
if 'provider' in request.args:
query_json['provider'] = request.args.get('provider')
if 'project' in request.args:
query_json['project'] = request.args.get('project')
if 'columns' in request.args and request.args.get('columns').strip() != '':
query_json['columns'] = [k.strip() for k in request.args.get('columns').split(',')]
if 'variable' in request.args and request.args.get('variable').strip() != '':
query_json['variable'] = [k.strip() for k in request.args.get('variable').split(',')]
return self.__execute_query(query_json)