--- name: "DBIx::Class::Optional::Dependencies" section: "3pm" platform: "linux" package: "libdbix-class-perl" version: "0.082844-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/DBIx::Class::Optional::Dependencies" --- # DBIx::Class::Optional::Dependencies(3pm) Optional module dependency specifications (for module authors) ## NAME DBIx::Class::Optional::Dependencies - Optional module dependency specifications (for module authors) ## SYNOPSIS Somewhere in your build-file (e.g. Module::Install's Makefile.PL): ``` ... configure_requires 'DBIx::Class' => '0.082844'; 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 `configure_requires()`, more info can be found at "configure\_requires" in Module::Install ## DESCRIPTION Some of the less-frequently used features of 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. ## CURRENT REQUIREMENT GROUPS Dependencies are organized in `"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 ### DBIx::Class::Admin Modules required for the DBIx::Class administrative library - • JSON::Any \>= 1.23 - • Moose \>= 0.98 - • MooseX::Types \>= 0.21 - • MooseX::Types::JSON \>= 0.02 - • MooseX::Types::LoadableClass \>= 0.011 - • MooseX::Types::Path::Class \>= 0.05 Requirement group: **admin** ### dbicadmin Modules required for the CLI DBIx::Class interface dbicadmin - • Getopt::Long::Descriptive \>= 0.081 - • JSON::Any \>= 1.23 - • Moose \>= 0.98 - • MooseX::Types \>= 0.21 - • MooseX::Types::JSON \>= 0.02 - • MooseX::Types::LoadableClass \>= 0.011 - • MooseX::Types::Path::Class \>= 0.05 - • Text::CSV \>= 1.16 Requirement group: **admin\_script** ### Storage::DBI::deploy() Modules required for "deployment\_statements" in DBIx::Class::Storage::DBI and "deploy" in DBIx::Class::Schema - • SQL::Translator \>= 0.11018 Requirement group: **deploy** ### Sybase ASE support Modules required to connect to Sybase ASE - • DBD::Sybase Requirement group: **rdbms\_ase** ### DB2 support Modules required to connect to DB2 - • DBD::DB2 Requirement group: **rdbms\_db2** ### DB2 on AS/400 support Modules required to connect to DB2 on AS/400 - • DBD::ODBC Requirement group: **rdbms\_db2\_400** ### Firebird support Modules required to connect to Firebird - • DBD::Firebird Requirement group: **rdbms\_firebird** ### Firebird support via DBD::InterBase Modules required to connect to Firebird via DBD::InterBase - • DBD::InterBase Requirement group: **rdbms\_firebird\_interbase** ### Firebird support via DBD::ODBC Modules required to connect to Firebird via DBD::ODBC - • DBD::ODBC Requirement group: **rdbms\_firebird\_odbc** ### Informix support Modules required to connect to Informix - • DBD::Informix Requirement group: **rdbms\_informix** ### MS Access support via DBD::ADO (Windows only) Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only - • DBD::ADO Requirement group: **rdbms\_msaccess\_ado** ### MS Access support via DBD::ODBC Modules required to connect to MS Access via DBD::ODBC - • DBD::ODBC Requirement group: **rdbms\_msaccess\_odbc** ### MSSQL support via DBD::ADO (Windows only) Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only - • DBD::ADO Requirement group: **rdbms\_mssql\_ado** ### MSSQL support via DBD::ODBC Modules required to connect to MSSQL via DBD::ODBC - • DBD::ODBC Requirement group: **rdbms\_mssql\_odbc** ### MSSQL support via DBD::Sybase Modules required to connect to MSSQL via DBD::Sybase - • DBD::Sybase Requirement group: **rdbms\_mssql\_sybase** ### MySQL support Modules required to connect to MySQL - • DBD::mysql Requirement group: **rdbms\_mysql** ### Oracle support Modules required to connect to Oracle - • DBD::Oracle - • Math::Base36 \>= 0.07 - • Math::BigInt \>= 1.80 Requirement group: **rdbms\_oracle** ### PostgreSQL support Modules required to connect to PostgreSQL - • DBD::Pg Requirement group: **rdbms\_pg** ### SQLAnywhere support Modules required to connect to SQLAnywhere - • DBD::SQLAnywhere Requirement group: **rdbms\_sqlanywhere** ### SQLAnywhere support via DBD::ODBC Modules required to connect to SQLAnywhere via DBD::ODBC - • DBD::ODBC Requirement group: **rdbms\_sqlanywhere\_odbc** ### SQLite support Modules required to connect to SQLite - • DBD::SQLite Requirement group: **rdbms\_sqlite** ### Storage::Replicated Modules required for DBIx::Class::Storage::DBI::Replicated - • Clone - • Moose \>= 0.98 - • MooseX::Types \>= 0.21 - • MooseX::Types::LoadableClass \>= 0.011 Requirement group: **replicated** ## METHODS ### req\_group\_list - Arguments: none - Return Value: \\%list\_of\_requirement\_groups This method should be used by DBIx::Class packagers, to get a hashref of all dependencies keyed by dependency group. Each key (group name) can be supplied to one of the group-specific methods below. ### req\_list\_for - Arguments: $group\_name - Return Value: \\%list\_of\_module\_version\_pairs This method should be used by DBIx::Class extension authors, to determine the version of modules a specific feature requires in the **current** version of DBIx::Class. See the "SYNOPSIS" for a real-world example. ### req\_ok\_for - Arguments: $group\_name - Return Value: 1\|0 Returns true or false depending on whether all modules required by `$group_name` are present on the system and loadable. ### req\_missing\_for - Arguments: $group\_name - Return Value: $error\_message\_string 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 some of the requirements for `"deploy"` are not available, the returned string could look like: ``` SQL::Translator >= 0.11018 (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. ### die\_unless\_req\_ok\_for - Arguments: $group\_name Checks if "req\_ok\_for" passes for the supplied `$group_name`, and in case of failure throws an exception including the information from "req\_missing\_for". ### req\_errorlist\_for - Arguments: $group\_name - Return Value: \\%list\_of\_loaderrors\_per\_module Returns a hashref containing the actual errors that occurred while attempting to load each module in the requirement group. ## FURTHER QUESTIONS? Check the list of additional DBIC resources. ## COPYRIGHT AND LICENSE This module is free software copyright by the DBIx::Class (DBIC) authors. You can redistribute it and/or modify it under the same terms as the DBIx::Class library.