Merge lp:~jtv/maas/db-setup into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Database control scripting.

Proposed initial scripting to initialize / start / query / stop / delete databases.

=== modified file 'Makefile'
--- Makefile	2012-01-16 08:33:18 +0000
+++ Makefile	2012-01-16 15:57:24 +0000
@@ -35,6 +35,7 @@
 	bin/django runserver 8000
 
 harness:
+	. bin/maasdb.sh ; maasdb_init_db db/development disposable
 	bin/django shell
 
 syncdb:

=== added directory 'bin'
=== added file 'bin/maasdb.sh'
--- bin/maasdb.sh	1970-01-01 00:00:00 +0000
+++ bin/maasdb.sh	2012-01-16 15:57:24 +0000
@@ -0,0 +1,133 @@
+# MaaS database control functions
+#
+# The control functions take as their first argument a database cluster's data
+# directory.  This is where the database's socket, pidfile, log, and data will
+# reside.  The data directory must start with a slash.
+#
+# Some design choices for this module:
+#
+#  * Everything is PostgreSQL on Ubuntu.
+#  * POSIX shell.  Test your changes in dash, not just in bash.
+#  * Each branch gets its own cluster(s).  Kill & delete when done.
+#  * One database per cluster.  May change this later if it's a problem.
+#  * Databases run under the system user that creates them.  No root required.
+#  * No global configuration apart from a basic PostgreSQL install.
+#  * Connections use Unix sockets.  No TCP port hogging.
+
+POSTGRES_VERSION=9.1
+PGCTL="/usr/lib/postgresql/${POSTGRES_VERSION}/bin/pg_ctl"
+
+
+# Figure out the full data directory path for a given cluster, even if it's a
+# relative path.
+maasdb_locate() {
+    DATADIR="$1"
+    if test -z "$1"
+    then
+        echo "Specify a data directory for the MaaS database cluster." >&2
+        return 1
+    fi
+    if ! echo "$DATADIR" | grep '^/'
+    then
+        echo "`pwd`/$DATADIR"
+    fi
+}
+
+
+# Create a database cluster.
+maasdb_create_cluster() {
+    DATADIR="`maasdb_locate "$1"`"
+    if ! test -d "$DATADIR/base"
+    then
+        mkdir -p -- "$DATADIR"
+        $PGCTL init -D "$DATADIR" -o '-E utf8'
+    fi
+}
+
+
+# Start a database cluster.
+maasdb_start_cluster() {
+    DATADIR="`maasdb_locate "$1"`"
+    # Pass "disposable" as the second argument if the data in this database
+    # is not important at all and you're willing to cut corners for speed.
+    DISPOSABLE="$2"
+
+    if test "$DISPOSABLE" = "disposable"
+    then
+        #  -F -- don't bother fsync'ing.
+        EXTRA_POSTGRES_OPTS="-F"
+    else
+        EXTRA_POSTGRES_OPTS=""
+    fi
+
+    maasdb_create_cluster "$DATADIR"
+
+    if ! test -f "$DATADIR/postmaster.pid"
+    then
+        # pg_ctl options:
+        #  -D <dir> -- data directory.
+        #  -l <file> -- log file.
+        #  -w -- wait until startup is complete.
+        # postgres options:
+        #  -h <arg> -- host name; empty arg means Unix socket only.
+        #  -k -- socket directory.
+        $PGCTL start \
+            -D "$DATADIR" -l "$DATADIR/backend.log" -w \
+            -o "-h '' -k '$DATADIR' $EXTRA_POSTGRES_OPTS"
+    fi
+}
+
+
+# Stop a database cluster.
+maasdb_stop_cluster() {
+    DATADIR="`maasdb_locate "$1"`"
+    if test -f "$DATADIR/postmaster.pid"
+    then
+        $PGCTL stop -D "$DATADIR"
+    fi
+}
+
+
+# Initialize a MaaS database.
+maasdb_init_db() {
+    DATADIR="`maasdb_locate "$1"`"
+    # Pass "disposable" as the second argument if the data in this database
+    # is not important at all and you're willing to cut corners for speed.
+    DISPOSABLE="$2"
+    MARKER="$DATADIR/maas-created"
+    maasdb_start_cluster "$DATADIR" "$DISPOSABLE"
+    if ! test -f "$MARKER"
+    then
+        createdb -h "$DATADIR" maas && touch "$MARKER"
+    fi
+}
+
+
+# Open a psql shell on a MaaS database.
+maasdb_shell() {
+    DATADIR="`maasdb_locate "$1"`"
+    maasdb_init_db "$DATADIR"
+    psql -h "$DATADIR" maas
+}
+
+
+# Execute a query on a MaaS database.
+maasdb_query() {
+    DATADIR="`maasdb_locate "$1"`"
+    QUERY="$2"
+    maasdb_init_db "$DATADIR"
+    psql -h "$DATADIR" maas -c "$QUERY"
+}
+
+
+# Delete an entire MaaS database and cluster.  Use only with extreme care!
+maasdb_delete_cluster() {
+    DATADIR="`maasdb_locate "$1"`"
+    # Before deleting anything, does this at least look like a MaaS database
+    # cluster?
+    if test -d "$DATADIR/base"
+    then
+        maasdb_stop_cluster "$DATADIR"
+        rm -rf -- "$DATADIR"
+    fi
+}

=== modified file 'src/maas/development.py'
--- src/maas/development.py	2012-01-16 10:59:22 +0000
+++ src/maas/development.py	2012-01-16 15:57:24 +0000
@@ -16,12 +16,12 @@
 
 DATABASES = {
     'default': {
-        'ENGINE': 'django.db.backends.postgresql_psycopg2', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
-        'NAME': 'maas',                      # Or path to database file if using sqlite3.
-        'USER': 'maas',                      # Not used with sqlite3.
-        'PASSWORD': 'maas',                  # Not used with sqlite3.
-        'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
-        'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
+        # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' etc.
+        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+        'NAME': 'maas',
+        # For PostgreSQL, a "hostname" starting with a slash indicates a
+        # Unix socket directory.
+        'HOST': '%s/db/development' % os.getcwd(),
     }
 }
 
@@ -32,7 +32,7 @@
 # timezone as the operating system.
 # If running in a Windows environment this must be set to the same as your
 # system time zone.
-TIME_ZONE = 'America/Chicago'
+TIME_ZONE = None
 
 # Language code for this installation. All choices can be found here:
 # http://www.i18nguy.com/unicode/language-identifiers.html