1 package Koha::Database;
3 # Copyright 2013 Catalyst IT
4 # chrisc@catalyst.net.nz
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 3 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 my $database = Koha::Database->new();
29 my $schema = $database->schema();
39 use base qw(Class::Accessor);
41 __PACKAGE__->mk_accessors(qw( ));
44 # Internal helper function (not a method!). This creates a new
45 # database connection from the data given in the current context, and
49 my $context = C4::Context->new();
50 if ( $context->config("db_scheme") ) {
51 $db_driver = $context->db_scheme2dbi( $context->config("db_scheme") );
57 my $db_name = $context->config("database");
58 my $db_host = $context->config("hostname");
59 my $db_port = $context->config("port") || '';
60 my $db_user = $context->config("user");
61 my $db_passwd = $context->config("pass");
62 my $schema = Koha::Schema->connect(
63 "DBI:$db_driver:dbname=$db_name;host=$db_host;port=$db_port",
64 $db_user, $db_passwd );
70 $schema = $database->schema;
72 Returns a database handle connected to the Koha database for the
73 current context. If no connection has yet been made, this method
74 creates one, and connects to the database.
76 This database handle is cached for future use: if you call
77 C<$database-E<gt>schema> twice, you will get the same handle both
78 times. If you need a second database handle, use C<&new_schema> and
79 possibly C<&set_schema>.
86 if ( defined( $self->{"schema"} ) && $self->{"schema"}->storage->connected() ) {
87 return $self->{"schema"};
90 # No database handle or it died . Create one.
91 $self->{"schema"} = &_new_schema();
93 return $self->{"schema"};
98 $schema = $database->new_schema;
100 Creates a new connection to the Koha database for the current context,
101 and returns the database handle (a C<DBI::db> object).
103 The handle is not saved anywhere: this method is strictly a
104 convenience function; the point is that it knows which database to
105 connect to so that the caller doesn't have to know.
113 return &_new_schema();
118 $my_schema = $database->new_schema;
119 $database->set_schema($my_schema);
121 $database->restore_schema;
123 C<&set_schema> and C<&restore_schema> work in a manner analogous to
124 C<&set_context> and C<&restore_context>.
126 C<&set_schema> saves the current database handle on a stack, then sets
127 the current database handle to C<$my_schema>.
129 C<$my_schema> is assumed to be a good database handle.
135 my $new_schema = shift;
137 # Save the current database handle on the handle stack.
138 # We assume that $new_schema is all good: if the caller wants to
139 # screw himself by passing an invalid handle, that's fine by
141 push @{ $self->{"schema_stack"} }, $self->{"schema"};
142 $self->{"schema"} = $new_schema;
145 =head2 restore_schema
147 $database->restore_schema;
149 Restores the database handle saved by an earlier call to
150 C<$database-E<gt>set_schema>.
157 if ( $#{ $self->{"schema_stack"} } < 0 ) {
160 die "SCHEMA stack underflow";
163 # Pop the old database handle and set it.
164 $self->{"schema"} = pop @{ $self->{"schema_stack"} };
166 # FIXME - If it is determined that restore_context should
167 # return something, then this function should, too.
177 Chris Cormack, E<lt>chrisc@catalyst.net.nzE<gt>