:plugin: sqlite
:type: input
:default_codec: plain

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Sqlite input plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

Read rows from an sqlite database.

This is most useful in cases where you are logging directly to a table.
Any tables being watched must have an `id` column that is monotonically
increasing.

All tables are read by default except:

* ones matching `sqlite_%` - these are internal/adminstrative tables for sqlite
* `since_table` - this is used by this plugin to track state.

Example
[source,sql]
    % sqlite /tmp/example.db
    sqlite> CREATE TABLE weblogs (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        ip STRING,
        request STRING,
        response INTEGER);
    sqlite> INSERT INTO weblogs (ip, request, response) 
        VALUES ("1.2.3.4", "/index.html", 200);

Then with this logstash config:
[source,ruby]
    input {
      sqlite {
        path => "/tmp/example.db"
        type => weblogs
      }
    }
    output {
      stdout {
        debug => true
      }
    }

Sample output:
[source,ruby]
    {
      "@source"      => "sqlite://sadness/tmp/x.db",
      "@tags"        => [],
      "@fields"      => {
        "ip"       => "1.2.3.4",
        "request"  => "/index.html",
        "response" => 200
      },
      "@timestamp"   => "2013-05-29T06:16:30.850Z",
      "@source_host" => "sadness",
      "@source_path" => "/tmp/x.db",
      "@message"     => "",
      "@type"        => "foo"
    }


[id="plugins-{type}s-{plugin}-options"]
==== Sqlite Input Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-batch>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-exclude_tables>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-path>> |<<string,string>>|Yes
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
input plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-batch"]
===== `batch` 

  * Value type is <<number,number>>
  * Default value is `5`

How many rows to fetch at a time from each `SELECT` call.

[id="plugins-{type}s-{plugin}-exclude_tables"]
===== `exclude_tables` 

  * Value type is <<array,array>>
  * Default value is `[]`

Any tables to exclude by name.
By default all tables are followed.

[id="plugins-{type}s-{plugin}-path"]
===== `path` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The path to the sqlite database file.



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]

:default_codec!: