diff --git a/docs/changelog.rst b/docs/changelog.rst index 9d4770f..7e1e6a9 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -201,7 +201,7 @@ Other changes 2.17 (2020-09-07) ----------------- -This release handles a bug where replacing rows in FTS tables could result in growing numbers of unneccessary rows in the associated ``*_fts_docsize`` table. (`#149 `__) +This release handles a bug where replacing rows in FTS tables could result in growing numbers of unnecessary rows in the associated ``*_fts_docsize`` table. (`#149 `__) - ``PRAGMA recursive_triggers=on`` by default for all connections. You can turn it off with ``Database(recursive_triggers=False)``. (`#152 `__) - ``table.optimize()`` method now deletes unnecessary rows from the ``*_fts_docsize`` table. (`#153 `__) @@ -272,7 +272,7 @@ The theme of this release is better tools for working with binary data. The new - ``sqlite-utils insert-files my.db gifs *.gif`` can now insert the contents of files into a specified table. The columns in the table can be customized to include different pieces of metadata derived from the files. See :ref:`cli_insert_files`. (`#122 `__) - ``--raw`` option to ``sqlite-utils query`` - for outputting just a single raw column value - see :ref:`cli_query_raw`. (`#123 `__) -- JSON output now encodes BLOB values as special base64 obects - see :ref:`cli_query_json`. (`#125 `__) +- JSON output now encodes BLOB values as special base64 objects - see :ref:`cli_query_json`. (`#125 `__) - The same format of JSON base64 objects can now be used to insert binary data - see :ref:`cli_inserting_data`. (`#126 `__) - The ``sqlite-utils query`` command can now accept named parameters, e.g. ``sqlite-utils :memory: "select :num * :num2" -p num 5 -p num2 6`` - see :ref:`cli_query_json`. (`#124 `__) @@ -594,7 +594,7 @@ Support for lookup tables. 1.2 (2019-06-12) ---------------- -- Improved foreign key definitions: you no longer need to specify the ``column``, ``other_table`` AND ``other_column`` to define a foreign key - if you omit the ``other_table`` or ``other_column`` the script will attempt to guess the correct values by instrospecting the database. See :ref:`python_api_add_foreign_key` for details. (`#25 `__) +- Improved foreign key definitions: you no longer need to specify the ``column``, ``other_table`` AND ``other_column`` to define a foreign key - if you omit the ``other_table`` or ``other_column`` the script will attempt to guess the correct values by introspecting the database. See :ref:`python_api_add_foreign_key` for details. (`#25 `__) - Ability to set ``NOT NULL`` constraints and ``DEFAULT`` values when creating tables (`#24 `__). Documentation: :ref:`Setting defaults and not null constraints (Python API) `, :ref:`Setting defaults and not null constraints (CLI) ` - Support for ``not_null_default=X`` / ``--not-null-default`` for setting a ``NOT NULL DEFAULT 'x'`` when adding a new column. Documentation: :ref:`Adding columns (Python API) `, :ref:`Adding columns (CLI) ` @@ -603,7 +603,7 @@ Support for lookup tables. 1.1 (2019-05-28) ---------------- -- Support for ``ignore=True`` / ``--ignore`` for ignoring inserted records if the primary key alread exists (`#21 `__) - documentation: :ref:`Inserting data (Python API) `, :ref:`Inserting data (CLI) ` +- Support for ``ignore=True`` / ``--ignore`` for ignoring inserted records if the primary key already exists (`#21 `__) - documentation: :ref:`Inserting data (Python API) `, :ref:`Inserting data (CLI) ` - Ability to add a column that is a foreign key reference using ``fk=...`` / ``--fk`` (`#16 `__) - documentation: :ref:`Adding columns (Python API) `, :ref:`Adding columns (CLI) ` .. _v1_0_1: diff --git a/docs/cli.rst b/docs/cli.rst index 8a049a6..b314b2d 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -34,7 +34,7 @@ Use ``--nl`` to get back newline-delimited JSON objects:: {"id": 1, "age": 4, "name": "Cleo"} {"id": 2, "age": 2, "name": "Pancakes"} -You can use ``--arrays`` to request ararys instead of objects:: +You can use ``--arrays`` to request arrays instead of objects:: $ sqlite-utils dogs.db "select * from dogs" --arrays [[1, 4, "Cleo"], @@ -75,7 +75,7 @@ Binary strings are not valid JSON, so BLOB columns containing binary data will b } ] -If you execute an ``UPDATE``, ``INSERT`` or ``DELETE`` query the comand will return the number of affected rows:: +If you execute an ``UPDATE``, ``INSERT`` or ``DELETE`` query the command will return the number of affected rows:: $ sqlite-utils dogs.db "update dogs set age = 5 where name = 'Cleo'" [{"rows_affected": 1}] @@ -1186,7 +1186,7 @@ Both of these commands accept one or more database files as arguments. Loading SQLite extensions ========================= -Many of these commands have the ablity to load additional SQLite extensions using the ``--load-extension=/path/to/extension`` option - use ``--help`` to check for support, e.g. ``sqlite-utils rows --help``. +Many of these commands have the ability to load additional SQLite extensions using the ``--load-extension=/path/to/extension`` option - use ``--help`` to check for support, e.g. ``sqlite-utils rows --help``. This option can be applied multiple times to load multiple extensions. diff --git a/docs/python-api.rst b/docs/python-api.rst index e5ffd44..11b1f0c 100644 --- a/docs/python-api.rst +++ b/docs/python-api.rst @@ -603,7 +603,7 @@ The first argument to ``update()`` is the primary key. This can be a single valu >>> db["compound_dogs"].update((5, 3), {"name": "Updated"}) -The second argument is a dictonary of columns that should be updated, along with their new values. +The second argument is a dictionary of columns that should be updated, along with their new values. You can cause any missing columns to be added automatically using ``alter=True``::