|
App::Info::RDBMS::PostgreSQL - Information about PostgreSQL |
App::Info::RDBMS::PostgreSQL - Information about PostgreSQL
use App::Info::RDBMS::PostgreSQL;
my $pg = App::Info::RDBMS::PostgreSQL->new;
if ($pg->installed) {
print "App name: ", $pg->name, "\n";
print "Version: ", $pg->version, "\n";
print "Bin dir: ", $pg->bin_dir, "\n";
} else {
print "PostgreSQL is not installed. :-(\n";
}
App::Info::RDBMS::PostgreSQL supplies information about the PostgreSQL database server installed on the local system. It implements all of the methods defined by App::Info::RDBMS. Methods that trigger events will trigger them only the first time they're called (See App::Info for documentation on handling events). To start over (after, say, someone has installed PostgreSQL) construct a new App::Info::RDBMS::PostgreSQL object to aggregate new metadata.
Some of the methods trigger the same events. This is due to cross-calling of
shared subroutines. However, any one event should be triggered no more than
once. For example, although the info event ``Executing `pg_config --version`''
is documented for the methods name(), version(), major_version(),
minor_version(), and patch_version(), rest assured that it will only be
triggered once, by whichever of those four methods is called first.
my $pg = App::Info::RDBMS::PostgreSQL->new(@params);
Returns an App::Info::RDBMS::PostgreSQL object. See App::Info for a complete description of argument parameters.
When it called, new() searches the file system for the pg_config
application. If found, pg_config will be called by the object methods below
to gather the data necessary for each. If pg_config cannot be found, then
PostgreSQL is assumed not to be installed, and each of the object methods will
return undef.
App::Info::RDBMS::PostgreSQL searches for pg_config along your path, as
defined by File::Spec->path. Failing that, it searches the following
directories:
Events:
my $key_name = App::Info::RDBMS::PostgreSQL->key_name;
Returns the unique key name that describes this class. The value returned is the string ``PostgreSQL''.
print "PostgreSQL is ", ($pg->installed ? '' : 'not '), "installed.\n";
Returns true if PostgreSQL is installed, and false if it is not.
App::Info::RDBMS::PostgreSQL determines whether PostgreSQL is installed based
on the presence or absence of the pg_config application on the file system
as found when new() constructed the object. If PostgreSQL does not appear
to be installed, then all of the other object methods will return empty
values.
my $name = $pg->name;
Returns the name of the application. App::Info::RDBMS::PostgreSQL parses the
name from the system call `pg_config --version`.
Events:
Unable to parse name from string
Unable to parse version from string
Failed to parse PostgreSQL version parts from string
my $version = $pg->version;
Returns the PostgreSQL version number. App::Info::RDBMS::PostgreSQL parses the
version number from the system call `pg_config --version`.
Events:
Unable to parse name from string
Unable to parse version from string
Failed to parse PostgreSQL version parts from string
my $major_version = $pg->major_version;
Returns the PostgreSQL major version number. App::Info::RDBMS::PostgreSQL
parses the major version number from the system call `pg_config --version`.
For example, version() returns ``7.1.2'', then this method returns ``7''.
Events:
Unable to parse name from string
Unable to parse version from string
Failed to parse PostgreSQL version parts from string
my $minor_version = $pg->minor_version;
Returns the PostgreSQL minor version number. App::Info::RDBMS::PostgreSQL
parses the minor version number from the system call `pg_config --version`.
For example, if version() returns ``7.1.2'', then this method returns ``2''.
Events:
Unable to parse name from string
Unable to parse version from string
Failed to parse PostgreSQL version parts from string
my $patch_version = $pg->patch_version;
Returns the PostgreSQL patch version number. App::Info::RDBMS::PostgreSQL
parses the patch version number from the system call `pg_config --version`.
For example, if version() returns ``7.1.2'', then this method returns ``1''.
Events:
Unable to parse name from string
Unable to parse version from string
Failed to parse PostgreSQL version parts from string
my $bin_dir = $pg->bin_dir;
Returns the PostgreSQL binary directory path. App::Info::RDBMS::PostgreSQL
gathers the path from the system call `pg_config --bindir`.
Events:
my $inc_dir = $pg->inc_dir;
Returns the PostgreSQL include directory path. App::Info::RDBMS::PostgreSQL
gathers the path from the system call `pg_config --includedir`.
Events:
my $lib_dir = $pg->lib_dir;
Returns the PostgreSQL library directory path. App::Info::RDBMS::PostgreSQL
gathers the path from the system call `pg_config --libdir`.
Events:
my $so_lib_dir = $pg->so_lib_dir;
Returns the PostgreSQL shared object library directory path.
App::Info::RDBMS::PostgreSQL gathers the path from the system call
`pg_config --pkglibdir`.
Events:
my $home_url = $pg->home_url;
Returns the PostgreSQL home page URL.
my $download_url = $pg->download_url;
Returns the PostgreSQL download URL.
Report all bugs via the CPAN Request Tracker at http://rt.cpan.org/NoAuth/Bugs.html.
David Wheeler <david@wheeler.net> based on code by Sam Tregar <sam@tregar.com>.
App::Info documents the event handling interface.
App::Info::RDBMS is the App::Info::RDBMS::PostgreSQL parent class.
DBD::Pg is the DBI driver for connecting to PostgreSQL databases.
http://www.postgresql.org/ is the PostgreSQL home page.
Copyright (c) 2002, David Wheeler. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
|
App::Info::RDBMS::PostgreSQL - Information about PostgreSQL |