GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DBIX::CLASS::OPTIONAL::DEPENDENCIES (3)

.ds Aq ’

NAME

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

CONTENTS

SYNOPSIS

Somewhere in your build-file (e.g. Module::Install’s Makefile.PL):



  ...

  configure_requires DBIx::Class => 0.082821;

  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
o JSON::Any >= 1.23
o Moose >= 0.98
o MooseX::Types >= 0.21
o MooseX::Types::JSON >= 0.02
o MooseX::Types::LoadableClass >= 0.011
o MooseX::Types::Path::Class >= 0.05
Requirement group: <B>adminB>

    dbicadmin

Modules required for the CLI DBIx::Class interface dbicadmin
o Getopt::Long::Descriptive >= 0.081
o JSON::Any >= 1.23
o Moose >= 0.98
o MooseX::Types >= 0.21
o MooseX::Types::JSON >= 0.02
o MooseX::Types::LoadableClass >= 0.011
o MooseX::Types::Path::Class >= 0.05
o Text::CSV >= 1.16
Requirement group: <B>admin_scriptB>

Storage::DBI::deploy()

Modules required for deployment_statements in DBIx::Class::Storage::DBI and deploy in DBIx::Class::Schema
o SQL::Translator >= 0.11018
Requirement group: <B>deployB>

    Sybase ASE support

Modules required to connect to Sybase ASE
o DBD::Sybase
Requirement group: <B>rdbms_aseB>

    DB2 support

Modules required to connect to DB2
o DBD::DB2
Requirement group: <B>rdbms_db2B>

    DB2 on AS/400 support

Modules required to connect to DB2 on AS/400
o DBD::ODBC
Requirement group: <B>rdbms_db2_400B>

    Firebird support

Modules required to connect to Firebird
o DBD::Firebird
Requirement group: <B>rdbms_firebirdB>

    Firebird support via DBD::InterBase

Modules required to connect to Firebird via DBD::InterBase
o DBD::InterBase
Requirement group: <B>rdbms_firebird_interbaseB>

    Firebird support via DBD::ODBC

Modules required to connect to Firebird via DBD::ODBC
o DBD::ODBC
Requirement group: <B>rdbms_firebird_odbcB>

    Informix support

Modules required to connect to Informix
o DBD::Informix
Requirement group: <B>rdbms_informixB>

    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
o DBD::ADO
Requirement group: <B>rdbms_msaccess_adoB>

    MS Access support via DBD::ODBC

Modules required to connect to MS Access via DBD::ODBC
o DBD::ODBC
Requirement group: <B>rdbms_msaccess_odbcB>

    MSSQL support via DBD::ADO (Windows only)

Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only
o DBD::ADO
Requirement group: <B>rdbms_mssql_adoB>

    MSSQL support via DBD::ODBC

Modules required to connect to MSSQL via DBD::ODBC
o DBD::ODBC
Requirement group: <B>rdbms_mssql_odbcB>

    MSSQL support via DBD::Sybase

Modules required to connect to MSSQL via DBD::Sybase
o DBD::Sybase
Requirement group: <B>rdbms_mssql_sybaseB>

    MySQL support

Modules required to connect to MySQL
o DBD::mysql
Requirement group: <B>rdbms_mysqlB>

    Oracle support

Modules required to connect to Oracle
o DBD::Oracle
o Math::Base36 >= 0.07
o Math::BigInt >= 1.80
Requirement group: <B>rdbms_oracleB>

    PostgreSQL support

Modules required to connect to PostgreSQL
o DBD::Pg
Requirement group: <B>rdbms_pgB>

    SQLAnywhere support

Modules required to connect to SQLAnywhere
o DBD::SQLAnywhere
Requirement group: <B>rdbms_sqlanywhereB>

    SQLAnywhere support via DBD::ODBC

Modules required to connect to SQLAnywhere via DBD::ODBC
o DBD::ODBC
Requirement group: <B>rdbms_sqlanywhere_odbcB>

    SQLite support

Modules required to connect to SQLite
o DBD::SQLite
Requirement group: <B>rdbms_sqliteB>

    Storage::Replicated

Modules required for DBIx::Class::Storage::DBI::Replicated
o Moose >= 0.98
o MooseX::Types >= 0.21
o MooseX::Types::LoadableClass >= 0.011
Requirement group: <B>replicatedB>

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 <B>currentB> 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.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DBIX::CLASS::OPTIONAL::DEPENDENCIES (3) 2016-02-11

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.