1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
|
.. _reference:
===============
API reference
===============
.. contents:: :local:
:class: this-will-duplicate-information-and-it-is-still-useful-here
.. _reference_db_database:
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
.. _reference_db_queryable:
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
.. _reference_db_table:
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
.. _reference_db_view:
sqlite_utils.db.View
====================
.. autoclass:: sqlite_utils.db.View
:members:
:undoc-members:
:show-inheritance:
.. _reference_db_other:
Other
=====
.. _reference_db_other_column:
sqlite_utils.db.Column
----------------------
.. autoclass:: sqlite_utils.db.Column
.. _reference_db_other_column_details:
sqlite_utils.db.ColumnDetails
-----------------------------
.. autoclass:: sqlite_utils.db.ColumnDetails
sqlite_utils.utils
==================
.. _reference_utils_hash_record:
sqlite_utils.utils.hash_record
------------------------------
.. autofunction:: sqlite_utils.utils.hash_record
.. _reference_utils_rows_from_file:
sqlite_utils.utils.rows_from_file
---------------------------------
.. autofunction:: sqlite_utils.utils.rows_from_file
.. _reference_utils_typetracker:
sqlite_utils.utils.TypeTracker
------------------------------
.. autoclass:: sqlite_utils.utils.TypeTracker
:members: wrap, types
.. _reference_utils_chunks:
sqlite_utils.utils.chunks
-------------------------
.. autofunction:: sqlite_utils.utils.chunks
.. _reference_utils_flatten:
sqlite_utils.utils.flatten
--------------------------
.. autofunction:: sqlite_utils.utils.flatten
|