source: server/databases/sqlite.xml@ 9fd586e9

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!-- moved to packages.ent because they are often forgotten...
  <!ENTITY sqlite-dl-version    "3360000">
  <!ENTITY sqlite-doc-version   "3360000">

When updating, do not forget the above entities... They are anyway -->

  <!ENTITY sqlite-download-http "https://sqlite.org/&sqlite-year;/sqlite-autoconf-&sqlite-dl-version;.tar.gz">
  <!ENTITY sqlite-download-ftp  " ">
  <!ENTITY sqlite-md5sum        "0c5a92bc51cf07cae45b4a1e94653dea">
  <!ENTITY sqlite-size          "3.1 MB">
  <!ENTITY sqlite-buildsize     "76 MB">
  <!ENTITY sqlite-time          "0.3 SBU (Using parallelism=4)">

  <!ENTITY sqlite-docs-download "https://sqlite.org/&sqlite-year;/sqlite-doc-&sqlite-doc-version;.zip">
  <!ENTITY sqlite-docs-md5sum   "f3cb6b67a82bc586a096459085616e4f">
  <!ENTITY sqlite-docs-size     "11 MB">
]>

<sect1 id="sqlite" xreflabel="SQLite-&sqlite-version;">
  <?dbhtml filename="sqlite.html"?>


  <title>SQLite-&sqlite-version;</title>

  <indexterm zone="sqlite">
    <primary sortas="a-SQLite">SQLite</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to SQLite</title>

    <para>
      The <application>SQLite</application> package is a software library that
      implements a self-contained, serverless, zero-configuration, transactional
      SQL database engine.
    </para>

    &lfs113_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&sqlite-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&sqlite-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &sqlite-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &sqlite-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &sqlite-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &sqlite-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <title>Optional Documentation</title>
      <listitem>
        <para>
          Download (HTTP): <ulink url="&sqlite-docs-download;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &sqlite-docs-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &sqlite-docs-size;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">SQLite Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="https://www.thrysoee.dk/editline/">libedit</ulink> and
      <xref linkend="unzip"/> (required to unzip the documentation)
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/sqlite"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of SQLite</title>

    <para>
      If you downloaded the optional documentation, issue the following command
      to install the documentation into the source tree:
    </para>

<screen><userinput>unzip -q ../sqlite-doc-&sqlite-doc-version;.zip</userinput></screen>

    <para>
      Install <application>SQLite</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr     \
            --disable-static  \
            --enable-fts{4,5} \
            CPPFLAGS="-DSQLITE_ENABLE_COLUMN_METADATA=1 \
                      -DSQLITE_ENABLE_UNLOCK_NOTIFY=1   \
                      -DSQLITE_ENABLE_DBSTAT_VTAB=1     \
                      -DSQLITE_SECURE_DELETE=1          \
                      -DSQLITE_ENABLE_FTS3_TOKENIZER=1" &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>
      If you downloaded the optional documentation, issue the following commands
      as the <systemitem class="username">root</systemitem> user to install it:
    </para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/sqlite-&sqlite-version; &amp;&amp;
cp -v -R sqlite-doc-&sqlite-doc-version;/* /usr/share/doc/sqlite-&sqlite-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <para>
      <parameter>--enable-fts{4,5}</parameter>: These switches enable
      support for version 3, 4 and 5 of the full text search (FTS)
      extension.  Note that the <option>--enable-fts4</option> switch
      enables support for both FTS version 4 and FTS version 3.
    </para>

    <para>
      <parameter>CPPFLAGS="-DSQLITE_ENABLE_COLUMN_METADATA=1
      -DSQLITE_ENABLE_UNLOCK_NOTIFY=1
      -DSQLITE_ENABLE_DBSTAT_VTAB=1
      -DSQLITE_SECURE_DELETE=1
      -DSQLITE_ENABLE_FTS3_TOKENIZER=1"</parameter>: Applications such as
      <application>SeaMonkey</application> require these options
      to be turned on.
      The only way to do this is to include them in
      the <envar>CFLAGS</envar> or <envar>CPPFLAGS</envar>.
      We use the latter so the default value (or any value set by the user)
      of <envar>CFLAGS</envar> won't be affected.
      For further information on what can be specified see <ulink
      url="https://www.sqlite.org/compile.html"/>.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          sqlite3
        </seg>
        <seg>
          libsqlite3.so
        </seg>
        <seg>
          /usr/share/doc/sqlite-&sqlite-version;
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="sqlite3">
        <term><command>sqlite3</command></term>
        <listitem>
          <para>
            is a terminal-based front-end to the <application>SQLite</application>
            library that can evaluate queries interactively and display the
            results
          </para>
          <indexterm zone="sqlite sqlite3">
            <primary sortas="b-sqlite3">sqlite3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsqlite3">
        <term><filename class="libraryfile">libsqlite3.so</filename></term>
        <listitem>
          <para>
            contains the <application>SQLite</application> API functions
          </para>
          <indexterm zone="sqlite libsqlite3">
            <primary sortas="c-libsqlite3">libsqlite3.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>