GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DBIX::CLASS::SCHEMA::LOADER::DBI::WRITING (3)

.ds Aq ’

NAME

DBIx::Class::Schema::Loader::DBI::Writing - Loader subclass writing guide for DBI

CONTENTS

SYNOPSIS



  package DBIx::Class::Schema::Loader::DBI::Foo;

  # THIS IS JUST A TEMPLATE TO GET YOU STARTED.

  use strict;
  use warnings;
  use base DBIx::Class::Schema::Loader::DBI;
  use mro c3;

  sub _table_uniq_info {
      my ($self, $table) = @_;

      # ... get UNIQUE info for $table somehow
      # and return a data structure that looks like this:

      return [
         [ keyname => [ colname ] ],
         [ keyname2 => [ col1name, col2name ] ],
         [ keyname3 => [ colname ] ],
      ];

      # Where the "keyname"s are just unique identifiers, such as the
      # name of the unique constraint, or the names of the columns involved
      # concatenated if you wish.
  }

  sub _table_comment {
      my ( $self, $table ) = @_;
      return Comment;
  }

  sub _column_comment {
      my ( $self, $table, $column_number ) = @_;
      return Col. comment;
  }

  1;



DETAILS

The only required method for new subclasses is _table_uniq_info, as there is not (yet) any standardized, DBD-agnostic way for obtaining this information from DBI.

The base DBI Loader contains generic methods that *should* work for everything else in theory, although in practice some DBDs need to override one or more of the other methods. The other methods one might likely want to override are: _table_pk_info, _table_fk_info, _tables_list and _extra_column_info. See the included DBD drivers for examples of these.

To import comments from the database you need to implement _table_comment, _column_comment

AUTHOR

See AUTHOR in DBIx::Class::Schema::Loader and CONTRIBUTORS in DBIx::Class::Schema::Loader.

LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DBIX::CLASS::SCHEMA::LOADER::DBI::WRITING (3) 2015-05-13

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.