|
NAMEDBIx::Class::Optional::Dependencies - Optional module dependency specifications (for module authors)SYNOPSISSomewhere in your build-file (e.g. Module::Install's Makefile.PL):... configure_requires 'DBIx::Class' => '0.082842'; 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 DESCRIPTIONSome 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 GROUPSDependencies 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 theDBIx::Class::AdminModules required for the DBIx::Class administrative library
Requirement group: admin dbicadminModules required for the CLI DBIx::Class interface dbicadmin
Requirement group: admin_script Storage::DBI::deploy()Modules required for "deployment_statements" in DBIx::Class::Storage::DBI and "deploy" in DBIx::Class::Schema
Requirement group: deploy Sybase ASE supportModules required to connect to Sybase ASE
Requirement group: rdbms_ase DB2 supportModules required to connect to DB2
Requirement group: rdbms_db2 DB2 on AS/400 supportModules required to connect to DB2 on AS/400
Requirement group: rdbms_db2_400 Firebird supportModules required to connect to Firebird
Requirement group: rdbms_firebird Firebird support via DBD::InterBaseModules required to connect to Firebird via DBD::InterBase
Requirement group: rdbms_firebird_interbase Firebird support via DBD::ODBCModules required to connect to Firebird via DBD::ODBC
Requirement group: rdbms_firebird_odbc Informix supportModules required to connect to 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
Requirement group: rdbms_msaccess_ado MS Access support via DBD::ODBCModules required to connect to MS Access via 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
Requirement group: rdbms_mssql_ado MSSQL support via DBD::ODBCModules required to connect to MSSQL via DBD::ODBC
Requirement group: rdbms_mssql_odbc MSSQL support via DBD::SybaseModules required to connect to MSSQL via DBD::Sybase
Requirement group: rdbms_mssql_sybase MySQL supportModules required to connect to MySQL
Requirement group: rdbms_mysql Oracle supportModules required to connect to Oracle
Requirement group: rdbms_oracle PostgreSQL supportModules required to connect to PostgreSQL
Requirement group: rdbms_pg SQLAnywhere supportModules required to connect to SQLAnywhere
Requirement group: rdbms_sqlanywhere SQLAnywhere support via DBD::ODBCModules required to connect to SQLAnywhere via DBD::ODBC
Requirement group: rdbms_sqlanywhere_odbc SQLite supportModules required to connect to SQLite
Requirement group: rdbms_sqlite Storage::ReplicatedModules required for DBIx::Class::Storage::DBI::Replicated
Requirement group: replicated METHODSreq_group_list
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
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
Returns true or false depending on whether all modules required by $group_name are present on the system and loadable. req_missing_for
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
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
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 LICENSEThis 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.
Visit the GSP FreeBSD Man Page Interface. |