---
name: "Apache::Session::Browseable::Redis"
section: "3pm"
platform: "linux"
package: "libapache-session-browseable-perl"
version: "1.3.16-1+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Apache::Session::Browseable::Redis"
---

# Apache::Session::Browseable::Redis(3pm)

Add index and search methods to Apache::Session::Redis

## NAME

Apache::Session::Browseable::Redis - Add index and search methods to Apache::Session::Redis

## SYNOPSIS

```
  use Apache::Session::Browseable::Redis;
  my $args = {
       server => '127.0.0.1:6379',
       # Select database (optional)
       #database => 0,
       # Choose your browseable fields
       Index          => 'uid mail',
  };

  # Use it like Apache::Session
  my %session;
  tie %session, 'Apache::Session::Browseable::Redis', $id, $args;
  $session{uid} = 'me';
  $session{mail} = 'me@me.com';
  $session{unindexedField} = 'zz';
  untie %session;

  # Apache::Session::Browseable add some global class methods
  #
  # 1) search on a field (indexed or not)
  my $hash = Apache::Session::Browseable::Redis->searchOn( $args, 'uid', 'me' );
  foreach my $id (keys %$hash) {
    print $id . ":" . $hash->{$id}->{mail} . "\n";
  }
  # 2) Parse all sessions
  # a. get all sessions
  my $hash = Apache::Session::Browseable::Redis->get_key_from_all_sessions($args);
  # b. get some fields from all sessions
  my $hash = Apache::Session::Browseable::Redis->get_key_from_all_sessions($args, 'uid', 'mail')
  # c. execute something with datas from each session :
  #    Example : get uid and mail if mail domain is
  my $hash = Apache::Session::Browseable::Redis->get_key_from_all_sessions(
              $args,
              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} . "\n";
  }
```

## DESCRIPTION

Apache::Session::browseable provides some class methods to manipulate all sessions and add the capability to index some fields to make research faster.

This module use either Redis::Fast or Redis.

## SEE ALSO

Apache::Session

## COPYRIGHT AND LICENSE

- 2009-2025 by Xavier Guimard

  - 2013-2025 by Clément Oudot

  - 2019-2025 by Maxime Besson

  - 2013-2025 by Worteks

  - 2023-2025-2025 by Linagora

  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.

## POD ERRORS

Hey! **The above document had some coding errors, which are explained below:**

- Around line 341:

  Non-ASCII character seen before =encoding in 'Clément'. Assuming UTF-8
