Model Bases¶

Base Query and Model class for sqlalchemy that include project-specific convenience functions and defaults.

Python API Reference¶

class atlas_core.sqlalchemy.BaseQuery(entities, session=None)[source]¶

Base Query object that includes a number of convenience functions for common patterns.

get_or_abort(obj_id, http_code=404)[source]¶: Get an object or return an error code.

first_or_abort(obj_id, http_code=404)[source]¶: Get first result or return an error code.

filter_by_enum(enum, value, possible_values=None, http_code=400)[source]¶

Filters a query object by an enum, testing that it got a valid value.

Parameters:	enum – Enum column from model, e.g. Vehicle.type value – Value to filter by possible_values – None or list of acceptable values for value int (http_code) – pass

class atlas_core.sqlalchemy.BaseModel(**kwargs)[source]¶

Base Model object that sets sane defaults like InnoDB and utf8 for mysql, etc.