#########################################################################
##################### A U T O G E N E R A T E D ########################
#########################################################################
#
# The contents of this POD file are auto-generated. Any changes you make
# will be lost. If you need to change the generated text edit _gen_pod()
# at the end of DBIx/Class/Optional/Dependencies.pm
#
=head1 NAME
DBIx::Class::Optional::Dependencies - Optional module dependency specifications (for module authors)
=head1 SYNOPSIS (EXPERIMENTAL)
B<THE USAGE SHOWN HERE IS EXPERIMENTAL>
Somewhere in your build-file (e.g. L<Module::Install>'s Makefile.PL):
...
configure_requires 'DBIx::Class' => '0.08120';
require DBIx::Class::Optional::Dependencies;
my $deploy_deps = DBIx::Class::Optional::Dependencies->req_list_for ('deploy');
for (keys %$deploy_deps) {
requires $_ => $deploy_deps->{$_};
}
...
Note that there are some caveats regarding C<configure_requires()>, more info
can be found at L<Module::Install/configure_requires>
=head1 DESCRIPTION
Some of the less-frequently used features of L<DBIx::Class> have external
module dependencies on their own. In order not to burden the average user
with modules he will never use, these optional dependencies are not included
in the base Makefile.PL. Instead an exception with a descriptive message is
thrown when a specific feature is missing one or several modules required for
its operation. This module is the central holding place for the current list
of such dependencies, for DBIx::Class core authors, and DBIx::Class extension
authors alike.
=head1 CURRENT REQUIREMENT GROUPS
Dependencies are organized in C<groups> and each group can list one or more
required modules, with an optional minimum version (or 0 for any version).
The group name can be used in the
=head2 DBIx::Class::Admin
Modules required for the DBIx::Class administrative library
=over
=item * JSON::Any >= 1.22
=item * Moose >= 0.98
=item * MooseX::Types >= 0.21
=item * MooseX::Types::JSON >= 0.02
=item * MooseX::Types::Path::Class >= 0.05
=item * namespace::autoclean >= 0.09
=back
Requirement group: B<admin>
=head2 dbicadmin
Modules required for the CLI DBIx::Class interface dbicadmin
=over
=item * Getopt::Long::Descriptive >= 0.081
=item * JSON::Any >= 1.22
=item * Moose >= 0.98
=item * MooseX::Types >= 0.21
=item * MooseX::Types::JSON >= 0.02
=item * MooseX::Types::Path::Class >= 0.05
=item * Text::CSV >= 1.16
=item * namespace::autoclean >= 0.09
=back
Requirement group: B<admin_script>
=head2 Storage::DBI::deploy()
Modules required for L<DBIx::Class::Storage::DBI/deploy> and L<DBIx::Class::Storage::DBI/deploymen_statements>
=over
=item * SQL::Translator >= 0.11005
=back
Requirement group: B<deploy>
=head2 Storage::Replicated
Modules required for L<DBIx::Class::Storage::DBI::Replicated>
=over
=item * Hash::Merge >= 0.12
=item * Moose >= 0.98
=item * MooseX::Types >= 0.21
=item * namespace::clean >= 0.11
=back
Requirement group: B<replicated>
=head1 METHODS
=head2 req_list_for
=over
=item Arguments: $group_name
=item Returns: \%list_of_module_version_pairs
=back
This method should be used by DBIx::Class extension authors, to determine the
version of modules a specific feature requires in the B<current> version of
DBIx::Class. See the L<SYNOPSIS|/SYNOPSIS (EXPERIMENTAL)> for a real-world
example.
=head2 req_ok_for
=over
=item Arguments: $group_name
=item Returns: 1|0
=back
Returns true or false depending on whether all modules required by C<$group_name> are present on the system and loadable
=head2 req_missing_for
=over
=item Arguments: $group_name
=item Returns: $error_message_string
=back
Returns a single line string suitable for inclusion in larger error messages.
This method would normally be used by DBIx::Class core-module author, to
indicate to the user that he needs to install specific modules before he will
be able to use a specific feature.
For example if the requirements for C<replicated> are not available, the
returned string would look like:
Moose >= 0.98, MooseX::Types >= 0.21, namespace::clean (see DBIx::Class::Optional::Dependencies for details)
The author is expected to prepend the necessary text to this message before
returning the actual error seen by the user.
=head2 req_errorlist_for
=over
=item Arguments: $group_name
=item Returns: \%list_of_loaderrors_per_module
=back
Returns a hashref containing the actual errors that occured while attempting
to load each module in the requirement group.
=head1 AUTHOR
See L<DBIx::Class/CONTRIBUTORS>.
=head1 LICENSE
You may distribute this code under the same terms as Perl itself