DBSchema/DBD.pm

   1 package DBIx::DBSchema::DBD;
   2
   3 use strict;
   4 use vars qw($VERSION);
   5
   6 $VERSION = '0.01';
   7
   8 =head1 NAME
   9
  10 DBIx::DBSchema::DBD - DBIx::DBSchema Driver Writer's Guide
  11
  12 =head1 SYNOPSIS
  13
  14   perldoc DBIx::DBSchema::DBD
  15
  16 =head1 DESCRIPTION
  17
  18 Drivers should be named DBIx::DBSchema::DBD::DatabaseName, where DatabaseName
  19 is the same as the DBD:: driver for this database.  Drivers should implement the
  20 following class methods:
  21
  22 =over 4
  23
  24 =item columns CLASS DBI_DBH TABLE
  25
  26 Given an active DBI database handle, return a listref of listrefs (see
  27 L<perllol>), each containing five elements: column name, column type,
  28 nullability, column length, and a field reserved for driver-specific use.
  29
  30 =item primary_key CLASS DBI_DBH TABLE
  31
  32 Given an active DBI database handle, return the primary key for the specified
  33 table.
  34
  35 =item unique CLASS DBI_DBH TABLE
  36
  37 Given an active DBI database handle, return a hashref of unique indices.  The
  38 keys of the hashref are index names, and the values are arrayrefs which point
  39 a list of column names for each.  See L<perldsc/"HASHES OF LISTS"> and
  40 L<DBIx::DBSchema::ColGroup>.
  41
  42 =item index CLASS DBI_DBH TABLE
  43
  44 Given an active DBI database handle, return a hashref of (non-unique) indices.
  45 The keys of the hashref are index names, and the values are arrayrefs which
  46 point a list of column names for each.  See L<perldsc/"HASHES OF LISTS"> and
  47 L<DBIx::DBSchema::ColGroup>.
  48
  49 =back
  50
  51 =head1 AUTHOR
  52
  53 Ivan Kohler <ivan-dbix-dbschema@420.am>
  54
  55 =head1 COPYRIGHT
  56
  57 Copyright (c) 2000 Ivan Kohler
  58 Copyright (c) 2000 Mail Abuse Prevention System LLC
  59 All rights reserved.
  60 This program is free software; you can redistribute it and/or modify it under
  61 the same terms as Perl itself.
  62
  63 =head1 BUGS
  64
  65 =head1 SEE ALSO
  66
  67 L<DBIx::DBSchema>, L<DBIx::DBSchema::DBD::mysql>, L<DBIx::DBSchema::DBD::Pg>,
  68 L<DBIx::DBSchema::ColGroup>, L<DBI>, L<DBI::DBD>, L<perllol>,
  69 L<perldsc/"HASHES OF LISTS">
  70
  71 =cut
  72
  73 1;
  74