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_opts" in DBIx::Class::Schema::Loader. Available constructor options are:
relationships
Try to automatically detect/setup has_a and has_many relationships.
debug
Dump information about the created schema classes to stderr.
dump_directory
If this option is set, it will be treated as a perl libdir, and within that directory this module will create a baseline manual DBIx::Class::Schema module set in that directory, based on what it normally creates at runtime in memory, very similar to the debug output. The directory must already exist, and it would be wise to examine the output before manually copying this over into your real libdirs. As a precaution, this will *not* overwrite any existing files (it will prefer to die in that case).
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 tablename -> moniker translation. Can be either a hashref of table => moniker names, 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: join '', map ucfirst, split /[\W_]+/, lc $table, which is to say: lowercase everything, split up the table name into chunks anywhere a non-alpha-numeric character occurs, change the case of first letter of each chunk to upper case, and put the chunks back together. Examples:
Table Name | Moniker Name
---------------------------
luser | Luser
luser_group | LuserGroup
luser-opts | LuserOptsinflect_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::Number.
inflect_singular
As "inflect_plural" above, but for singularizing relationship names. Default behavior is to utilize "to_S" in Lingua::EN::Inflect::Number.
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 ResultSetManager.
resultset_components
List of additional resultset components to be loaded into your table classes. A good example would be AlwaysRS. Component ResultSetManager will be automatically added to the above components list if this option is set.
legacy_default_inflections
Setting this option changes the default fallback for "inflect_plural" to utilize "PL" in Lingua::EN::Inflect, and "inflect_singlular" to a no-op. Those choices produce substandard results, but might be neccesary to support your existing code if you started developing on a version prior to 0.03 and don't wish to go around updating all your relationship names to the new defaults.
DEPRECATED CONSTRUCTOR OPTIONS
inflect_map
Equivalent to "inflect_plural".
inflect
Equivalent to "inflect_plural".
connect_info, dsn, user, password, options
You connect these schemas the same way you would any DBIx::Class::Schema, which is by calling either connect or connection on a schema class or object. These options are only supported via the deprecated load_from_connection interface, which will be removed in the future.
METHODS
None of these methods are intended for direct invocation by regular users of DBIx::Class::Schema::Loader. Anything you can find here can also be found via standard DBIx::Class::Schema methods somehow.
new
Constructor for DBIx::Class::Schema::Loader::Base, used internally by DBIx::Class::Schema::Loader.
load
Does the actual schema-construction work.
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-classname mappings. In some cases it will contain multiple entries per table for the original and normalized table names, as above in "monikers".