DataSource/Driver.pm

   1 package DBIx::DataSource::Driver;
   2
   3 use strict;
   4 use vars qw($VERSION);
   5 use DBI;
   6
   7 $VERSION = '0.01';
   8
   9 =head1 NAME
  10
  11 DBIx::DataSource::Driver - Driver Writer's Guide and base class
  12
  13 =head1 SYNOPSIS
  14
  15   perldoc DBIx::DataSource::Driver;
  16
  17   or
  18
  19   package DBIx::DataSource::FooBase;
  20   use DBIx::DataSource::Driver;
  21   @ISA = qw( DBIx::DataSource::Driver );
  22
  23 =head1 DESCRIPTION
  24
  25 To implement a driver for your database:
  26
  27 1) If you can create a database with an SQL command through DBI/DBD, simply
  28    provide a parse_dsn class method which returns a list consisting of the
  29    *actual* data source to use in DBI->connect and the SQL.
  30
  31        package DBIx::DataSource::NewDatabase;
  32        use DBIx::DataSource::Driver;
  33        @ISA = qw( DBIx::DataSource::Driver );
  34
  35        sub parse_dsn {
  36          my( $class, $action, $dsn ) = @_;
  37
  38          # $action is `create' or `drop'
  39          # for example, if you parse parse $dsn for $database,
  40          # $sql = "$action $database";
  41
  42          # you can die on errors - it'll be caught
  43
  44          ( $new_dsn, $sql );
  45        }
  46
  47 2) Otherwise, you'll need to write B<create_database> and B<drop_database>
  48    class methods.
  49
  50        package DBIx::DataSource::NewDatabase;
  51
  52        sub create_database {
  53          my( $class, $dsn, $user, $pass ) = @_;
  54
  55          # for success, return true
  56          # for failure, die (it'll be caught)
  57        }
  58
  59        sub drop_database {
  60          my( $class, $dsn, $user, $pass ) = @_;
  61
  62          # for success, return true
  63          # for failure, die (it'll be caught)
  64        }
  65
  66 =cut
  67
  68 sub create_database { shift->_sql('create', @_) };
  69 sub drop_database   { shift->_sql('drop',   @_) };
  70
  71 sub _sql {
  72   my( $class, $action, $dsn, $user, $pass ) = @_;
  73   my( $new_dsn, $sql ) = $class->parse_dsn($action, $dsn);
  74   my $dbh = DBI->connect( $new_dsn, $user, $pass ) or die $DBI::errstr;
  75 #  $dbh->do($sql) or die $dbh->errstr;
  76 # silly DBI.  implicit DESTROY yummy.
  77   $dbh->do($sql) or do { my $err = $dbh->errstr; $dbh->disconnect; die $err; };
  78   $dbh->disconnect or die $dbh->errstr;
  79 }
  80
  81 =head1 AUTHOR
  82
  83 Ivan Kohler <ivan-dbix-datasource@420.am>
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright (c) 2000 Ivan Kohler
  88 Copyright (c) 2000 Mail Abuse Prevention System LLC
  89 All rights reserved.
  90 This program is free software; you can redistribute it and/or modify it under
  91 the same terms as Perl itself.
  92
  93 =head1 BUGS
  94
  95 =head1 SEE ALSO
  96
  97 L<DBIx::DataSource>, L<DBIx::DataSource::mysql>, L<DBIx::DataSource::Pg>, L<DBI>
  98
  99 =cut
 100
 101 1;