mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
113 lines
3.9 KiB
Text
113 lines
3.9 KiB
Text
##! The storage framework provides a way to store long-term data to disk.
|
|
|
|
@load base/bif/storage.bif
|
|
|
|
module Storage;
|
|
|
|
export {
|
|
## Record for passing arguments to :zeek:see:`Storage::put`.
|
|
type PutArgs: record {
|
|
# The key to store the value under.
|
|
key: any;
|
|
|
|
# The value to store associated with the key.
|
|
value: any;
|
|
|
|
# Indicates whether this value should overwrite an existing entry
|
|
# for the key.
|
|
overwrite: bool &default=T;
|
|
|
|
# An interval of time until the entry is automatically removed from the
|
|
# backend.
|
|
expire_time: interval &default=0sec;
|
|
};
|
|
|
|
## Opens a new backend connection based on a configuration object.
|
|
##
|
|
## btype: A tag indicating what type of backend should be opened. These are
|
|
## defined by the backend plugins loaded.
|
|
##
|
|
## options: A record containing the configuration for the connection.
|
|
##
|
|
## key_type: The script-level type of keys stored in the backend. Used for
|
|
## validation of keys passed to other framework methods.
|
|
##
|
|
## val_type: The script-level type of keys stored in the backend. Used for
|
|
## validation of values passed to :zeek:see:`Storage::put` as well as
|
|
## for type conversions for return values from :zeek:see:`Storage::get`.
|
|
##
|
|
## Returns: A handle to the new backend connection, or ``F`` if the connection
|
|
## failed.
|
|
global open_backend: function(btype: Storage::Backend, options: any, key_type: any,
|
|
val_type: any): opaque of Storage::BackendHandle;
|
|
|
|
## Closes an existing backend connection.
|
|
##
|
|
## backend: A handle to a backend connection.
|
|
##
|
|
## Returns: A boolean indicating success or failure of the operation.
|
|
global close_backend: function(backend: opaque of Storage::BackendHandle): bool;
|
|
|
|
## Inserts a new entry into a backend.
|
|
##
|
|
##
|
|
## backend: A handle to a backend connection.
|
|
##
|
|
## args: A :zeek:see:`Storage::PutArgs` record containing the arguments for the
|
|
## operation.
|
|
##
|
|
## Returns: A boolean indicating success or failure of the operation. Type
|
|
## comparison failures against the types passed to
|
|
## :zeek:see:`Storage::open_backend` for the backend will cause false to
|
|
## be returned.
|
|
global put: function(backend: opaque of Storage::BackendHandle, args: Storage::PutArgs): bool;
|
|
|
|
## Gets an entry from the backend.
|
|
##
|
|
## backend: A handle to a backend connection.
|
|
##
|
|
## key: The key to look up.
|
|
##
|
|
## Returns: A boolean indicating success or failure of the operation. Type
|
|
## comparison failures against the types passed to
|
|
## :zeek:see:`Storage::open_backend` for the backend will cause false to
|
|
## be returned.
|
|
global get: function(backend: opaque of Storage::BackendHandle, key: any): any;
|
|
|
|
## Erases an entry from the backend.
|
|
##
|
|
## backend: A handle to a backend connection.
|
|
##
|
|
## key: The key to erase.
|
|
##
|
|
## Returns: A boolean indicating success or failure of the operation. Type
|
|
## comparison failures against the types passed to
|
|
## :zeek:see:`Storage::open_backend` for the backend will cause false to
|
|
## be returned.
|
|
global erase: function(backend: opaque of Storage::BackendHandle, key: any): bool;
|
|
}
|
|
|
|
function open_backend(btype: Storage::Backend, options: any, key_type: any, val_type: any): opaque of Storage::BackendHandle
|
|
{
|
|
return Storage::__open_backend(btype, options, key_type, val_type);
|
|
}
|
|
|
|
function close_backend(backend: opaque of Storage::BackendHandle): bool
|
|
{
|
|
return Storage::__close_backend(backend);
|
|
}
|
|
|
|
function put(backend: opaque of Storage::BackendHandle, args: Storage::PutArgs): bool
|
|
{
|
|
return Storage::__put(backend, args$key, args$value, args$overwrite, args$expire_time);
|
|
}
|
|
|
|
function get(backend: opaque of Storage::BackendHandle, key: any): any
|
|
{
|
|
return Storage::__get(backend, key);
|
|
}
|
|
|
|
function erase(backend: opaque of Storage::BackendHandle, key: any): bool
|
|
{
|
|
return Storage::__erase(backend, key);
|
|
}
|