mirror of
https://github.com/zeek/zeek.git
synced 2025-10-09 18:18:19 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
140 lines
4.4 KiB
ReStructuredText
140 lines
4.4 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/frameworks/storage/main.zeek
|
|
=================================
|
|
.. zeek:namespace:: Storage
|
|
|
|
The storage framework provides a way to store long-term data to disk.
|
|
|
|
:Namespace: Storage
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Redefinable Options
|
|
###################
|
|
================================================================================== =
|
|
:zeek:id:`Storage::default_forced_sync`: :zeek:type:`bool` :zeek:attr:`&redef`
|
|
:zeek:id:`Storage::latency_metric_bounds`: :zeek:type:`vector` :zeek:attr:`&redef`
|
|
================================================================================== =
|
|
|
|
Types
|
|
#####
|
|
========================================================= ===================================================================
|
|
:zeek:type:`Storage::BackendOptions`: :zeek:type:`record` Base record for backend options that can be passed to
|
|
:zeek:see:`Storage::Async::open_backend` and
|
|
:zeek:see:`Storage::Sync::open_backend`.
|
|
:zeek:type:`Storage::PutArgs`: :zeek:type:`record` Record for passing arguments to :zeek:see:`Storage::Async::put` and
|
|
:zeek:see:`Storage::Sync::put`.
|
|
:zeek:type:`Storage::Backend`: :zeek:type:`enum`
|
|
:zeek:type:`Storage::Serializer`: :zeek:type:`enum`
|
|
========================================================= ===================================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Redefinable Options
|
|
###################
|
|
.. zeek:id:: Storage::default_forced_sync
|
|
:source-code: base/frameworks/storage/main.zeek 7 7
|
|
|
|
:Type: :zeek:type:`bool`
|
|
:Attributes: :zeek:attr:`&redef`
|
|
:Default: ``F``
|
|
|
|
|
|
.. zeek:id:: Storage::latency_metric_bounds
|
|
:source-code: base/frameworks/storage/main.zeek 42 42
|
|
|
|
:Type: :zeek:type:`vector` of :zeek:type:`double`
|
|
:Attributes: :zeek:attr:`&redef`
|
|
:Default:
|
|
|
|
::
|
|
|
|
[0.001, 0.01, 0.1, 1.0]
|
|
|
|
|
|
|
|
Types
|
|
#####
|
|
.. zeek:type:: Storage::BackendOptions
|
|
:source-code: base/frameworks/storage/main.zeek 13 21
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
|
|
.. zeek:field:: serializer :zeek:type:`Storage::Serializer` :zeek:attr:`&default` = ``Storage::STORAGE_SERIALIZER_JSON`` :zeek:attr:`&optional`
|
|
|
|
The serializer used for converting Zeek data.
|
|
|
|
|
|
.. zeek:field:: forced_sync :zeek:type:`bool` :zeek:attr:`&default` = :zeek:see:`Storage::default_forced_sync` :zeek:attr:`&optional`
|
|
|
|
Sets the backend into forced-synchronous mode. All operations will run
|
|
in synchronous mode, even if the async functions are called. This
|
|
should generally only be set to ``T`` during testing.
|
|
|
|
|
|
.. zeek:field:: redis :zeek:type:`Storage::Backend::Redis::Options` :zeek:attr:`&optional`
|
|
|
|
(present if :doc:`/scripts/policy/frameworks/storage/backend/redis/main.zeek` is loaded)
|
|
|
|
|
|
.. zeek:field:: sqlite :zeek:type:`Storage::Backend::SQLite::Options` :zeek:attr:`&optional`
|
|
|
|
(present if :doc:`/scripts/policy/frameworks/storage/backend/sqlite/main.zeek` is loaded)
|
|
|
|
|
|
Base record for backend options that can be passed to
|
|
:zeek:see:`Storage::Async::open_backend` and
|
|
:zeek:see:`Storage::Sync::open_backend`. Backend plugins can redef this record
|
|
to add relevant fields to it.
|
|
|
|
.. zeek:type:: Storage::PutArgs
|
|
:source-code: base/frameworks/storage/main.zeek 25 39
|
|
|
|
:Type: :zeek:type:`record`
|
|
|
|
|
|
.. zeek:field:: key :zeek:type:`any`
|
|
|
|
The key to store the value under.
|
|
|
|
|
|
.. zeek:field:: value :zeek:type:`any`
|
|
|
|
The value to store associated with the key.
|
|
|
|
|
|
.. zeek:field:: overwrite :zeek:type:`bool` :zeek:attr:`&default` = ``T`` :zeek:attr:`&optional`
|
|
|
|
Indicates whether this value should overwrite an existing entry for the
|
|
key.
|
|
|
|
|
|
.. zeek:field:: expire_time :zeek:type:`interval` :zeek:attr:`&default` = ``0 secs`` :zeek:attr:`&optional`
|
|
|
|
An interval of time until the entry is automatically removed from the
|
|
backend.
|
|
|
|
|
|
Record for passing arguments to :zeek:see:`Storage::Async::put` and
|
|
:zeek:see:`Storage::Sync::put`.
|
|
|
|
.. zeek:type:: Storage::Backend
|
|
|
|
:Type: :zeek:type:`enum`
|
|
|
|
.. zeek:enum:: Storage::STORAGE_BACKEND_REDIS Storage::Backend
|
|
|
|
.. zeek:enum:: Storage::STORAGE_BACKEND_SQLITE Storage::Backend
|
|
|
|
|
|
.. zeek:type:: Storage::Serializer
|
|
|
|
:Type: :zeek:type:`enum`
|
|
|
|
.. zeek:enum:: Storage::STORAGE_SERIALIZER_JSON Storage::Serializer
|
|
|
|
|
|
|