mirror of
https://github.com/zeek/zeek.git
synced 2025-10-14 12:38:20 +00:00
Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
This commit is contained in:
parent
83f1e74643
commit
ded98cd373
1074 changed files with 169319 additions and 0 deletions
62
doc/scripts/base/frameworks/input/readers/sqlite.zeek.rst
Normal file
62
doc/scripts/base/frameworks/input/readers/sqlite.zeek.rst
Normal file
|
@ -0,0 +1,62 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/input/readers/sqlite.zeek
|
||||
=========================================
|
||||
.. zeek:namespace:: InputSQLite
|
||||
|
||||
Interface for the SQLite input reader. Redefinable options are available
|
||||
to tweak the input format of the SQLite reader.
|
||||
|
||||
See :doc:`/frameworks/logging-input-sqlite` for an introduction on how to
|
||||
use the SQLite reader.
|
||||
|
||||
When using the SQLite reader, you have to specify the SQL query that returns
|
||||
the desired data by setting ``query`` in the ``config`` table. See the
|
||||
introduction mentioned above for an example.
|
||||
|
||||
:Namespace: InputSQLite
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
============================================================================== ===========================================
|
||||
:zeek:id:`InputSQLite::empty_field`: :zeek:type:`string` :zeek:attr:`&redef` String to use for empty fields.
|
||||
:zeek:id:`InputSQLite::set_separator`: :zeek:type:`string` :zeek:attr:`&redef` Separator between set elements.
|
||||
:zeek:id:`InputSQLite::unset_field`: :zeek:type:`string` :zeek:attr:`&redef` String to use for an unset &optional field.
|
||||
============================================================================== ===========================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. zeek:id:: InputSQLite::empty_field
|
||||
:source-code: base/frameworks/input/readers/sqlite.zeek 22 22
|
||||
|
||||
:Type: :zeek:type:`string`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``"(empty)"``
|
||||
|
||||
String to use for empty fields.
|
||||
|
||||
.. zeek:id:: InputSQLite::set_separator
|
||||
:source-code: base/frameworks/input/readers/sqlite.zeek 16 16
|
||||
|
||||
:Type: :zeek:type:`string`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``","``
|
||||
|
||||
Separator between set elements.
|
||||
Please note that the separator has to be exactly one character long.
|
||||
|
||||
.. zeek:id:: InputSQLite::unset_field
|
||||
:source-code: base/frameworks/input/readers/sqlite.zeek 19 19
|
||||
|
||||
:Type: :zeek:type:`string`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``"-"``
|
||||
|
||||
String to use for an unset &optional field.
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue