deb-mistral/mistral/db/v2/api.py
Lingxian Kong 32e36450db Add fields filter for workflow query
With this patch, users could retrieve workflows only with fields they care
about.

NOTE: 'id' must be included in fields if it's provided, since 'id' will be
used when constructing 'next' link.

This feature is just like we specicy '-c' argument in CLI, but it's
implemented in server side(or more precisely, in db layer).

Partially-Implements: blueprint query-result-column-filtering
Change-Id: If034e7ee96aaecf2d5cebefdc85eaa7b3f6f7d8c
2015-08-27 20:38:20 +08:00

454 lines
9.7 KiB
Python

# Copyright 2015 - Mirantis, Inc.
# Copyright 2015 - StackStorm, Inc.
#
# Licensed 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 contextlib
from oslo_db import api as db_api
from oslo_log import log as logging
_BACKEND_MAPPING = {
'sqlalchemy': 'mistral.db.v2.sqlalchemy.api',
}
IMPL = db_api.DBAPI('sqlalchemy', backend_mapping=_BACKEND_MAPPING)
LOG = logging.getLogger(__name__)
def setup_db():
IMPL.setup_db()
def drop_db():
IMPL.drop_db()
# Transaction control.
def start_tx():
IMPL.start_tx()
def commit_tx():
IMPL.commit_tx()
def rollback_tx():
IMPL.rollback_tx()
def end_tx():
IMPL.end_tx()
@contextlib.contextmanager
def transaction():
with IMPL.transaction():
yield
# Locking.
def acquire_lock(model, id):
IMPL.acquire_lock(model, id)
# Workbooks.
def get_workbook(name):
return IMPL.get_workbook(name)
def load_workbook(name):
"""Unlike get_workbook this method is allowed to return None."""
return IMPL.load_workbook(name)
def get_workbooks():
return IMPL.get_workbooks()
def create_workbook(values):
return IMPL.create_workbook(values)
def update_workbook(name, values):
return IMPL.update_workbook(name, values)
def create_or_update_workbook(name, values):
return IMPL.create_or_update_workbook(name, values)
def delete_workbook(name):
IMPL.delete_workbook(name)
def delete_workbooks(**kwargs):
IMPL.delete_workbooks(**kwargs)
# Workflow definitions.
def get_workflow_definition(name):
return IMPL.get_workflow_definition(name)
def get_workflow_definition_by_id(id):
return IMPL.get_workflow_definition_by_id(id)
def load_workflow_definition(name):
"""Unlike get_workflow_definition this method is allowed to return None."""
return IMPL.load_workflow_definition(name)
def get_workflow_definitions(limit=None, marker=None, sort_keys=None,
sort_dirs=None, fields=None, **kwargs):
return IMPL.get_workflow_definitions(
limit=limit,
marker=marker,
sort_keys=sort_keys,
sort_dirs=sort_dirs,
fields=fields,
**kwargs
)
def create_workflow_definition(values):
return IMPL.create_workflow_definition(values)
def update_workflow_definition(name, values):
return IMPL.update_workflow_definition(name, values)
def create_or_update_workflow_definition(name, values):
return IMPL.create_or_update_workflow_definition(name, values)
def delete_workflow_definition(name):
IMPL.delete_workflow_definition(name)
def delete_workflow_definitions(**kwargs):
IMPL.delete_workflow_definitions(**kwargs)
# Action definitions.
def get_action_definition_by_id(id):
return IMPL.get_action_definition_by_id(id)
def get_action_definition(name):
return IMPL.get_action_definition(name)
def load_action_definition(name):
"""Unlike get_action_definition this method is allowed to return None."""
return IMPL.load_action_definition(name)
def get_action_definitions(limit=None, marker=None, sort_keys=['name'],
sort_dirs=None, **kwargs):
return IMPL.get_action_definitions(
limit=limit,
marker=marker,
sort_keys=sort_keys,
sort_dirs=sort_dirs,
**kwargs
)
def create_action_definition(values):
return IMPL.create_action_definition(values)
def update_action_definition(name, values):
return IMPL.update_action_definition(name, values)
def create_or_update_action_definition(name, values):
return IMPL.create_or_update_action_definition(name, values)
def delete_action_definition(name):
return IMPL.delete_action_definition(name)
def delete_action_definitions(**kwargs):
return IMPL.delete_action_definitions(**kwargs)
# Common executions.
def get_execution(id):
return IMPL.get_execution(id)
def load_execution(name):
"""Unlike get_execution this method is allowed to return None."""
return IMPL.load_execution(name)
def get_executions(**kwargs):
return IMPL.get_executions(**kwargs)
def ensure_execution_exists(id):
return IMPL.ensure_execution_exists(id)
def create_execution(values):
return IMPL.create_execution(values)
def update_execution(id, values):
return IMPL.update_execution(id, values)
def create_or_update_execution(id, values):
return IMPL.create_or_update_execution(id, values)
def delete_execution(id):
return IMPL.delete_execution(id)
def delete_executions(**kwargs):
IMPL.delete_executions(**kwargs)
# Action executions.
def get_action_execution(id):
return IMPL.get_action_execution(id)
def load_action_execution(name):
"""Unlike get_action_execution this method is allowed to return None."""
return IMPL.load_action_execution(name)
def get_action_executions(**kwargs):
return IMPL.get_action_executions(**kwargs)
def ensure_action_execution_exists(id):
return IMPL.ensure_action_execution_exists(id)
def create_action_execution(values):
return IMPL.create_action_execution(values)
def update_action_execution(id, values):
return IMPL.update_action_execution(id, values)
def create_or_update_action_execution(id, values):
return IMPL.create_or_update_action_execution(id, values)
def delete_action_execution(id):
return IMPL.delete_action_execution(id)
def delete_action_executions(**kwargs):
IMPL.delete_action_executions(**kwargs)
# Workflow executions.
def get_workflow_execution(id):
return IMPL.get_workflow_execution(id)
def load_workflow_execution(name):
"""Unlike get_workflow_execution this method is allowed to return None."""
return IMPL.load_workflow_execution(name)
def get_workflow_executions(limit=None, marker=None, sort_keys=['created_at'],
sort_dirs=None, **kwargs):
return IMPL.get_workflow_executions(
limit=limit,
marker=marker,
sort_keys=sort_keys,
sort_dirs=sort_dirs,
**kwargs
)
def ensure_workflow_execution_exists(id):
return IMPL.ensure_workflow_execution_exists(id)
def create_workflow_execution(values):
return IMPL.create_workflow_execution(values)
def update_workflow_execution(id, values):
return IMPL.update_workflow_execution(id, values)
def create_or_update_workflow_execution(id, values):
return IMPL.create_or_update_workflow_execution(id, values)
def delete_workflow_execution(id):
return IMPL.delete_workflow_execution(id)
def delete_workflow_executions(**kwargs):
IMPL.delete_workflow_executions(**kwargs)
# Tasks executions.
def get_task_execution(id):
return IMPL.get_task_execution(id)
def load_task_execution(name):
"""Unlike get_task_execution this method is allowed to return None."""
return IMPL.load_task_execution(name)
def get_task_executions(**kwargs):
return IMPL.get_task_executions(**kwargs)
def create_task_execution(values):
return IMPL.create_task_execution(values)
def update_task_execution(id, values):
return IMPL.update_task_execution(id, values)
def create_or_update_task_execution(id, values):
return IMPL.create_or_update_task_execution(id, values)
def delete_task_execution(id):
return IMPL.delete_task_execution(id)
def delete_task_executions(**kwargs):
return IMPL.delete_task_executions(**kwargs)
# Delayed calls.
def get_delayed_calls_to_start(time):
return IMPL.get_delayed_calls_to_start(time)
def create_delayed_call(values):
return IMPL.create_delayed_call(values)
def delete_delayed_call(id):
return IMPL.delete_delayed_call(id)
def update_delayed_call(id, values, query_filter=None):
return IMPL.update_delayed_call(id, values, query_filter)
def get_delayed_call(id):
return IMPL.get_delayed_call(id)
# Cron triggers.
def get_cron_trigger(name):
return IMPL.get_cron_trigger(name)
def load_cron_trigger(name):
"""Unlike get_cron_trigger this method is allowed to return None."""
return IMPL.load_cron_trigger(name)
def get_cron_triggers(**kwargs):
return IMPL.get_cron_triggers(**kwargs)
def get_next_cron_triggers(time):
return IMPL.get_next_cron_triggers(time)
def get_expired_executions(time):
return IMPL.get_expired_executions(time)
def create_cron_trigger(values):
return IMPL.create_cron_trigger(values)
def update_cron_trigger(name, values):
return IMPL.update_cron_trigger(name, values)
def create_or_update_cron_trigger(name, values):
return IMPL.create_or_update_cron_trigger(name, values)
def delete_cron_trigger(name):
return IMPL.delete_cron_trigger(name)
def delete_cron_triggers(**kwargs):
return IMPL.delete_cron_triggers(**kwargs)
# Environments.
def get_environment(name):
return IMPL.get_environment(name)
def load_environment(name):
"""Unlike get_environment this method is allowed to return None."""
return IMPL.load_environment(name)
def get_environments():
return IMPL.get_environments()
def create_environment(values):
return IMPL.create_environment(values)
def update_environment(name, values):
return IMPL.update_environment(name, values)
def create_or_update_environment(name, values):
return IMPL.create_or_update_environment(name, values)
def delete_environment(name):
IMPL.delete_environment(name)
def delete_environments(**kwargs):
IMPL.delete_environments(**kwargs)