.\" -*- 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 "CGI::Session::Driver::mysql 3"
.TH CGI::Session::Driver::mysql 3 2023-07-25 "perl v5.38.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
CGI::Session::Driver::mysql \- CGI::Session driver for MySQL database
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\&    $s = CGI::Session\->new( \*(Aqdriver:mysql\*(Aq, $sid);
\&    $s = CGI::Session\->new( \*(Aqdriver:mysql\*(Aq, $sid, { DataSource  => \*(Aqdbi:mysql:test\*(Aq,
\&                                                   User        => \*(Aqsherzodr\*(Aq,
\&                                                   Password    => \*(Aqhello\*(Aq });
\&    $s = CGI::Session\->new( \*(Aqdriver:mysql\*(Aq, $sid, { Handle => $dbh } );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBmysql\fR stores session records in a MySQL table. For details see CGI::Session::Driver::DBI, its parent class.
.PP
It's especially important for the MySQL driver that the session ID column be
defined as a primary key, or at least "unique", like this:
.PP
.Vb 4
\& CREATE TABLE sessions (
\&     id CHAR(32) NOT NULL PRIMARY KEY,
\&     a_session TEXT NOT NULL
\&  );
.Ve
.PP
To use different column names, change the 'create table' statement, and then simply do this:
.PP
.Vb 7
\&    $s = CGI::Session\->new(\*(Aqdriver:mysql\*(Aq, undef,
\&    {
\&        TableName=>\*(Aqsession\*(Aq,
\&        IdColName=>\*(Aqmy_id\*(Aq,
\&        DataColName=>\*(Aqmy_data\*(Aq,
\&        DataSource=>\*(Aqdbi:mysql:project\*(Aq,
\&    });
.Ve
.PP
or
.PP
.Vb 7
\&    $s = CGI::Session\->new(\*(Aqdriver:mysql\*(Aq, undef,
\&    {
\&        TableName=>\*(Aqsession\*(Aq,
\&        IdColName=>\*(Aqmy_id\*(Aq,
\&        DataColName=>\*(Aqmy_data\*(Aq,
\&        Handle=>$dbh,
\&    });
.Ve
.SS "DRIVER ARGUMENTS"
.IX Subsection "DRIVER ARGUMENTS"
\&\fBmysql\fR driver supports all the arguments documented in CGI::Session::Driver::DBI. In addition, \fIDataSource\fR argument can optionally leave leading "dbi:mysql:" string out:
.PP
.Vb 3
\&    $s = CGI::Session\->new( \*(Aqdriver:mysql\*(Aq, $sid, {DataSource=>\*(Aqshopping_cart\*(Aq});
\&    # is the same as:
\&    $s = CGI::Session\->new( \*(Aqdriver:mysql\*(Aq, $sid, {DataSource=>\*(Aqdbi:mysql:shopping_cart\*(Aq});
.Ve
.SS "BACKWARDS COMPATIBILITY"
.IX Subsection "BACKWARDS COMPATIBILITY"
As of V 4.30, the global variable \f(CW$CGI::Session::MySQL::TABLE_NAME\fR cannot be used to set the session
table's name.
.PP
This is due to changes in CGI::Session::Driver's \fBnew()\fR method, which now allows the table's name to be
changed (as well as allowing both the 'id' column name and the 'a_session' column name to be changed).
.PP
See the documentation for CGI::Session::Driver::DBI for details.
.PP
In particular, the new syntax for \f(CWnew()\fR applies to all database drivers, whereas the old \- and bad \-
global variable method only applied to MySQL.
.PP
Alternately, call \f(CW$session\fR \-> table_name('new_name') just after creating the session object if you wish to
change the session table's name.
.SH LICENSING
.IX Header "LICENSING"
For support and licensing see CGI::Session.