zeek/doc/scripts/base/bif/store.bif.zeek.rst
Tim Wojtulewicz ded98cd373 Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
2025-09-26 02:58:29 +00:00

171 lines
6.6 KiB
ReStructuredText

:tocdepth: 3
base/bif/store.bif.zeek
=======================
.. zeek:namespace:: Broker
.. zeek:namespace:: GLOBAL
Functions to interface with broker's distributed data store.
:Namespaces: Broker, GLOBAL
Summary
~~~~~~~
Functions
#########
================================================================ =
:zeek:id:`Broker::__append`: :zeek:type:`function`
:zeek:id:`Broker::__clear`: :zeek:type:`function`
:zeek:id:`Broker::__close`: :zeek:type:`function`
:zeek:id:`Broker::__create_clone`: :zeek:type:`function`
:zeek:id:`Broker::__create_master`: :zeek:type:`function`
:zeek:id:`Broker::__decrement`: :zeek:type:`function`
:zeek:id:`Broker::__erase`: :zeek:type:`function`
:zeek:id:`Broker::__exists`: :zeek:type:`function`
:zeek:id:`Broker::__get`: :zeek:type:`function`
:zeek:id:`Broker::__get_index_from_value`: :zeek:type:`function`
:zeek:id:`Broker::__increment`: :zeek:type:`function`
:zeek:id:`Broker::__insert_into_set`: :zeek:type:`function`
:zeek:id:`Broker::__insert_into_table`: :zeek:type:`function`
:zeek:id:`Broker::__is_closed`: :zeek:type:`function`
:zeek:id:`Broker::__keys`: :zeek:type:`function`
:zeek:id:`Broker::__pop`: :zeek:type:`function`
:zeek:id:`Broker::__push`: :zeek:type:`function`
:zeek:id:`Broker::__put`: :zeek:type:`function`
:zeek:id:`Broker::__put_unique`: :zeek:type:`function`
:zeek:id:`Broker::__remove_from`: :zeek:type:`function`
:zeek:id:`Broker::__store_name`: :zeek:type:`function`
================================================================ =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: Broker::__append
:source-code: base/bif/store.bif.zeek 64 64
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, s: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__clear
:source-code: base/bif/store.bif.zeek 82 82
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store) : :zeek:type:`bool`
.. zeek:id:: Broker::__close
:source-code: base/bif/store.bif.zeek 31 31
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store) : :zeek:type:`bool`
.. zeek:id:: Broker::__create_clone
:source-code: base/bif/store.bif.zeek 25 25
:Type: :zeek:type:`function` (id: :zeek:type:`string`, resync_interval: :zeek:type:`interval`, stale_interval: :zeek:type:`interval`, mutation_buffer_interval: :zeek:type:`interval`) : :zeek:type:`opaque` of Broker::Store
.. zeek:id:: Broker::__create_master
:source-code: base/bif/store.bif.zeek 22 22
:Type: :zeek:type:`function` (id: :zeek:type:`string`, b: :zeek:type:`Broker::BackendType`, options: :zeek:type:`Broker::BackendOptions` :zeek:attr:`&default` = *[sqlite=[path=, synchronous=<uninitialized>, journal_mode=<uninitialized>, failure_mode=Broker::SQLITE_FAILURE_MODE_FAIL, integrity_check=F]]* :zeek:attr:`&optional`) : :zeek:type:`opaque` of Broker::Store
.. zeek:id:: Broker::__decrement
:source-code: base/bif/store.bif.zeek 61 61
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, a: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__erase
:source-code: base/bif/store.bif.zeek 55 55
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`) : :zeek:type:`bool`
.. zeek:id:: Broker::__exists
:source-code: base/bif/store.bif.zeek 37 37
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`) : :zeek:type:`Broker::QueryResult`
.. zeek:id:: Broker::__get
:source-code: base/bif/store.bif.zeek 40 40
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`) : :zeek:type:`Broker::QueryResult`
.. zeek:id:: Broker::__get_index_from_value
:source-code: base/bif/store.bif.zeek 46 46
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, i: :zeek:type:`any`) : :zeek:type:`Broker::QueryResult`
.. zeek:id:: Broker::__increment
:source-code: base/bif/store.bif.zeek 58 58
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, a: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__insert_into_set
:source-code: base/bif/store.bif.zeek 67 67
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, i: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__insert_into_table
:source-code: base/bif/store.bif.zeek 70 70
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, i: :zeek:type:`any`, v: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__is_closed
:source-code: base/bif/store.bif.zeek 28 28
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store) : :zeek:type:`bool`
.. zeek:id:: Broker::__keys
:source-code: base/bif/store.bif.zeek 49 49
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store) : :zeek:type:`Broker::QueryResult`
.. zeek:id:: Broker::__pop
:source-code: base/bif/store.bif.zeek 79 79
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__push
:source-code: base/bif/store.bif.zeek 76 76
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, v: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__put
:source-code: base/bif/store.bif.zeek 52 52
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, v: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__put_unique
:source-code: base/bif/store.bif.zeek 43 43
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, v: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`Broker::QueryResult`
.. zeek:id:: Broker::__remove_from
:source-code: base/bif/store.bif.zeek 73 73
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store, k: :zeek:type:`any`, i: :zeek:type:`any`, e: :zeek:type:`interval`) : :zeek:type:`bool`
.. zeek:id:: Broker::__store_name
:source-code: base/bif/store.bif.zeek 34 34
:Type: :zeek:type:`function` (h: :zeek:type:`opaque` of Broker::Store) : :zeek:type:`string`