reference.rst

API reference

• sqlite_utils.db.Database
• sqlite_utils.db.Queryable
• sqlite_utils.db.Table
• sqlite_utils.db.View
• Other
  • sqlite_utils.db.Column
  • sqlite_utils.db.ColumnDetails
• sqlite_utils.utils
  • sqlite_utils.utils.hash_record
  • sqlite_utils.utils.rows_from_file
  • sqlite_utils.utils.TypeTracker
  • sqlite_utils.utils.chunks
  • sqlite_utils.utils.flatten

sqlite_utils.db.Database

.. autoclass:: sqlite_utils.db.Database
    :members:
    :undoc-members:
    :special-members: __getitem__
    :exclude-members: use_counts_table, execute_returning_dicts, resolve_foreign_keys

sqlite_utils.db.Queryable

:ref:`Table <reference_db_table>` and :ref:`View <reference_db_view>` are both subclasses of Queryable, providing access to the following methods:

.. autoclass:: sqlite_utils.db.Queryable
    :members:
    :undoc-members:
    :exclude-members: execute_count

sqlite_utils.db.Table

.. autoclass:: sqlite_utils.db.Table
    :members:
    :undoc-members:
    :show-inheritance:
    :exclude-members: guess_foreign_column, value_or_default, build_insert_queries_and_params, insert_chunk, add_missing_columns

sqlite_utils.db.View

.. autoclass:: sqlite_utils.db.View
    :members:
    :undoc-members:
    :show-inheritance:

Other

sqlite_utils.db.Column

.. autoclass:: sqlite_utils.db.Column

sqlite_utils.db.ColumnDetails

.. autoclass:: sqlite_utils.db.ColumnDetails

sqlite_utils.utils

sqlite_utils.utils.hash_record

.. autofunction:: sqlite_utils.utils.hash_record

sqlite_utils.utils.rows_from_file

.. autofunction:: sqlite_utils.utils.rows_from_file

sqlite_utils.utils.TypeTracker

.. autoclass:: sqlite_utils.utils.TypeTracker
   :members: wrap, types

sqlite_utils.utils.chunks

.. autofunction:: sqlite_utils.utils.chunks

sqlite_utils.utils.flatten

.. autofunction:: sqlite_utils.utils.flatten