Skip to content
This repository was archived by the owner on Oct 13, 2025. It is now read-only.

Commit d58c643

Browse files
committed
Add some notes/caveats for the built-in storage backends
1 parent d69f790 commit d58c643

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

frameworks/storage.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,3 +186,26 @@ opening and closing a backend <storage-opening-closing>`, but an additional poin
186186
be made about the :zeek:see:`Storage::backend_lost` event. This event is also raised when
187187
a connection is lost unexpectedly. This gives users information about connection failures,
188188
as well an opportunity to handle those failures by reconnecting.
189+
190+
Notes for Built-in Backends
191+
===========================
192+
193+
Redis
194+
-----
195+
196+
- Redis server version 6.2.0 or later (or a third-party server implementing the equivalent
197+
level of the Redis API) is required. This is due to some API features the backend uses
198+
not being implemented until that version.
199+
200+
SQLite
201+
------
202+
203+
- The default batch of pragmas in :zeek:see:`Storage::Backend::SQlite::Options` set
204+
``journal_mode`` to ``WAL``. ``WAL`` mode does not work over network filesystems. If
205+
this mode is used, the database file must be stored on the same computer as all of the
206+
Zeek processes opening it. See the documentation in https://www.sqlite.org/wal.html for
207+
more information.
208+
209+
- Usage of in-memory databases (i.e. passing ``:memory:`` as the database path) will
210+
result in data not being synced between nodes. Each process will open its own database
211+
within that process's memory space.

0 commit comments

Comments
 (0)