The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
DBIx-Class-Schema-Loader-0.07010
River stage three • 34 direct dependents • 101 total dependents
45 ++
/ DBIx::Class::Schema::Loader::Base

NAME

DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.

SYNOPSIS

See DBIx::Class::Schema::Loader

DESCRIPTION

This is the base class for the storage-specific DBIx::Class::Schema::* classes, and implements the common functionality between them.

CONSTRUCTOR OPTIONS

These constructor options are the base options for "loader_options" in DBIx::Class::Schema::Loader. Available constructor options are:

skip_relationships

Skip setting up relationships. The default is to attempt the loading of relationships.

skip_load_external

Skip loading of other classes in @INC. The default is to merge all other classes with the same name found in @INC into the schema file we are creating.

naming

Static schemas (ones dumped to disk) will, by default, use the new-style relationship names and singularized Results, unless you're overwriting an existing dump made by an older version of DBIx::Class::Schema::Loader, in which case the backward compatible RelBuilder will be activated, and the appropriate monikerization used.

Specifying

    naming => 'current'

will disable the backward-compatible RelBuilder and use the new-style relationship names along with singularized Results, even when overwriting a dump made with an earlier version.

The option also takes a hashref:

    naming => { relationships => 'v7', monikers => 'v7' }

The keys are:

relationships

How to name relationship accessors.

monikers

How to name Result classes.

column_accessors

How to name column accessors in Result classes.

The values can be:

current

Latest style, whatever that happens to be.

v4

Unsingularlized monikers, has_many only relationships with no _id stripping.

v5

Monikers singularized as whole words, might_have relationships for FKs on UNIQUE constraints, _id stripping for belongs_to relationships.

Some of the _id stripping edge cases in 0.05003 have been reverted for the v5 RelBuilder.

v6

All monikers and relationships are inflected using Lingua::EN::Inflect::Phrase, and there is more aggressive _id stripping from relationship names.

In general, there is very little difference between v5 and v6 schemas.

v7

This mode is identical to v6 mode, except that monikerization of CamelCase table names is also done correctly.

CamelCase column names in case-preserving mode will also be handled correctly for relationship name inflection. See "preserve_case".

In this mode, CamelCase "column_accessors" are normalized based on case transition instead of just being lowercased, so FooId becomes foo_id.

If you don't have any CamelCase table or column names, you can upgrade without breaking any of your code.

Dynamic schemas will always default to the 0.04XXX relationship names and won't singularize Results for backward compatibility, to activate the new RelBuilder and singularization put this in your Schema.pm file:

    __PACKAGE__->naming('current');

Or if you prefer to use 0.07XXX features but insure that nothing breaks in the next major version upgrade:

    __PACKAGE__->naming('v7');

generate_pod

By default POD will be generated for columns and relationships, using database metadata for the text if available and supported.

Reading database metadata (e.g. COMMENT ON TABLE some_table ...) is only supported for Postgres right now.

Set this to 0 to turn off all POD generation.

pod_comment_mode

Controls where table comments appear in the generated POD. Smaller table comments are appended to the NAME section of the documentation, and larger ones are inserted into DESCRIPTION instead. You can force a DESCRIPTION section to be generated with the comment always, only use NAME, or choose the length threshold at which the comment is forced into the description.

name

Use NAME section only.

description

Force DESCRIPTION always.

auto

Use DESCRIPTION if length > "pod_comment_spillover_length", this is the default.

pod_comment_spillover_length

When pod_comment_mode is set to auto, this is the length of the comment at which it will be forced into a separate description section.

The default is 60

relationship_attrs

Hashref of attributes to pass to each generated relationship, listed by type. Also supports relationship type 'all', containing options to pass to all generated relationships. Attributes set for more specific relationship types override those set in 'all'.

For example:

  relationship_attrs => {
    belongs_to => { is_deferrable => 0 },
  },

use this to turn off DEFERRABLE on your foreign key constraints.

debug

If set to true, each constructive DBIx::Class statement the loader decides to execute will be warn-ed before execution.

db_schema

Set the name of the schema to load (schema in the sense that your database vendor means it). Does not currently support loading more than one schema name.

constraint

Only load tables matching regex. Best specified as a qr// regex.

exclude

Exclude tables matching regex. Best specified as a qr// regex.

moniker_map

Overrides the default table name to moniker translation. Can be either a hashref of table keys and moniker values, or a coderef for a translator function taking a single scalar table name argument and returning a scalar moniker. If the hash entry does not exist, or the function returns a false value, the code falls back to default behavior for that table name.

The default behavior is to split on case transition and non-alphanumeric boundaries, singularize the resulting phrase, then join the titlecased words together. Examples:

    Table Name       | Moniker Name
    ---------------------------------
    luser            | Luser
    luser_group      | LuserGroup
    luser-opts       | LuserOpt
    stations_visited | StationVisited
    routeChange      | RouteChange

col_accessor_map

Same as moniker_map, but for column accessor names. If a coderef is passed, the code is called with arguments of

   the name of the column in the underlying database,
   default accessor name that DBICSL would ordinarily give this column,
   {
      table_class     => name of the DBIC class we are building,
      table_moniker   => calculated moniker for this table (after moniker_map if present),
      table_name      => name of the database table,
      full_table_name => schema-qualified name of the database table (RDBMS specific),
      schema_class    => name of the schema class we are building,
      column_info     => hashref of column info (data_type, is_nullable, etc),
    }

inflect_plural

Just like "moniker_map" above (can be hash/code-ref, falls back to default if hash key does not exist or coderef returns false), but acts as a map for pluralizing relationship names. The default behavior is to utilize "to_PL" in Lingua::EN::Inflect::Phrase.

inflect_singular

As "inflect_plural" above, but for singularizing relationship names. Default behavior is to utilize "to_S" in Lingua::EN::Inflect::Phrase.

schema_base_class

Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.

result_base_class

Base class for your table classes (aka result classes). Defaults to 'DBIx::Class::Core'.

additional_base_classes

List of additional base classes all of your table classes will use.

left_base_classes

List of additional base classes all of your table classes will use that need to be leftmost.

additional_classes

List of additional classes which all of your table classes will use.

components

List of additional components to be loaded into all of your table classes. A good example would be InflateColumn::DateTime

result_component_map

A hashref of moniker keys and component values. Unlike components, which loads the given components into every table class, this option allows you to load certain components for specified tables. For example:

  result_component_map => {
      StationVisited => '+YourApp::Schema::Component::StationVisited',
      RouteChange    => [
                            '+YourApp::Schema::Component::RouteChange',
                            'InflateColumn::DateTime',
                        ],
  }

You may use this in conjunction with components.

use_namespaces

This is now the default, to go back to "load_classes" in DBIx::Class::Schema pass a 0.

Generate result class names suitable for "load_namespaces" in DBIx::Class::Schema and call that instead of "load_classes" in DBIx::Class::Schema. When using this option you can also specify any of the options for load_namespaces (i.e. result_namespace, resultset_namespace, default_resultset_class), and they will be added to the call (and the generated result class names adjusted appropriately).

dump_directory

The value of this option is a perl libdir pathname. Within that directory this module will create a baseline manual DBIx::Class::Schema module set, based on what it creates at runtime.

The created schema class will have the same classname as the one on which you are setting this option (and the ResultSource classes will be based on this name as well).

Normally you wouldn't hard-code this setting in your schema class, as it is meant for one-time manual usage.

See "dump_to_dir" in DBIx::Class::Schema::Loader for examples of the recommended way to access this functionality.

dump_overwrite

Deprecated. See "really_erase_my_files" below, which does *not* mean the same thing as the old dump_overwrite setting from previous releases.

really_erase_my_files

Default false. If true, Loader will unconditionally delete any existing files before creating the new ones from scratch when dumping a schema to disk.

The default behavior is instead to only replace the top portion of the file, up to and including the final stanza which contains # DO NOT MODIFY THE FIRST PART OF THIS FILE leaving any customizations you placed after that as they were.

When really_erase_my_files is not set, if the output file already exists, but the aforementioned final stanza is not found, or the checksum contained there does not match the generated contents, Loader will croak and not touch the file.

You should really be using version control on your schema classes (and all of the rest of your code for that matter). Don't blame me if a bug in this code wipes something out when it shouldn't have, you've been warned.

overwrite_modifications

Default false. If false, when updating existing files, Loader will refuse to modify any Loader-generated code that has been modified since its last run (as determined by the checksum Loader put in its comment lines).

If true, Loader will discard any manual modifications that have been made to Loader-generated code.

Again, you should be using version control on your schema classes. Be careful with this option.

custom_column_info

Hook for adding extra attributes to the column_info for a column.

Must be a coderef that returns a hashref with the extra attributes.

Receives the table name, column name and column_info.

For example:

  custom_column_info => sub {
      my ($table_name, $column_name, $column_info) = @_;

      if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') {
          return { is_snoopy => 1 };
      }
  },

This attribute can also be used to set inflate_datetime on a non-datetime column so it also receives the "datetime_timezone" and/or "datetime_locale".

datetime_timezone

Sets the timezone attribute for DBIx::Class::InflateColumn::DateTime for all columns with the DATE/DATETIME/TIMESTAMP data_types.

datetime_locale

Sets the locale attribute for DBIx::Class::InflateColumn::DateTime for all columns with the DATE/DATETIME/TIMESTAMP data_types.

datetime_undef_if_invalid

Pass a 0 for this option when using MySQL if you DON'T want datetime_undef_if_invalid => 1 in your column info for DATE, DATETIME and TIMESTAMP columns.

The default is recommended to deal with data such as 00/00/00 which sometimes ends up in such columns in MySQL.

config_file

File in Perl format, which should return a HASH reference, from which to read loader options.

preserve_case

Usually column names are lowercased, to make them easier to work with in DBIx::Class. This option lets you turn this behavior off, if the driver supports it.

Drivers for case sensitive databases like Sybase ASE or MSSQL with a case-sensitive collation will turn this option on unconditionally.

Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support setting this option.

qualify_objects

Set to true to prepend the "db_schema" to table names for __PACKAGE__->table calls, and to some other things like Oracle sequences.

use_moose

Creates Schema and Result classes that use Moose, MooseX::NonMoose and namespace::autoclean. The default content after the md5 sum also makes the classes immutable.

It is safe to upgrade your existing Schema to this option.

col_collision_map

This option controls how accessors for column names which collide with perl methods are named. See "COLUMN ACCESSOR COLLISIONS" for more information.

This option takes either a single sprintf format or a hashref of strings which are compiled to regular expressions that map to sprintf formats.

Examples:

    col_collision_map => 'column_%s'

    col_collision_map => { '(.*)' => 'column_%s' }

    col_collision_map => { '(foo).*(bar)' => 'column_%s_%s' }

rel_collision_map

Works just like "col_collision_map", but for relationship names/accessors rather than column names/accessors.

The default is to just append _rel to the relationship name, see "RELATIONSHIP NAME COLLISIONS".

METHODS

None of these methods are intended for direct invocation by regular users of DBIx::Class::Schema::Loader. Some are proxied via DBIx::Class::Schema::Loader.

new

Constructor for DBIx::Class::Schema::Loader::Base, used internally by DBIx::Class::Schema::Loader.

load

Does the actual schema-construction work.

rescan

Arguments: schema

Rescan the database for changes. Returns a list of the newly added table monikers.

The schema argument should be the schema class or object to be affected. It should probably be derived from the original schema_class used during "load".

get_dump_filename

Arguments: class

Returns the full path to the file for a class that the class has been or will be dumped to. This is a file in a temp dir for a dynamic schema.

tables

Returns a sorted list of loaded tables, using the original database table names.

monikers

Returns a hashref of loaded table to moniker mappings. There will be two entries for each table, the original name and the "normalized" name, in the case that the two are different (such as databases that like uppercase table names, or preserve your original mixed-case definitions, or what-have-you).

classes

Returns a hashref of table to class mappings. In some cases it will contain multiple entries per table for the original and normalized table names, as above in "monikers".

COLUMN ACCESSOR COLLISIONS

Occasionally you may have a column name that collides with a perl method, such as can. In such cases, the default action is to set the accessor of the column spec to undef.

You can then name the accessor yourself by placing code such as the following below the md5:

    __PACKAGE__->add_column('+can' => { accessor => 'my_can' });

Another option is to use the "col_collision_map" option.

RELATIONSHIP NAME COLLISIONS

In very rare cases, you may get a collision between a generated relationship name and a method in your Result class, for example if you have a foreign key called belongs_to.

This is a problem because relationship names are also relationship accessor methods in DBIx::Class.

The default behavior is to append _rel to the relationship name and print out a warning that refers to this text.

You can also control the renaming with the "rel_collision_map" option.

SEE ALSO

DBIx::Class::Schema::Loader

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.