<h4>Available options<aclass="headerlink"href="#available-options"title="Permalink to this heading">¶</a></h4>
<ulclass="simple">
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>: IP address of the host running PostgreSQL. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">127.0.0.1</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">port</span></code>: Port number PostgreSQL is listening on. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">5432</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">database</span></code>: Name of the database you are connecting to.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">username</span></code>: Name of the user connecting to the database.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">password</span></code>: Password of the database user.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">query_str</span></code>: Query string to run. Keywords like <codeclass="docutils literal notranslate"><spanclass="pre">LIMIT</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">OFFSET</span></code> are not allowed. Required.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">limit</span></code>: Number of returned results per page. By default it is 10.</p></li>
</ul>
</section>
</section>
<sectionid="mysql">
<h3>MySQL<aclass="headerlink"href="#mysql"title="Permalink to this heading">¶</a></h3>
<h4>Available options<aclass="headerlink"href="#id1"title="Permalink to this heading">¶</a></h4>
<ulclass="simple">
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>: IP address of the host running MySQL. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">127.0.0.1</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">port</span></code>: Port number MySQL is listening on. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">3306</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">database</span></code>: Name of the database you are connecting to.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">auth_plugin</span></code>: Authentication plugin to use. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">caching_sha2_password</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">username</span></code>: Name of the user connecting to the database.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">password</span></code>: Password of the database user.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">query_str</span></code>: Query string to run. Keywords like <codeclass="docutils literal notranslate"><spanclass="pre">LIMIT</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">OFFSET</span></code> are not allowed. Required.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">limit</span></code>: Number of returned results per page. By default it is 10.</p></li>
</ul>
</section>
</section>
<sectionid="sqlite">
<h3>SQLite<aclass="headerlink"href="#sqlite"title="Permalink to this heading">¶</a></h3>
<p>You can read from your database <codeclass="docutils literal notranslate"><spanclass="pre">my_database</span></code> using this example configuration:</p>
<h4>Available options<aclass="headerlink"href="#id2"title="Permalink to this heading">¶</a></h4>
<ulclass="simple">
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">database</span></code>: Name of the database you are connecting to.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">query_str</span></code>: Query string to run. Keywords like <codeclass="docutils literal notranslate"><spanclass="pre">LIMIT</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">OFFSET</span></code> are not allowed. Required.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">limit</span></code>: Number of returned results per page. By default it is 10.</p></li>
</ul>
</section>
</section>
</section>
<sectionid="nosql">
<h2>NoSQL<aclass="headerlink"href="#nosql"title="Permalink to this heading">¶</a></h2>
<p>NoSQL data stores are used for storing arbitrary data without first defining their
structure. To query the supported servers, you must install their drivers using PyPi.</p>
<h4>Available options<aclass="headerlink"href="#id3"title="Permalink to this heading">¶</a></h4>
<ulclass="simple">
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>: IP address of the host running Redis. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">127.0.0.1</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">port</span></code>: Port number Redis is listening on. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">6379</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">password</span></code>: Password if required by Redis.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">db</span></code>: Number of the database you are connecting to.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">exact_match_only</span></code>: Enable if you need exact matching. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">True</span></code>.</p></li>
</ul>
</section>
</section>
<sectionid="mongodb">
<h3>MongoDB<aclass="headerlink"href="#mongodb"title="Permalink to this heading">¶</a></h3>
<h4>Available options<aclass="headerlink"href="#id4"title="Permalink to this heading">¶</a></h4>
<ulclass="simple">
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>: IP address of the host running MongoDB. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">127.0.0.1</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">port</span></code>: Port number MongoDB is listening on. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">27017</span></code>.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">password</span></code>: Password if required by Redis.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">database</span></code>: Name of the database you are connecting to.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">collection</span></code>: Name of the collection you want to search in.</p></li>
<li><p><codeclass="docutils literal notranslate"><spanclass="pre">exact_match_only</span></code>: Enable if you need exact matching. By default it is <codeclass="docutils literal notranslate"><spanclass="pre">True</span></code>.</p></li>