Skip to content

Commit 933bb06

Browse files
kenjisMGatner
authored andcommitted
docs: add about session key length
1 parent 1c8b089 commit 933bb06

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

user_guide_src/source/libraries/sessions.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,9 @@ Preference Default Options De
399399
RedisHandler::class
400400
ArrayHandler::class
401401
**sessionCookieName** ci_session [A-Za-z\_-] characters only The name used for the session cookie.
402+
The value will be included in the key of the
403+
Database/Memcached/Redis session records. So, set the value
404+
so that it does not exceed the maximum length of the key.
402405
**sessionExpiration** 7200 (2 hours) Time in seconds (integer) The number of seconds you would like the session to last.
403406
If you would like a non-expiring session (until browser is
404407
closed) set the value to zero: 0
@@ -524,6 +527,8 @@ In addition, if performance is your only concern, you may want to look
524527
into using `tmpfs <https://eddmann.com/posts/storing-php-sessions-file-caches-in-memory-using-tmpfs/>`_,
525528
(warning: external resource), which can make your sessions blazing fast.
526529

530+
.. _sessoins-databasehandler-driver:
531+
527532
DatabaseHandler Driver
528533
======================
529534

@@ -567,6 +572,10 @@ For PostgreSQL::
567572

568573
CREATE INDEX "ci_sessions_timestamp" ON "ci_sessions" ("timestamp");
569574

575+
.. note:: The ``id`` value contains the session cookie name (``Config\App::$sessionCookieName``)
576+
and the session ID and a delimiter. It should be increased as needed, for example,
577+
when using long session IDs.
578+
570579
You will also need to add a PRIMARY KEY **depending on your 'sessionMatchIP'
571580
setting**. The examples below work both on MySQL and PostgreSQL::
572581

@@ -601,6 +610,8 @@ when it generates the code.
601610
done processing session data if you're having performance
602611
issues.
603612

613+
.. _sessoins-redishandler-driver:
614+
604615
RedisHandler Driver
605616
===================
606617

@@ -637,6 +648,8 @@ sufficient:
637648

638649
.. literalinclude:: sessions/041.php
639650

651+
.. _sessoins-memcachedhandler-driver:
652+
640653
MemcachedHandler Driver
641654
=======================
642655

0 commit comments

Comments
 (0)