.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "DBD::Firebird::TableInfo::Basic 3pm"
.TH DBD::Firebird::TableInfo::Basic 3pm 2024-03-07 "perl v5.38.2" "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
DBD::Firebird::TableInfo::Basic \- A base class for lowest\-common denominator Firebird table_info() querying.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    # Add support for a hypothetical IB derivative
\&    package DBD::Firebird::TableInfo::HypotheticalIBDerivative
\&
\&    @ISA = qw(DBD::Firebird::TableInfo::Basic);
\&
\&    # What table types are supported?
\&    sub supported_types {
\&        (\*(AqSYSTEM TABLE\*(Aq, \*(AqTABLE\*(Aq, \*(AqVIEW\*(Aq, \*(AqSPECIAL TABLE TYPE\*(Aq);
\&    }
\&
\&    sub table_info {
\&        my ($self, $dbh, $table, @types) = @_;
\&    }
.Ve
.SH INTERFACE
.IX Header "INTERFACE"
.IP \fIlist_catalogs\fR 4
.IX Item "list_catalogs"
.Vb 1
\&    $ti\->list_catalogs($dbh);  # $dbh\->table_info(\*(Aq%\*(Aq, \*(Aq\*(Aq, \*(Aq\*(Aq)
.Ve
.Sp
Returns a statement handle with an empty result set, as IB does not support
the DBI concept of catalogs. (Rule 19a)
.IP \fIlist_schema\fR 4
.IX Item "list_schema"
.Vb 1
\&    $ti\->list_schema($dbh);    # $dbh\->table_info(\*(Aq\*(Aq, \*(Aq%\*(Aq, \*(Aq\*(Aq)
.Ve
.Sp
Returns a statement handle with an empty result set, as IB does not support
the DBI concept of schema. (Rule 19b)
.IP \fIlist_tables\fR 4
.IX Item "list_tables"
.Vb 3
\&    $ti\->list_tables($dbh, $table, @types); # $dbh\->table_info(\*(Aq\*(Aq, \*(Aq\*(Aq,
\&                                            #                  \*(AqFOO%\*(Aq,
\&                                            #                  \*(AqTABLE,VIEW\*(Aq);
.Ve
.Sp
Called in response to \f(CW$dbh\fR\->table_info($cat, \f(CW$schem\fR, \f(CW$table\fR, \f(CW$types\fR).  \f(CW$cat\fR
and \f(CW$schem\fR are presently ignored.
.Sp
This is the workhorse method that must return an appropriate statement handle
of tables given the requested \f(CW$table\fR pattern and \f(CW@types\fR.  A blank
\&\f(CW$table\fR pattern means "any table," and an empty \f(CW@types\fR list means "any
type."
.Sp
\&\f(CW@types\fR is a list of user-supplied, requested types.
\&\f(CW\*(C`DBD::Firebird::db::table_info\*(C'\fR will normalize the user-supplied types,
stripping quote marks, uppercasing, and removing duplicates.
.IP \fIlist_types\fR 4
.IX Item "list_types"
.Vb 1
\&    $tbl_info\->list_types($dbh);  # $dbh\->table_info(\*(Aq\*(Aq, \*(Aq\*(Aq, \*(Aq\*(Aq, \*(Aq%\*(Aq)
.Ve
.Sp
Called in response to \f(CW$dbh\fR\->table_info('', '', '', '%'), returning a
statement handle with a TABLE_TYPE column populated with the results of
\&\fIsupported_types\fR.  (Rule 19c)
.Sp
Normally not overridden.  Override \fIsupported_types\fR, instead.
.IP \fIsupported_types\fR 4
.IX Item "supported_types"
.Vb 1
\&    $tbl_info\->supported_types($dbh);
.Ve
.Sp
Returns a list of supported DBI TABLE_TYPE entries.  The default
implementation supports 'TABLE', 'SYSTEM TABLE' and 'VIEW'.
.Sp
This method is called by the default implementation of \f(CW\*(C`list_types\*(C'\fR.