.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Sympa::DatabaseDriver 3Sympa"
.TH Sympa::DatabaseDriver 3Sympa "2022-11-25" "6.2.70" "sympa 6.2.70"
.\" 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"
Sympa::DatabaseDriver \- Base class of database drivers for Sympa
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package Sympa::DatabaseDriver::FOO;
\&  use base qw(Sympa::DatabaseDriver);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sympa::DatabaseDriver is the base class of driver classes for
Sympa Database Manager (\s-1SDM\s0).
.SS "Instance methods subclasses should implement"
.IX Subsection "Instance methods subclasses should implement"
.IP "required_modules ( )" 4
.IX Item "required_modules ( )"
\&\fIOverridable\fR.
Returns an arrayref including package name(s) this driver requires.
By default, no packages are required.
.IP "required_parameters ( )" 4
.IX Item "required_parameters ( )"
\&\fIOverridable\fR.
Returns an arrayref including names of required (not optional) parameters.
By default, returns \f(CW\*(C`[\*(Aqdb_name\*(Aq, \*(Aqdb_user\*(Aq]\*(C'\fR.
.Sp
\&\fINote\fR:
On Sympa prior to 6.2.37b.2, it by default returned
\&\f(CW\*(C`[\*(Aqdb_host\*(Aq, \*(Aqdb_name\*(Aq, \*(Aqdb_user\*(Aq]\*(C'\fR.
.IP "optional_modules ( )" 4
.IX Item "optional_modules ( )"
\&\fIOverridable\fR.
Returns an arrayref including all name(s) of optional packages.
By default, there are no optional packages.
.Sp
This method was introduced by Sympa 6.2.4.
.IP "optional_parameters ( )" 4
.IX Item "optional_parameters ( )"
\&\fIOverridable\fR.
Returns an arrayref including all names of optional parameters.
By default, returns \f(CW\*(Aqdb_passwd\*(Aq\fR, \f(CW\*(Aqdb_port\*(Aq\fR, \f(CW\*(Aqdb_options\*(Aq\fR and so on.
.IP "build_connect_string ( )" 4
.IX Item "build_connect_string ( )"
\&\fIMandatory for \s-1SQL\s0 driver\fR.
Builds the string to be used by the \s-1DBI\s0 to connect to the database.
.Sp
Parameter:
.Sp
None.
.Sp
Returns:
.Sp
String representing data source name (\s-1DSN\s0).
.IP "connect ( )" 4
.IX Item "connect ( )"
\&\fIOverridable\fR.
Connects to database calling \*(L"_connect\*(R"() and sets database handle.
.Sp
Parameter:
.Sp
None.
.Sp
Returns:
.Sp
True value or, if connection failed, false value.
.IP "_connect ( )" 4
.IX Item "_connect ( )"
\&\fIOverridable\fR.
Connects to database and returns native database handle.
.Sp
The default implementation is for \s-1DBI\s0 database handle.
.ie n .IP "get_substring_clause ( { source_field => $source_field, separator => $separator, substring_length => $substring_length } )" 4
.el .IP "get_substring_clause ( { source_field => \f(CW$source_field\fR, separator => \f(CW$separator\fR, substring_length => \f(CW$substring_length\fR } )" 4
.IX Item "get_substring_clause ( { source_field => $source_field, separator => $separator, substring_length => $substring_length } )"
This method was deprecated by Sympa 6.2.4.
.IP "get_limit_clause ( )" 4
.IX Item "get_limit_clause ( )"
This method was deprecated.
.ie n .IP "get_formatted_date ( { mode => $mode, target => $target } )" 4
.el .IP "get_formatted_date ( { mode => \f(CW$mode\fR, target => \f(CW$target\fR } )" 4
.IX Item "get_formatted_date ( { mode => $mode, target => $target } )"
\&\fBDeprecated\fR as of Sympa 6.2.25b.3.
.Sp
\&\fIMandatory for \s-1SQL\s0 driver\fR.
Returns a character string corresponding to the expression to use in a query
involving a date.
.Sp
Parameters:
.RS 4
.ie n .IP "$mode" 4
.el .IP "\f(CW$mode\fR" 4
.IX Item "$mode"
authorized values:
.RS 4
.ie n .IP "\*(Aqwrite\*(Aq" 4
.el .IP "\f(CW\*(Aqwrite\*(Aq\fR" 4
.IX Item "write"
The sub returns the expression to use in '\s-1INSERT\s0' or '\s-1UPDATE\s0' queries.
.ie n .IP "\*(Aqread\*(Aq" 4
.el .IP "\f(CW\*(Aqread\*(Aq\fR" 4
.IX Item "read"
The sub returns the expression to use in '\s-1SELECT\s0' queries.
.RE
.RS 4
.RE
.ie n .IP "$target" 4
.el .IP "\f(CW$target\fR" 4
.IX Item "$target"
The name of the field or the value to be used in the query.
.RE
.RS 4
.Sp
Returns:
.Sp
The formatted date or \f(CW\*(C`undef\*(C'\fR if the date format mode is unknown.
.RE
.ie n .IP "is_autoinc ( { table => $table, field => $field } )" 4
.el .IP "is_autoinc ( { table => \f(CW$table\fR, field => \f(CW$field\fR } )" 4
.IX Item "is_autoinc ( { table => $table, field => $field } )"
\&\fIRequired to probe database structure\fR.
Checks whether a field is an auto-increment field or not.
.Sp
Parameters:
.RS 4
.ie n .IP "$field" 4
.el .IP "\f(CW$field\fR" 4
.IX Item "$field"
The name of the field to test
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table to add
.RE
.RS 4
.Sp
Returns:
.Sp
True if the field is an auto-increment field, false otherwise
.RE
.ie n .IP "is_sufficient_field_type ( $required, $actual )" 4
.el .IP "is_sufficient_field_type ( \f(CW$required\fR, \f(CW$actual\fR )" 4
.IX Item "is_sufficient_field_type ( $required, $actual )"
\&\fIOverridable\fR, \fIonly for \s-1SQL\s0 driver\fR.
Checks if database field type is sufficient.
.Sp
Parameters:
.RS 4
.ie n .IP "$required" 4
.el .IP "\f(CW$required\fR" 4
.IX Item "$required"
Required field type.
.ie n .IP "$actual" 4
.el .IP "\f(CW$actual\fR" 4
.IX Item "$actual"
Actual field type.
.RE
.RS 4
.Sp
Returns:
.Sp
The true value if actual field type is appropriate \s-1AND\s0 size is equal to or
greater than required size.
.Sp
This method was added on Sympa 6.2.67b.1.
.RE
.ie n .IP "set_autoinc ( { table => $table, field => $field } )" 4
.el .IP "set_autoinc ( { table => \f(CW$table\fR, field => \f(CW$field\fR } )" 4
.IX Item "set_autoinc ( { table => $table, field => $field } )"
\&\fIRequired to update database structure\fR.
Defines the field as an auto-increment field.
.Sp
Parameters:
.RS 4
.ie n .IP "$field" 4
.el .IP "\f(CW$field\fR" 4
.IX Item "$field"
The name of the field to set.
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table to add.
.RE
.RS 4
.Sp
Returns:
.Sp
\&\f(CW1\fR if the auto-increment could be set, \f(CW\*(C`undef\*(C'\fR otherwise.
.RE
.IP "get_tables ( )" 4
.IX Item "get_tables ( )"
\&\fIRequired to probe database structure\fR.
Returns the list of the tables in the database.
.Sp
Parameters:
.Sp
None.
.Sp
Returns:
.Sp
A ref to an array containing the list of the table names in the
database, \f(CW\*(C`undef\*(C'\fR if something went wrong.
.ie n .IP "add_table ( { table => $table } )" 4
.el .IP "add_table ( { table => \f(CW$table\fR } )" 4
.IX Item "add_table ( { table => $table } )"
\&\fIRequired to update database structure\fR.
Adds a table to the database.
.Sp
Parameter:
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table to add
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "get_fields ( { table => $table } )" 4
.el .IP "get_fields ( { table => \f(CW$table\fR } )" 4
.IX Item "get_fields ( { table => $table } )"
\&\fIRequired to probe database structure\fR.
Returns a ref to an hash containing the description of the fields in a table
from the database.
.Sp
Parameters:
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table whose fields are requested.
.RE
.RS 4
.Sp
Returns:
.Sp
A hash in which the keys are the field names and the values are the field type.
.Sp
Returns \f(CW\*(C`undef\*(C'\fR if something went wrong.
.RE
.ie n .IP "update_field ( { table => $table, field => $field, type => $type, ... } )" 4
.el .IP "update_field ( { table => \f(CW$table\fR, field => \f(CW$field\fR, type => \f(CW$type\fR, ... } )" 4
.IX Item "update_field ( { table => $table, field => $field, type => $type, ... } )"
\&\fIRequired to update database structure\fR.
Changes the type of a field in a table from the database.
.Sp
Parameters:
.RS 4
.ie n .IP "$field" 4
.el .IP "\f(CW$field\fR" 4
.IX Item "$field"
The name of the field to update.
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table whose fields will be updated.
.ie n .IP "$type" 4
.el .IP "\f(CW$type\fR" 4
.IX Item "$type"
The type of the field to add.
.ie n .IP "$notnull" 4
.el .IP "\f(CW$notnull\fR" 4
.IX Item "$notnull"
Specifies that the field must not be null
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "add_field ( { table => $table, field => $field, type => $type, ... } )" 4
.el .IP "add_field ( { table => \f(CW$table\fR, field => \f(CW$field\fR, type => \f(CW$type\fR, ... } )" 4
.IX Item "add_field ( { table => $table, field => $field, type => $type, ... } )"
\&\fIRequired to update database structure\fR.
Adds a field in a table from the database.
.Sp
Parameters:
.RS 4
.ie n .IP "$field" 4
.el .IP "\f(CW$field\fR" 4
.IX Item "$field"
The name of the field to add.
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table where the field will be added.
.ie n .IP "$type" 4
.el .IP "\f(CW$type\fR" 4
.IX Item "$type"
The type of the field to add.
.ie n .IP "$notnull" 4
.el .IP "\f(CW$notnull\fR" 4
.IX Item "$notnull"
Specifies that the field must not be null.
.ie n .IP "$autoinc" 4
.el .IP "\f(CW$autoinc\fR" 4
.IX Item "$autoinc"
Specifies that the field must be auto-incremental.
.ie n .IP "$primary" 4
.el .IP "\f(CW$primary\fR" 4
.IX Item "$primary"
Specifies that the field is a key.
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "delete_field ( { table => $table, field => $field } )" 4
.el .IP "delete_field ( { table => \f(CW$table\fR, field => \f(CW$field\fR } )" 4
.IX Item "delete_field ( { table => $table, field => $field } )"
\&\fIRequired to update database structure\fR.
Deletes a field from a table in the database.
.Sp
Parameters:
.RS 4
.ie n .IP "$field" 4
.el .IP "\f(CW$field\fR" 4
.IX Item "$field"
The name of the field to delete
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table where the field will be deleted.
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "get_primary_key ( { table => $table } )" 4
.el .IP "get_primary_key ( { table => \f(CW$table\fR } )" 4
.IX Item "get_primary_key ( { table => $table } )"
\&\fIRequired to probe database structure\fR.
Returns the list fields being part of a table's primary key.
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table for which the primary keys are requested.
.RE
.RS 4
.Sp
Returns:
.Sp
A ref to a hash in which each key is the name of a primary key or \f(CW\*(C`undef\*(C'\fR
if something went wrong.
.RE
.ie n .IP "unset_primary_key ( { table => $table } )" 4
.el .IP "unset_primary_key ( { table => \f(CW$table\fR } )" 4
.IX Item "unset_primary_key ( { table => $table } )"
\&\fIRequired to update database structure\fR.
Drops the primary key of a table.
.Sp
Parameter:
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table for which the primary keys must be
dropped.
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "set_primary_key ( { table => $table, fields => $fields } )" 4
.el .IP "set_primary_key ( { table => \f(CW$table\fR, fields => \f(CW$fields\fR } )" 4
.IX Item "set_primary_key ( { table => $table, fields => $fields } )"
\&\fIRequired to update database structure\fR.
Sets the primary key of a table.
.Sp
Parameters:
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table for which the primary keys must be
defined.
.ie n .IP "$fields" 4
.el .IP "\f(CW$fields\fR" 4
.IX Item "$fields"
A ref to an array containing the names of the fields used
in the key.
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "get_indexes ( { table => $table } )" 4
.el .IP "get_indexes ( { table => \f(CW$table\fR } )" 4
.IX Item "get_indexes ( { table => $table } )"
\&\fIRequired to probe database structure\fR.
Returns a ref to a hash in which each key is the name of an index.
.Sp
Parameter:
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table for which the indexes are requested.
.RE
.RS 4
.Sp
Returns:
.Sp
A ref to a hash in which each key is the name of an index.  These key
point to a second level hash in which each key is the name of the field
indexed.  Returns \f(CW\*(C`undef\*(C'\fR if something went wrong.
.RE
.ie n .IP "unset_index ( { table => $table, index => $index } )" 4
.el .IP "unset_index ( { table => \f(CW$table\fR, index => \f(CW$index\fR } )" 4
.IX Item "unset_index ( { table => $table, index => $index } )"
\&\fIRequired to update database structure\fR.
Drops an index of a table.
.Sp
Parameters:
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table for which the index must be dropped.
.ie n .IP "$index" 4
.el .IP "\f(CW$index\fR" 4
.IX Item "$index"
The name of the index to be dropped.
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "set_index ( { table => $table, index_name => $index_name, fields => $fields } )" 4
.el .IP "set_index ( { table => \f(CW$table\fR, index_name => \f(CW$index_name\fR, fields => \f(CW$fields\fR } )" 4
.IX Item "set_index ( { table => $table, index_name => $index_name, fields => $fields } )"
\&\fIRequired to update database structure\fR.
Sets an index in a table.
.Sp
Parameters:
.RS 4
.ie n .IP "$table" 4
.el .IP "\f(CW$table\fR" 4
.IX Item "$table"
The name of the table for which the index must be defined.
.ie n .IP "$fields" 4
.el .IP "\f(CW$fields\fR" 4
.IX Item "$fields"
A ref to an array containing the names of the fields used
in the index.
.ie n .IP "$index_name" 4
.el .IP "\f(CW$index_name\fR" 4
.IX Item "$index_name"
The name of the index to be defined.
.RE
.RS 4
.Sp
Returns:
.Sp
A character string report of the operation done or \f(CW\*(C`undef\*(C'\fR if something
went wrong.
.RE
.ie n .IP "translate_type ( $generic_type )" 4
.el .IP "translate_type ( \f(CW$generic_type\fR )" 4
.IX Item "translate_type ( $generic_type )"
\&\fIRequired to probe and update database structure\fR.
Get native field type corresponds to generic type.
The generic type is based on MySQL:
See \*(L"full_db_struct\*(R" in Sympa::DatabaseDescription.
.PP
Subclasses of Sympa::DatabaseDriver class also can override methods
provided by Sympa::Database class:
.ie n .IP "do_operation ( $operation, $parameters, ...)" 4
.el .IP "do_operation ( \f(CW$operation\fR, \f(CW$parameters\fR, ...)" 4
.IX Item "do_operation ( $operation, $parameters, ...)"
\&\fIOverridable\fR, \fIonly for \s-1LDAP\s0 driver\fR.
.ie n .IP "do_query ( $query, $parameters, ... )" 4
.el .IP "do_query ( \f(CW$query\fR, \f(CW$parameters\fR, ... )" 4
.IX Item "do_query ( $query, $parameters, ... )"
\&\fIOverridable\fR, \fIonly for \s-1SQL\s0 driver\fR.
.ie n .IP "do_prepared_query ( $query, $parameters, ... )" 4
.el .IP "do_prepared_query ( \f(CW$query\fR, \f(CW$parameters\fR, ... )" 4
.IX Item "do_prepared_query ( $query, $parameters, ... )"
\&\fIOverridable\fR, \fIonly for \s-1SQL\s0 driver\fR.
.ie n .IP "\s-1AS_DOUBLE\s0 ( $value )" 4
.el .IP "\s-1AS_DOUBLE\s0 ( \f(CW$value\fR )" 4
.IX Item "AS_DOUBLE ( $value )"
\&\fIOverridable\fR.
Helper functions to return the \s-1DOUBLE\s0 binding type and value used by
\&\*(L"do_prepared_query\*(R"().
Overridden by inherited classes.
.Sp
Parameter:
.RS 4
.ie n .IP "$value" 4
.el .IP "\f(CW$value\fR" 4
.IX Item "$value"
.RE
.RS 4
.Sp
Parameter value
.Sp
Returns:
.Sp
One of:
.IP "\(bu" 4
An array \f(CW\*(C`( { sql_type => SQL_type }, value )\*(C'\fR.
.IP "\(bu" 4
Single value (i.e. an array with single item), if special
treatment won't be needed.
.IP "\(bu" 4
Empty array \f(CW\*(C`()\*(C'\fR if arguments were not given.
.RE
.RS 4
.RE
.ie n .IP "\s-1AS_BLOB\s0 ( $value )" 4
.el .IP "\s-1AS_BLOB\s0 ( \f(CW$value\fR )" 4
.IX Item "AS_BLOB ( $value )"
\&\fIOverridable\fR.
Helper functions to return the \s-1BLOB\s0 (binary large object) binding type and
value used by \*(L"do_prepared_query\*(R"().
Overridden by inherited classes.
.Sp
See \*(L"\s-1AS_DOUBLE\*(R"\s0 for more details.
.SS "Utility method"
.IX Subsection "Utility method"
.IP "_\|_dbh ( )" 4
.IX Item "__dbh ( )"
\&\fIInstance method\fR, \fIprotected\fR.
Returns native database handle which _connect() returned.
This may be used at inside of each driver class.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sympa::Database, Sympa::DatabaseManager.
.SH "HISTORY"
.IX Header "HISTORY"
Sympa Database Manager (\s-1SDM\s0) appeared on Sympa 6.2.