.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "App::Info::RDBMS::SQLite 3pm"
.TH App::Info::RDBMS::SQLite 3pm "2020-01-23" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
App::Info::RDBMS::SQLite \- Information about SQLite
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use App::Info::RDBMS::SQLite;
\&
\&  my $sqlite = App::Info::RDBMS::SQLite\->new;
\&
\&  if ($sqlite\->installed) {
\&      print "App name: ", $sqlite\->name, "\en";
\&      print "Version:  ", $sqlite\->version, "\en";
\&      print "Bin dir:  ", $sqlite\->bin_dir, "\en";
\&  } else {
\&      print "SQLite is not installed. :\-(\en";
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
App::Info::RDBMS::SQLite supplies information about the SQLite application
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 SQLite) construct a
new App::Info::RDBMS::SQLite object to aggregate new meta data.
.PP
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 \*(L"Executing `pg_config \-\-version`\*(R"
is documented for the methods \f(CW\*(C`name()\*(C'\fR, \f(CW\*(C`version()\*(C'\fR, \f(CW\*(C`major_version()\*(C'\fR,
\&\f(CW\*(C`minor_version()\*(C'\fR, and \f(CW\*(C`patch_version()\*(C'\fR, rest assured that it will only be
triggered once, by whichever of those four methods is called first.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "Constructor"
.IX Subsection "Constructor"
\fInew\fR
.IX Subsection "new"
.PP
.Vb 1
\&  my $sqlite = App::Info::RDBMS::SQLite\->new(@params);
.Ve
.PP
Returns an App::Info::RDBMS::SQLite object. See App::Info for a
complete description of argument parameters.
.PP
When it called, \f(CW\*(C`new()\*(C'\fR searches the directories returned by
\&\fIsearch_bin_dirs\fR for an executable with a name returned by
\&\f(CW\*(C`search_exe_names\*(C'\fR. If found, it will be called by the object methods below
to gather the data necessary for each. If it cannot be found, then \f(CW\*(C`new()\*(C'\fR
will attempt to load DBD::SQLite or
DBD::SQLite2. These \s-1DBI\s0 drivers have SQLite embedded in them
but do not install the application. If these fail, then SQLite is assumed not
to be installed, and each of the object methods will return \f(CW\*(C`undef\*(C'\fR.
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Looking for SQLite.
.IP "confirm" 4
.IX Item "confirm"
Path to SQLite executable?
.IP "unknown" 4
.IX Item "unknown"
Path to SQLite executable?
.SS "Class Method"
.IX Subsection "Class Method"
\fIkey_name\fR
.IX Subsection "key_name"
.PP
.Vb 1
\&  my $key_name = App::Info::RDBMS::SQLite\->key_name;
.Ve
.PP
Returns the unique key name that describes this class. The value returned is
the string \*(L"SQLite\*(R".
.SS "Object Methods"
.IX Subsection "Object Methods"
\fIinstalled\fR
.IX Subsection "installed"
.PP
.Vb 1
\&  print "SQLite is ", ($sqlite\->installed ? \*(Aq\*(Aq : \*(Aqnot \*(Aq), "installed.\en";
.Ve
.PP
Returns true if SQLite is installed, and false if it is not.
.PP
App::Info::RDBMS::SQLite determines whether SQLite is installed based on the
presence or absence of the \fIsqlite3\fR or \fIsqlite\fR application on the file
system as found when \f(CW\*(C`new()\*(C'\fR constructed the object. If SQLite does not
appear to be installed, then all of the other object methods will return empty
values.
.PP
\fIname\fR
.IX Subsection "name"
.PP
.Vb 1
\&  my $name = $sqlite\->name;
.Ve
.PP
Returns the name of the application. App::Info::RDBMS::SQLite simply returns
the value returned by \f(CW\*(C`key_name\*(C'\fR if SQLite is installed, and \f(CW\*(C`undef\*(C'\fR if
it is not installed.
.PP
\fIversion\fR
.IX Subsection "version"
.PP
.Vb 1
\&  my $version = $sqlite\->version;
.Ve
.PP
Returns the SQLite version number. App::Info::RDBMS::SQLite parses the version
number from the system call \f(CW\*(C`\`sqlite \-version\`\*(C'\fR or retrieves it from
DBD::SQLite.
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Executing `sqlite \-version`
.IP "error" 4
.IX Item "error"
Failed to find SQLite version with `sqlite \-version`
.Sp
Failed to retrieve SQLite version from DBD::SQLite
.Sp
Unable to parse name from string
.Sp
Unable to parse version from string
.Sp
Failed to parse SQLite version parts from string
.IP "unknown" 4
.IX Item "unknown"
Enter a valid SQLite version number
.PP
\fImajor version\fR
.IX Subsection "major version"
.PP
.Vb 1
\&  my $major_version = $sqlite\->major_version;
.Ve
.PP
Returns the SQLite major version number. App::Info::RDBMS::SQLite parses the
version number from the system call \f(CW\*(C`\`sqlite \-version\`\*(C'\fR or retrieves it from
DBD::SQLite. For example, if \f(CW\*(C`version()\*(C'\fR returns \*(L"3.0.8\*(R", then this method
returns \*(L"3\*(R".
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Executing `sqlite \-version`
.IP "error" 4
.IX Item "error"
Failed to find SQLite version with `sqlite \-version`
.Sp
Failed to retrieve SQLite version from DBD::SQLite
.Sp
Unable to parse name from string
.Sp
Unable to parse version from string
.Sp
Failed to parse SQLite version parts from string
.IP "unknown" 4
.IX Item "unknown"
Enter a valid SQLite version number
.PP
\fIminor version\fR
.IX Subsection "minor version"
.PP
.Vb 1
\&  my $minor_version = $sqlite\->minor_version;
.Ve
.PP
Returns the SQLite minor version number. App::Info::RDBMS::SQLite parses the
version number from the system call \f(CW\*(C`\`sqlite \-version\`\*(C'\fR or retrieves it from
DBD::SQLite. For example, if \f(CW\*(C`version()\*(C'\fR returns \*(L"3.0.8\*(R", then this method
returns \*(L"0\*(R".
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Executing `sqlite \-version`
.IP "error" 4
.IX Item "error"
Failed to find SQLite version with `sqlite \-version`
.Sp
Failed to retrieve SQLite version from DBD::SQLite
.Sp
Unable to parse name from string
.Sp
Unable to parse version from string
.Sp
Failed to parse SQLite version parts from string
.IP "unknown" 4
.IX Item "unknown"
Enter a valid SQLite version number
.PP
\fIpatch version\fR
.IX Subsection "patch version"
.PP
.Vb 1
\&  my $patch_version = $sqlite\->patch_version;
.Ve
.PP
Returns the SQLite patch version number. App::Info::RDBMS::SQLite parses the
version number from the system call \f(CW\*(C`\`sqlite \-version\`\*(C'\fR or retrieves it from
DBD::SQLite. For example, if \f(CW\*(C`version()\*(C'\fR returns \*(L"3.0.8\*(R", then this method
returns \*(L"8\*(R".
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Executing `sqlite \-version`
.IP "error" 4
.IX Item "error"
Failed to find SQLite version with `sqlite \-version`
.Sp
Failed to retrieve SQLite version from DBD::SQLite
.Sp
Unable to parse name from string
.Sp
Unable to parse version from string
.Sp
Failed to parse SQLite version parts from string
.IP "unknown" 4
.IX Item "unknown"
Enter a valid SQLite version number
.PP
\fIexecutable\fR
.IX Subsection "executable"
.PP
.Vb 1
\&  my $executable = $sqlite\->executable;
.Ve
.PP
Returns the path to the SQLite executable, usually \fIsqlite3\fR or \fIsqlite\fR,
which will be defined by one of the names returned by\f(CW\*(C`search_exe_names()\*(C'\fR.
The executable is searched for in \f(CW\*(C`new()\*(C'\fR, so there are no events for this
method.
.PP
\fIbin_dir\fR
.IX Subsection "bin_dir"
.PP
.Vb 1
\&  my $bin_dir = $sqlite\->bin_dir;
.Ve
.PP
Returns the SQLite binary directory path. App::Info::RDBMS::SQLite simply
retrieves it as the directory part of the path to the SQLite executable.
.PP
\fIlib_dir\fR
.IX Subsection "lib_dir"
.PP
.Vb 1
\&  my $lib_dir = $expat\->lib_dir;
.Ve
.PP
Returns the directory path in which an SQLite library was found. The directory
path will be one of the values returned by \f(CW\*(C`search_lib_dirs()\*(C'\fR, where a file
with a name as returned by \f(CW\*(C`search_lib_names()\*(C'\fR was found. No search is
performed if SQLite is not installed or if only DBD::SQLite is installed.
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Searching for shared object library directory
.IP "error" 4
.IX Item "error"
Cannot find shared object library directory
.IP "unknown" 4
.IX Item "unknown"
Enter a valid Expat shared object library directory
.PP
\fIso_lib_dir\fR
.IX Subsection "so_lib_dir"
.PP
.Vb 1
\&  my $so_lib_dir = $expat\->so_lib_dir;
.Ve
.PP
Returns the directory path in which an SQLite shared object library was
found. The directory path will be one of the values returned by
\&\f(CW\*(C`search_lib_dirs()\*(C'\fR, where a file with a name as returned by
\&\f(CW\*(C`search_so_lib_names()\*(C'\fR was found. No search is performed if SQLite is not
installed or if only DBD::SQLite is installed.
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Searching for shared object library directory
.IP "error" 4
.IX Item "error"
Cannot find shared object library directory
.IP "unknown" 4
.IX Item "unknown"
Enter a valid Expat shared object library directory
.PP
\fIinc_dir\fR
.IX Subsection "inc_dir"
.PP
.Vb 1
\&  my $inc_dir = $sqlite\->inc_dir;
.Ve
.PP
Returns the directory path in which an SQLite include file was found. The
directory path will be one of the values returned by \f(CW\*(C`search_inc_dirs()\*(C'\fR,
where a file with a name as returned by \f(CW\*(C`search_inc_names()\*(C'\fR was found. No
search is performed if SQLite is not installed or if only DBD::SQLite is
installed.
.PP
\&\fBEvents:\fR
.IP "info" 4
.IX Item "info"
Searching for include directory
.IP "error" 4
.IX Item "error"
Cannot find include directory
.IP "unknown" 4
.IX Item "unknown"
Enter a valid SQLite include directory
.PP
\fIhome_url\fR
.IX Subsection "home_url"
.PP
.Vb 1
\&  my $home_url = $pg\->home_url;
.Ve
.PP
Returns the PostgreSQL home page \s-1URL.\s0
.PP
\fIdownload_url\fR
.IX Subsection "download_url"
.PP
.Vb 1
\&  my $download_url = $pg\->download_url;
.Ve
.PP
Returns the PostgreSQL download \s-1URL.\s0
.PP
\fIsearch_exe_names\fR
.IX Subsection "search_exe_names"
.PP
.Vb 1
\&  my @search_exe_names = $sqlite\->search_exe_names;
.Ve
.PP
Returns a list of possible names for the SQLite executable. The names are
\&\fIsqlite3\fR and \fIsqlite\fR by default (\fIsqlite3.exe\fR and \fIsqlite.exe\fR on
Win32).
.PP
\fIsearch_bin_dirs\fR
.IX Subsection "search_bin_dirs"
.PP
.Vb 1
\&  my @search_bin_dirs = $sqlite\->search_bin_dirs;
.Ve
.PP
Returns a list of possible directories in which to search an executable. Used
by the \f(CW\*(C`new()\*(C'\fR constructor to find an executable to execute and collect
application info. The found directory will also be returned by the \f(CW\*(C`bin_dir\*(C'\fR
method.
.PP
\fIsearch_lib_names\fR
.IX Subsection "search_lib_names"
.PP
.Vb 1
\&  my @seach_lib_names = $self\->search_lib_nams
.Ve
.PP
Returns a list of possible names for library files. Used by \f(CW\*(C`lib_dir()\*(C'\fR to
search for library files. By default, the list is:
.IP "libsqlite3.a" 4
.IX Item "libsqlite3.a"
.PD 0
.IP "libsqlite3.la" 4
.IX Item "libsqlite3.la"
.IP "libsqlite3.so" 4
.IX Item "libsqlite3.so"
.IP "libsqlite3.so.0" 4
.IX Item "libsqlite3.so.0"
.IP "libsqlite3.so.0.0.1" 4
.IX Item "libsqlite3.so.0.0.1"
.IP "libsqlite3.dylib" 4
.IX Item "libsqlite3.dylib"
.IP "libsqlite3.0.dylib" 4
.IX Item "libsqlite3.0.dylib"
.IP "libsqlite3.0.0.1.dylib" 4
.IX Item "libsqlite3.0.0.1.dylib"
.IP "libsqlite.a" 4
.IX Item "libsqlite.a"
.IP "libsqlite.la" 4
.IX Item "libsqlite.la"
.IP "libsqlite.so" 4
.IX Item "libsqlite.so"
.IP "libsqlite.so.0" 4
.IX Item "libsqlite.so.0"
.IP "libsqlite.so.0.0.1" 4
.IX Item "libsqlite.so.0.0.1"
.IP "libsqlite.dylib" 4
.IX Item "libsqlite.dylib"
.IP "libsqlite.0.dylib" 4
.IX Item "libsqlite.0.dylib"
.IP "libsqlite.0.0.1.dylib" 4
.IX Item "libsqlite.0.0.1.dylib"
.PD
.PP
\fIsearch_so_lib_names\fR
.IX Subsection "search_so_lib_names"
.PP
.Vb 1
\&  my @seach_so_lib_names = $self\->search_so_lib_nams
.Ve
.PP
Returns a list of possible names for shared object library files. Used by
\&\f(CW\*(C`so_lib_dir()\*(C'\fR to search for library files. By default, the list is:
.IP "libsqlite3.so" 4
.IX Item "libsqlite3.so"
.PD 0
.IP "libsqlite3.so.0" 4
.IX Item "libsqlite3.so.0"
.IP "libsqlite3.so.0.0.1" 4
.IX Item "libsqlite3.so.0.0.1"
.IP "libsqlite3.dylib" 4
.IX Item "libsqlite3.dylib"
.IP "libsqlite3.0.dylib" 4
.IX Item "libsqlite3.0.dylib"
.IP "libsqlite3.0.0.1.dylib" 4
.IX Item "libsqlite3.0.0.1.dylib"
.IP "libsqlite.so" 4
.IX Item "libsqlite.so"
.IP "libsqlite.so.0" 4
.IX Item "libsqlite.so.0"
.IP "libsqlite.so.0.0.1" 4
.IX Item "libsqlite.so.0.0.1"
.IP "libsqlite.dylib" 4
.IX Item "libsqlite.dylib"
.IP "libsqlite.0.dylib" 4
.IX Item "libsqlite.0.dylib"
.IP "libsqlite.0.0.1.dylib" 4
.IX Item "libsqlite.0.0.1.dylib"
.PD
.PP
\fIsearch_lib_dirs\fR
.IX Subsection "search_lib_dirs"
.PP
.Vb 1
\&  my @search_lib_dirs = $sqlite\->search_lib_dirs;
.Ve
.PP
Returns a list of possible directories in which to search for libraries. By
default, it returns all of the paths in the \f(CW\*(C`libsdirs\*(C'\fR and \f(CW\*(C`loclibpth\*(C'\fR
attributes defined by the Perl Config module \*(-- plus \fI/sw/lib\fR (in
support of all you Fink users out there).
.PP
\fIsearch_inc_names\fR
.IX Subsection "search_inc_names"
.PP
.Vb 1
\&  my @search_inc_names = $sqlite\->search_inc_names;
.Ve
.PP
Returns a list of include file names to search for. Used by \f(CW\*(C`inc_dir()\*(C'\fR to
search for an include file. By default, the names are \fIsqlite3.h\fR and
\&\fIsqlite.h\fR.
.PP
\fIsearch_inc_dirs\fR
.IX Subsection "search_inc_dirs"
.PP
.Vb 1
\&  my @search_inc_dirs = $sqlite\->search_inc_dirs;
.Ve
.PP
Returns a list of possible directories in which to search for include files.
Used by \f(CW\*(C`inc_dir()\*(C'\fR to search for an include file. By default, the
directories are:
.IP "/usr/local/include" 4
.IX Item "/usr/local/include"
.PD 0
.IP "/usr/include" 4
.IX Item "/usr/include"
.IP "/sw/include" 4
.IX Item "/sw/include"
.PD
.SH "SUPPORT"
.IX Header "SUPPORT"
This module is stored in an open GitHub
repository <http://github.com/theory/app-info/>. Feel free to fork and
contribute!
.PP
Please file bug reports via GitHub
Issues <http://github.com/theory/app-info/issues/> or by sending mail to
bug\-App\-Info@rt.cpan.org <mailto:bug-App-Info@rt.cpan.org>.
.SH "AUTHOR"
.IX Header "AUTHOR"
David E. Wheeler <david@justatheory.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
App::Info documents the event handling interface.
.PP
App::Info::RDBMS is the App::Info::RDBMS parent class from
which App::Info::RDBMS::SQLite inherits.
.PP
DBD::SQLite is the \s-1DBI\s0 driver for connecting to SQLite
databases.
.PP
<http://www.sqlite.org/> is the SQLite home page.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2004\-2011, David E. Wheeler. Some Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under the
same terms as Perl itself.