~azzar1/unity/add-show-desktop-key

1080.1.2 by matt.giuca
New module: ivle.database. Classes and utilities for Storm ORM.
1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
3
#
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
8
#
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
# GNU General Public License for more details.
13
#
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
18
# Author: Matt Giuca, Will Grant
19
20
"""
21
Database Classes and Utilities for Storm ORM
22
23
This module provides all of the classes which map to database tables.
24
It also provides miscellaneous utility functions for database interaction.
25
"""
26
27
from storm.locals import create_database, Store
28
29
import ivle.conf
30
31
def get_conn_string():
32
    """
33
    Returns the Storm connection string, generated from the conf file.
34
    """
35
    return "postgres://%s:%s@%s:%d/%s" % (ivle.conf.db_user,
36
        ivle.conf.db_password, ivle.conf.db_host, ivle.conf.db_port,
37
        ivle.conf.db_dbname)
38
39
def get_store():
40
    """
41
    Open a database connection and transaction. Return a storm.store.Store
42
    instance connected to the configured IVLE database.
43
    """
44
    return Store(create_database(get_conn_string()))