2010-05-28 00:26:49 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
|
|
|
|
|
|
|
|
###############################################################################
|
|
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
# Copyright (c) 2008-2010 Raoul Snyman #
|
|
|
|
# Portions copyright (c) 2008-2010 Tim Bentley, Jonathan Corwin, Michael #
|
|
|
|
# Gorven, Scott Guerrieri, Christian Richter, Maikel Stuivenberg, Martin #
|
|
|
|
# Thompson, Jon Tibble, Carsten Tinggaard #
|
|
|
|
# --------------------------------------------------------------------------- #
|
|
|
|
# This program is free software; you can redistribute it and/or modify it #
|
|
|
|
# under the terms of the GNU General Public License as published by the Free #
|
|
|
|
# Software Foundation; version 2 of the License. #
|
|
|
|
# #
|
|
|
|
# This program is distributed in the hope that it will be useful, but WITHOUT #
|
|
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or #
|
|
|
|
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
|
|
|
|
# more details. #
|
|
|
|
# #
|
|
|
|
# You should have received a copy of the GNU General Public License along #
|
|
|
|
# with this program; if not, write to the Free Software Foundation, Inc., 59 #
|
|
|
|
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
|
|
|
|
###############################################################################
|
2010-06-12 01:52:04 +00:00
|
|
|
"""
|
|
|
|
The :mod:`db` module provides the core database functionality for OpenLP
|
|
|
|
"""
|
|
|
|
|
|
|
|
from sqlalchemy import create_engine, MetaData
|
|
|
|
from sqlalchemy.orm import scoped_session, sessionmaker
|
|
|
|
|
|
|
|
def init_db(url, auto_flush=True, auto_commit=False):
|
|
|
|
"""
|
|
|
|
Initialise and return the session and metadata for a database
|
|
|
|
|
|
|
|
``url``
|
|
|
|
The database to initialise connection with
|
|
|
|
|
|
|
|
``auto_flush``
|
|
|
|
Sets the flushing behaviour of the session
|
|
|
|
|
|
|
|
``auto_commit``
|
|
|
|
Sets the commit behaviour of the session
|
|
|
|
"""
|
|
|
|
engine = create_engine(url)
|
|
|
|
metadata = MetaData(bind=engine)
|
|
|
|
session = scoped_session(sessionmaker(autoflush=auto_flush,
|
|
|
|
autocommit=auto_commit, bind=engine))
|
|
|
|
return session, metadata
|
2010-05-28 00:26:49 +00:00
|
|
|
|
|
|
|
class BaseModel(object):
|
|
|
|
"""
|
|
|
|
BaseModel provides a base object with a set of generic functions
|
|
|
|
"""
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def populate(cls, **kwargs):
|
|
|
|
"""
|
|
|
|
Creates an instance of a class and populates it, returning the instance
|
|
|
|
"""
|
|
|
|
me = cls()
|
2010-05-29 20:57:56 +00:00
|
|
|
for key in kwargs:
|
2010-05-28 00:26:49 +00:00
|
|
|
me.__setattr__(key, kwargs[key])
|
|
|
|
return me
|