:py:mod:`dissect.sql.sqlite3`
=============================

.. py:module:: dissect.sql.sqlite3


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.sql.sqlite3.SQLite3
   dissect.sql.sqlite3.Column
   dissect.sql.sqlite3.Table
   dissect.sql.sqlite3.Index
   dissect.sql.sqlite3.Row
   dissect.sql.sqlite3.Empty
   dissect.sql.sqlite3.Page
   dissect.sql.sqlite3.Cell
   dissect.sql.sqlite3.WAL
   dissect.sql.sqlite3.WALFrame
   dissect.sql.sqlite3.WALCheckpoint



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.sql.sqlite3.wal_checksum
   dissect.sql.sqlite3.walk_tree
   dissect.sql.sqlite3.read_record
   dissect.sql.sqlite3.varint



.. py:class:: SQLite3(fh, wal_fh=None)


   .. py:method:: open_wal(fh)


   .. py:method:: table(name)


   .. py:method:: tables()


   .. py:method:: index(name)


   .. py:method:: indices()


   .. py:method:: raw_page(num)


   .. py:method:: page(num)


   .. py:method:: pages()


   .. py:method:: cells()



.. py:class:: Column(name: str, description: str)


   Describes a column of a sqlite table.

   .. py:attribute:: SPACE
      :value: '\\s'

      

   .. py:attribute:: EXPRESSION
      :value: '\\(.+?\\)'

      

   .. py:attribute:: STRING
      :value: '[\'\\"].+?[\'\\"]'

      

   .. py:attribute:: TOKENIZER_EXPRESSION

      

   .. py:method:: __eq__(other)

      Return self==value.


   .. py:method:: __repr__()

      Return repr(self).



.. py:class:: Table(sqlite, type_, name, table_name, page, sql)


   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: __iter__()


   .. py:method:: row(idx)


   .. py:method:: rows()



.. py:class:: Index(sqlite, type_, name, table_name, page, sql)


   .. py:method:: __repr__()

      Return repr(self).



.. py:class:: Row(table, cell)


   .. py:method:: __iter__()


   .. py:method:: __getitem__(key)


   .. py:method:: __getattr__(key)


   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: get(key, default=None)



.. py:class:: Empty



.. py:class:: Page(sqlite, num)


   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: open()


   .. py:method:: cell(num)


   .. py:method:: cells()



.. py:class:: Cell(page, offset)


   .. py:property:: data


   .. py:property:: types


   .. py:property:: values


   .. py:method:: __repr__()

      Return repr(self).



.. py:class:: WAL(fh)


   .. py:method:: frame(frame_idx)


   .. py:method:: frames()


   .. py:method:: checkpoints()



.. py:class:: WALFrame(wal, offset)


   .. py:property:: valid


   .. py:property:: data


   .. py:property:: page_number


   .. py:property:: page_count


   .. py:method:: __repr__()

      Return repr(self).



.. py:class:: WALCheckpoint(wal, frames)


   .. py:property:: page_map


   .. py:method:: __contains__(page)


   .. py:method:: __getitem__(page)


   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: get(page, default=None)



.. py:function:: wal_checksum(buf, endian='>')

   For future use, will be used when WAL is fully implemented


.. py:function:: walk_tree(sqlite, page)


.. py:function:: read_record(fh, encoding)


.. py:function:: varint(fh)