.\" 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
.\"
.\" 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 "Apache::Session::Browseable::Postgres 3pm"
.TH Apache::Session::Browseable::Postgres 3pm "2023-09-24" "perl v5.36.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"
Apache::Session::Browseable::Postgres \- Add index and search methods to
Apache::Session::Postgres
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Create table with columns for indexed fields. Example for Lemonldap::NG:
.PP
.Vb 8
\&  CREATE UNLOGGED TABLE sessions (
\&      id varchar(64) not null primary key,
\&      a_session text,
\&      _whatToTrace text,
\&      _session_kind text,
\&      _utime bigint,
\&      ipAddr varchar(64)
\&  );
.Ve
.PP
Add indexes:
.PP
.Vb 4
\&  CREATE INDEX uid1 ON sessions USING BTREE (_whatToTrace);
\&  CREATE INDEX s1   ON sessions (_session_kind);
\&  CREATE INDEX u1   ON sessions (_utime);
\&  CREATE INDEX ip1  ON sessions USING BTREE (ipAddr);
.Ve
.PP
Use it with Perl:
.PP
.Vb 1
\&  use Apache::Session::Browseable::Postgres;
\&
\&  my $args = {
\&       DataSource => \*(Aqdbi:Pg:sessions\*(Aq,
\&       UserName   => $db_user,
\&       Password   => $db_pass,
\&       Commit     => 1,
\&
\&       # Choose your browseable fileds
\&       Index      => \*(Aq_whatToTrace _session_kind _utime iAddr\*(Aq,
\&  };
\&  
\&  # Use it like Apache::Session
\&  my %session;
\&  tie %session, \*(AqApache::Session::Browseable::Postgres\*(Aq, $id, $args;
\&  $session{uid} = \*(Aqme\*(Aq;
\&  $session{mail} = \*(Aqme@me.com\*(Aq;
\&  $session{unindexedField} = \*(Aqzz\*(Aq;
\&  untie %session;
\&  
\&  # Apache::Session::Browseable add some global class methods
\&  #
\&  # 1) search on a field (indexed or not)
\&  my $hash = Apache::Session::Browseable::Postgres\->searchOn( $args, \*(Aquid\*(Aq, \*(Aqme\*(Aq );
\&  foreach my $id (keys %$hash) {
\&    print $id . ":" . $hash\->{$id}\->{mail} . "\en";
\&  }
\&
\&  # 2) Parse all sessions
\&  # a. get all sessions
\&  my $hash = Apache::Session::Browseable::Postgres\->get_key_from_all_sessions();
\&
\&  # b. get some fields from all sessions
\&  my $hash = Apache::Session::Browseable::Postgres\->get_key_from_all_sessions(\*(Aquid\*(Aq, \*(Aqmail\*(Aq)
\&
\&  # c. execute something with datas from each session :
\&  #    Example : get uid and mail if mail domain is
\&  my $hash = Apache::Session::Browseable::Postgres\->get_key_from_all_sessions(
\&              sub {
\&                 my ( $session, $id ) = @_;
\&                 if ( $session\->{mail} =~ /mydomain.com$/ ) {
\&                     return { $session\->{uid}, $session\->{mail} };
\&                 }
\&              }
\&  );
\&  foreach my $id (keys %$hash) {
\&    print $id . ":" . $hash\->{$id}\->{uid} . "=>" . $hash\->{$id}\->{mail} . "\en";
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Apache::Session::Browseable provides some class methods to manipulate all
sessions and add the capability to index some fields to make research faster.
.PP
Apache::Session::Browseable::Postgres implements it for PosqtgreSQL databases.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://lemonldap\-ng.org>, Apache::Session::Postgres
.SH "AUTHOR"
.IX Header "AUTHOR"
Xavier Guimard, <x.guimard@free.fr>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2009\-2017 by Xavier Guimard
              2013\-2017 by Cle\*'ment Oudot
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.1 or,
at your option, any later version of Perl 5 you may have available.