| Current File : //home/strato/chroot/opt/RZperl536/man/man3/CGI::Session::Driver::mysql.3 |
.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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
.\" ========================================================================
.\"
.IX Title "CGI::Session::Driver::mysql 3"
.TH CGI::Session::Driver::mysql 3 "2011-07-11" "perl v5.36.1" "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 \s-1ID\s0 column be
defined as a primary key, or at least \*(L"unique\*(R", 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 "\s-1DRIVER ARGUMENTS\s0"
.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 \*(L"dbi:mysql:\*(R" 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 "\s-1BACKWARDS COMPATIBILITY\s0"
.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(CW\*(C`new()\*(C'\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.