1DBIx::Class::Optional::UDseeprenCdoenntcriiebsu(t3e)d PeDrBlIxD:o:cCulmaesnst:a:tOipotnional::Dependencies(3)
2
3
4

NAME

6       DBIx::Class::Optional::Dependencies - Optional module dependency
7       specifications (for module authors)
8

SYNOPSIS (EXPERIMENTAL)

10       THE USAGE SHOWN HERE IS EXPERIMENTAL
11
12       Somewhere in your build-file (e.g. Module::Install's Makefile.PL):
13
14         ...
15
16         configure_requires 'DBIx::Class' => '0.08120';
17
18         require DBIx::Class::Optional::Dependencies;
19
20         my $deploy_deps = DBIx::Class::Optional::Dependencies->req_list_for ('deploy');
21
22         for (keys %$deploy_deps) {
23           requires $_ => $deploy_deps->{$_};
24         }
25
26         ...
27
28       Note that there are some caveats regarding "configure_requires()", more
29       info can be found at "configure_requires" in Module::Install
30

DESCRIPTION

32       Some of the less-frequently used features of DBIx::Class have external
33       module dependencies on their own. In order not to burden the average
34       user with modules he will never use, these optional dependencies are
35       not included in the base Makefile.PL. Instead an exception with a
36       descriptive message is thrown when a specific feature is missing one or
37       several modules required for its operation. This module is the central
38       holding place for  the current list of such dependencies, for
39       DBIx::Class core authors, and DBIx::Class extension authors alike.
40

CURRENT REQUIREMENT GROUPS

42       Dependencies are organized in "groups" and each group can list one or
43       more required modules, with an optional minimum version (or 0 for any
44       version).  The group name can be used in the
45
46   DBIx::Class::Admin
47       Modules required for the DBIx::Class administrative library
48
49       ·   JSON::Any >= 1.22
50
51       ·   Moose >= 0.98
52
53       ·   MooseX::Types >= 0.21
54
55       ·   MooseX::Types::JSON >= 0.02
56
57       ·   MooseX::Types::Path::Class >= 0.05
58
59       ·   namespace::autoclean >= 0.09
60
61       Requirement group: admin
62
63   dbicadmin
64       Modules required for the CLI DBIx::Class interface dbicadmin
65
66       ·   Getopt::Long::Descriptive >= 0.081
67
68       ·   JSON::Any >= 1.22
69
70       ·   Moose >= 0.98
71
72       ·   MooseX::Types >= 0.21
73
74       ·   MooseX::Types::JSON >= 0.02
75
76       ·   MooseX::Types::Path::Class >= 0.05
77
78       ·   Text::CSV >= 1.16
79
80       ·   namespace::autoclean >= 0.09
81
82       Requirement group: admin_script
83
84   Storage::DBI::deploy()
85       Modules required for "deploy" in DBIx::Class::Storage::DBI and
86       "deploymen_statements" in DBIx::Class::Storage::DBI
87
88       ·   SQL::Translator >= 0.11005
89
90       Requirement group: deploy
91
92   Storage::Replicated
93       Modules required for DBIx::Class::Storage::DBI::Replicated
94
95       ·   Hash::Merge >= 0.12
96
97       ·   Moose >= 0.98
98
99       ·   MooseX::Types >= 0.21
100
101       ·   namespace::clean >= 0.11
102
103       Requirement group: replicated
104

METHODS

106   req_list_for
107       Arguments: $group_name
108       Returns: \%list_of_module_version_pairs
109
110       This method should be used by DBIx::Class extension authors, to
111       determine the version of modules a specific feature requires in the
112       current version of DBIx::Class. See the SYNOPSIS for a real-world
113       example.
114
115   req_ok_for
116       Arguments: $group_name
117       Returns: 1|0
118
119       Returns true or false depending on whether all modules required by
120       $group_name are present on the system and loadable
121
122   req_missing_for
123       Arguments: $group_name
124       Returns: $error_message_string
125
126       Returns a single line string suitable for inclusion in larger error
127       messages.  This method would normally be used by DBIx::Class core-
128       module author, to indicate to the user that he needs to install
129       specific modules before he will be able to use a specific feature.
130
131       For example if the requirements for "replicated" are not available, the
132       returned string would look like:
133
134        Moose >= 0.98, MooseX::Types >= 0.21, namespace::clean (see DBIx::Class::Optional::Dependencies for details)
135
136       The author is expected to prepend the necessary text to this message
137       before returning the actual error seen by the user.
138
139   req_errorlist_for
140       Arguments: $group_name
141       Returns: \%list_of_loaderrors_per_module
142
143       Returns a hashref containing the actual errors that occured while
144       attempting to load each module in the requirement group.
145

AUTHOR

147       See "CONTRIBUTORS" in DBIx::Class.
148

LICENSE

150       You may distribute this code under the same terms as Perl itself
151
152
153
154perl v5.12.0                      2010-05D-B1I2x::Class::Optional::Dependencies(3)