diff --git a/scripts/base/frameworks/input/readers/sqlite.bro b/scripts/base/frameworks/input/readers/sqlite.bro index 2cd025e7d4..3ed2a88461 100644 --- a/scripts/base/frameworks/input/readers/sqlite.bro +++ b/scripts/base/frameworks/input/readers/sqlite.bro @@ -1,6 +1,12 @@ -##! Interface for the SQLite input reader. +##! Interface for the SQLite input reader. Redefinable options are available +##! to tweak the input format of the SQLite reader. ##! -##! The defaults are set to match Bro's ASCII output. +##! 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. module InputSQLite; diff --git a/scripts/base/frameworks/logging/writers/sqlite.bro b/scripts/base/frameworks/logging/writers/sqlite.bro index 5df5e356c8..883c67d760 100644 --- a/scripts/base/frameworks/logging/writers/sqlite.bro +++ b/scripts/base/frameworks/logging/writers/sqlite.bro @@ -1,5 +1,13 @@ -##! Interface for the SQLite log writer. Redefinable options are available +##! Interface for the SQLite log writer. Redefinable options are available ##! to tweak the output format of the SQLite reader. +##! +##! See :doc:`/frameworks/logging-input-sqlite` for an introduction on how to +##! use the SQLite log writer. +##! +##! The SQL writer currently supports one writer-specific filter option via +##! ``config``: setting ``tablename`` sets the name of the table that is used +##! or created in the SQLite database. An example for this is given in the +##! introduction mentioned above. module LogSQLite;