base/frameworks/storage/main.zeek

Storage

The storage framework provides a way to store long-term data to disk.

Namespace:

Storage

Summary

Types

Storage::BackendOptions: record	Base record for backend options that can be passed to Storage::Async::open_backend and Storage::Sync::open_backend.
Storage::PutArgs: record	Record for passing arguments to Storage::Async::put and Storage::Sync::put.
Storage::Backend: enum
Storage::Serializer: enum

Detailed Interface

Types

Storage::BackendOptions

Type:

record

serializer: Storage::Serializer &default = Storage::STORAGE_SERIALIZER_JSON &optional

The serializer used for converting Zeek data.

redis: Storage::Backend::Redis::Options &optional

(present if policy/frameworks/storage/backend/redis/main.zeek is loaded)

sqlite: Storage::Backend::SQLite::Options &optional

(present if policy/frameworks/storage/backend/sqlite/main.zeek is loaded)

Base record for backend options that can be passed to Storage::Async::open_backend and Storage::Sync::open_backend. Backend plugins can redef this record to add relevant fields to it.

Storage::PutArgs

Type:

record

key: any

The key to store the value under.

value: any

The value to store associated with the key.

overwrite: bool &default = T &optional

Indicates whether this value should overwrite an existing entry for the key.

expire_time: interval &default = 0 secs &optional

An interval of time until the entry is automatically removed from the backend.

Record for passing arguments to Storage::Async::put and Storage::Sync::put.

Storage::Backend

Type:

enum

Storage::STORAGE_BACKEND_REDIS

Storage::STORAGE_BACKEND_SQLITE

Storage::Serializer

Type:

enum

Storage::STORAGE_SERIALIZER_JSON