mirror of
https://github.com/simonw/sqlite-utils.git
synced 2026-07-22 08:54:33 +02:00
f5c63088e1Closes #559 Closes #235 Refs https://github.com/simonw/llm/issues/60 - Uses `sqlean` in place of `sqlite3` if `sqlean.py` is installed - Uses `sqlite-dump` if available and `conn.iterdump()` does not exist - New `with db.ensure_autocommit_off()` method for ensuring autocommit is off, used by `enable_wal()` and `disable_wal()`.
90 lines
No EOL
3 KiB
ReStructuredText
90 lines
No EOL
3 KiB
ReStructuredText
.. _installation:
|
|
|
|
==============
|
|
Installation
|
|
==============
|
|
|
|
``sqlite-utils`` is tested on Linux, macOS and Windows.
|
|
|
|
.. _installation_homebrew:
|
|
|
|
Using Homebrew
|
|
==============
|
|
|
|
The :ref:`sqlite-utils command-line tool <cli>` can be installed on macOS using Homebrew::
|
|
|
|
brew install sqlite-utils
|
|
|
|
If you have it installed and want to upgrade to the most recent release, you can run::
|
|
|
|
brew upgrade sqlite-utils
|
|
|
|
Then run ``sqlite-utils --version`` to confirm the installed version.
|
|
|
|
.. _installation_pip:
|
|
|
|
Using pip
|
|
=========
|
|
|
|
The `sqlite-utils package <https://pypi.org/project/sqlite-utils/>`__ on PyPI includes both the :ref:`sqlite_utils Python library <python_api>` and the ``sqlite-utils`` command-line tool. You can install them using ``pip`` like so::
|
|
|
|
pip install sqlite-utils
|
|
|
|
.. _installation_pipx:
|
|
|
|
Using pipx
|
|
==========
|
|
|
|
`pipx <https://pypi.org/project/pipx/>`__ is a tool for installing Python command-line applications in their own isolated environments. You can use ``pipx`` to install the ``sqlite-utils`` command-line tool like this::
|
|
|
|
pipx install sqlite-utils
|
|
|
|
.. _installation_sqlite3_alternatives:
|
|
|
|
Alternatives to sqlite3
|
|
=======================
|
|
|
|
By default, ``sqlite-utils`` uses the ``sqlite3`` package bundled with the Python standard library.
|
|
|
|
Depending on your operating system, this may come with some limitations.
|
|
|
|
On some platforms the ability to load additional extensions (via ``conn.load_extension(...)`` or ``--load-extension=/path/to/extension``) may be disabled.
|
|
|
|
You may also see the error ``sqlite3.OperationalError: table sqlite_master may not be modified`` when trying to alter an existing table.
|
|
|
|
You can work around these limitations by installing either the `pysqlite3 <https://pypi.org/project/pysqlite3/>`__ package or the `sqlean.py <https://pypi.org/project/sqlean.py/>`__ package, both of which provide drop-in replacements for the standard library ``sqlite3`` module but with a recent version of SQLite and full support for loading extensions.
|
|
|
|
To install ``sqlean.py`` (which has compiled binary wheels available for all major platforms) run the following:
|
|
|
|
.. code-block:: bash
|
|
|
|
sqlite-utils install sqlean.py
|
|
|
|
``pysqlite3`` and ``sqlean.py`` do not provide implementations of the ``.iterdump()`` method. To use that method (see :ref:`python_api_itedump`) or the ``sqlite-utils dump`` command you should also install the ``sqlite-dump`` package:
|
|
|
|
.. code-block:: bash
|
|
|
|
sqlite-utils install sqlite-dump
|
|
|
|
.. _installation_completion:
|
|
|
|
Setting up shell completion
|
|
===========================
|
|
|
|
You can configure shell tab completion for the ``sqlite-utils`` command using these commands.
|
|
|
|
For ``bash``:
|
|
|
|
.. code-block:: bash
|
|
|
|
eval "$(_SQLITE_UTILS_COMPLETE=bash_source sqlite-utils)"
|
|
|
|
For ``zsh``:
|
|
|
|
.. code-block:: zsh
|
|
|
|
eval "$(_SQLITE_UTILS_COMPLETE=zsh_source sqlite-utils)"
|
|
|
|
Add this code to ``~/.zshrc`` or ``~/.bashrc`` to automatically run it when you start a new shell.
|
|
|
|
See `the Click documentation <https://click.palletsprojects.com/en/8.1.x/shell-completion/>`__ for more details. |