minor edit
[openafs-wiki.git] / TWiki / CGISessionDriverPostgresqlDotPm.mdwn
1 # <a name="Package &lt;code&gt;="></a> Package =
2
3 **extends** `CGI::Session::Driver::DBI `
4
5 <div>
6   <ul>
7     <li><a href="#Package =="> Package ==</a></li>
8   </ul>
9 </div>
10
11 =head1 NAME
12
13 CGI::Session::Driver::postgresql - [[PostgreSQL]] driver for CGI::Session
14
15 =head1 SYNOPSIS
16
17 use CGI::Session; $session = new CGI::Session("driver:PostgreSQL", undef, \{Handle=&gt;$dbh\});
18
19 =head1 DESCRIPTION
20
21 CGI::Session::PostgreSQL is a L&lt;CGI::Session|CGI::Session&gt; driver to store session data in a [[PostgreSQL]] table.
22
23 =head1 STORAGE
24
25 Before you can use any DBI-based session drivers you need to make sure compatible database table is created for CGI::Session to work with. Following command will produce minimal requirements in most SQL databases:
26
27 CREATE TABLE sessions ( id CHAR(32) NOT NULL PRIMARY KEY, a\_session BYTEA NOT NULL );
28
29 and within your code use:
30
31 use CGI::Session; $session = new CGI::Session("driver:PostgreSQL", undef, \{Handle=&gt;$dbh, [[ColumnType]]=&gt;"binary"\});
32
33 Please note the I argument. [[PostgreSQL]]'s text type has problems when trying to hold a null character. (Known as C&lt;"\\0"&gt; in Perl, not to be confused with SQL I). If you know there is no chance of ever having a null character in the serialized data, you can leave off the I attribute. Using a I column type and C&lt;&lt; [[ColumnType]] =&gt; 'binary' &gt;&gt; is recommended when using L&lt;Storable|CGI::Session::Serialize::storable&gt; as the serializer or if there's any possibility that a null value will appear in any of the serialized data.
34
35 For more details see L&lt;CGI::Session::Driver::DBI|CGI::Session::Driver::DBI&gt;, parent class.
36
37 Also see L, which exercises different method for dealing with binary data.
38
39 =head1 COPYRIGHT
40
41 Copyright (C) 2002 Cosimo Streppone. All rights reserved. This library is free software and can be modified and distributed under the same terms as Perl itself.
42
43 =head1 AUTHORS
44
45 Cosimo Streppone &lt;cosimo@cpan.org&gt;, heavily based on the CGI::Session::MySQL driver by Sherzod Ruzmetov, original author of CGI::Session.
46
47 Matt [[LeBlanc]] contributed significant updates for the 4.0 release.
48
49 =head1 LICENSING
50
51 For additional support and licensing see L&lt;CGI::Session|CGI::Session&gt;