Update comments in script files, run zeek-format on all of them

This commit is contained in:
Tim Wojtulewicz 2025-03-17 14:00:14 -07:00
parent d0741c8001
commit f40947f6ac
5 changed files with 104 additions and 77 deletions

View file

@ -7,20 +7,20 @@ module Storage::Backend::Redis;
export {
## Options record for the built-in Redis backend.
type Options: record {
# Address or hostname of the server
# Address or hostname of the server.
server_host: string &optional;
# Port for the server
# Port for the server.
server_port: port &default=6379/tcp;
# Server unix socket file. This can be used instead of the
# address and port above to connect to a local server.
# Server unix socket file. This can be used instead of the address and
# port above to connect to a local server. In order to use this, the
# ``server_host`` field must be unset.
server_unix_socket: string &optional;
# Prefix used in key values stored to differentiate varying
# types of data on the same server. Defaults to an empty string,
# but preferably should be set to a unique value per Redis
# backend opened.
# Prefix used in key values stored to differentiate varying types of data
# on the same server. Defaults to an empty string, but preferably should
# be set to a unique value per Redis backend opened.
key_prefix: string &default="";
};
}

View file

@ -7,21 +7,22 @@ module Storage::Backend::SQLite;
export {
## Options record for the built-in SQLite backend.
type Options: record {
## Path to the database file on disk. Setting this to ":memory:"
## will tell SQLite to use an in-memory database. Relative paths
## will be opened relative to the directory where Zeek was
## started from. Zeek will not create intermediate directories
## if they do not already exist. See
## https://www.sqlite.org/c3ref/open.html for more rules on
## paths that can be passed here.
## Path to the database file on disk. Setting this to ":memory:" will tell
## SQLite to use an in-memory database. Relative paths will be opened
## relative to the directory where Zeek was started from. Zeek will not
## create intermediate directories if they do not already exist. See
## https://www.sqlite.org/c3ref/open.html for more rules on paths that can
## be passed here.
database_path: string;
## Name of the table used for storing data.
## Name of the table used for storing data. It is possible to use the same
## database file for two separate tables, as long as the this value is
## different between the two.
table_name: string;
## Key/value table for passing tuning parameters when opening
## the database. These must be pairs that can be passed to the
## ``pragma`` command in sqlite.
## Key/value table for passing tuning parameters when opening the
## database. These must be pairs that can be passed to the ``pragma``
## command in sqlite.
tuning_params: table[string] of string &default=table(
["journal_mode"] = "WAL",
["synchronous"] = "normal",