=========== Changelog =========== .. _v1_0: 1.0 (2019-05-24) ---------------- - Option to automatically add new columns if you attempt to insert or upsert data with extra fields: ``sqlite-utils insert ... --alter`` - see :ref:`Adding columns automatically with the sqlite-utils CLI ` ``db["tablename"].insert(record, alter=True)`` - see :ref:`Adding columns automatically using the Python API ` - New ``--json-cols`` option for outputting nested JSON, see :ref:`cli_json_values` .. _v0_14: 0.14 (2019-02-24) ----------------- - Ability to create unique indexes: ``db["mytable"].create_index(["name"], unique=True)`` - ``db["mytable"].create_index(["name"], if_not_exists=True)`` - ``$ sqlite-utils create-index mydb.db mytable col1 [col2...]``, see :ref:`cli_create_index` - ``table.add_column(name, type)`` method, see :ref:`python_api_add_column` - ``$ sqlite-utils add-column mydb.db mytable nameofcolumn``, see :ref:`cli_add_column` (CLI) - ``db["books"].add_foreign_key("author_id", "authors", "id")``, see :ref:`python_api_add_foreign_key` - ``$ sqlite-utils add-foreign-key books.db books author_id authors id``, see :ref:`cli_add_foreign_key` (CLI) - Improved (but backwards-incompatible) ``foreign_keys=`` argument to various methods, see :ref:`python_api_foreign_keys` .. _v0_13: 0.13 (2019-02-23) ----------------- - New ``--table`` and ``--fmt`` options can be used to output query results in a variety of visual table formats, see :ref:`cli_query_table` - New ``hash_id=`` argument can now be used for :ref:`python_api_hash` - Can now derive correct column types for numpy int, uint and float values - ``table.last_id`` has been renamed to ``table.last_rowid`` - ``table.last_pk`` now contains the last inserted primary key, if ``pk=`` was specified - Prettier indentation in the ``CREATE TABLE`` generated schemas .. _v0_12: 0.12 (2019-02-22) ----------------- - Added ``db[table].rows`` iterator - see :ref:`python_api_rows` - Replaced ``sqlite-utils json`` and ``sqlite-utils csv`` with a new default subcommand called ``sqlite-utils query`` which defaults to JSON and takes formatting options ``--nl``, ``--csv`` and ``--no-headers`` - see :ref:`cli_query_json` and :ref:`cli_query_csv` - New ``sqlite-utils rows data.db name-of-table`` command, see :ref:`cli_rows` - ``sqlite-utils table`` command now takes options ``--counts`` and ``--columns`` plus the standard output format options, see :ref:`cli_tables` .. _v0_11: 0.11 (2019-02-07) ----------------- New commands for enabling FTS against a table and columns:: sqlite-utils enable-fts db.db mytable col1 col2 See :ref:`cli_fts`. .. _v0_10: 0.10 (2019-02-06) ----------------- Handle ``datetime.date`` and ``datetime.time`` values. New option for efficiently inserting rows from a CSV: :: sqlite-utils insert db.db foo - --csv .. _v0_9: 0.9 (2019-01-27) ---------------- Improved support for newline-delimited JSON. ``sqlite-utils insert`` has two new command-line options: * ``--nl`` means "expect newline-delimited JSON". This is an extremely efficient way of loading in large amounts of data, especially if you pipe it into standard input. * ``--batch-size=1000`` lets you increase the batch size (default is 100). A commit will be issued every X records. This also control how many initial records are considered when detecting the desired SQL table schema for the data. In the Python API, the ``table.insert_all(...)`` method can now accept a generator as well as a list of objects. This will be efficiently used to populate the table no matter how many records are produced by the generator. The ``Database()`` constructor can now accept a ``pathlib.Path`` object in addition to a string or an existing SQLite connection object. .. _v0_8: 0.8 (2019-01-25) ---------------- Two new commands: ``sqlite-utils csv`` and ``sqlite-utils json`` These commands execute a SQL query and return the results as CSV or JSON. See :ref:`cli_query_csv` and :ref:`cli_query_json` for more details. :: $ sqlite-utils json --help Usage: sqlite-utils json [OPTIONS] PATH SQL Execute SQL query and return the results as JSON Options: --nl Output newline-delimited JSON --arrays Output rows as arrays instead of objects --help Show this message and exit. $ sqlite-utils csv --help Usage: sqlite-utils csv [OPTIONS] PATH SQL Execute SQL query and return the results as CSV Options: --no-headers Exclude headers from CSV output --help Show this message and exit. .. _v0_7: 0.7 (2019-01-24) ---------------- This release implements the ``sqlite-utils`` command-line tool with a number of useful subcommands. - ``sqlite-utils tables demo.db`` lists the tables in the database - ``sqlite-utils tables demo.db --fts4`` shows just the FTS4 tables - ``sqlite-utils tables demo.db --fts5`` shows just the FTS5 tables - ``sqlite-utils vacuum demo.db`` runs VACUUM against the database - ``sqlite-utils optimize demo.db`` runs OPTIMIZE against all FTS tables, then VACUUM - ``sqlite-utils optimize demo.db --no-vacuum`` runs OPTIMIZE but skips VACUUM The two most useful subcommands are ``upsert`` and ``insert``, which allow you to ingest JSON files with one or more records in them, creating the corresponding table with the correct columns if it does not already exist. See :ref:`cli_inserting_data` for more details. - ``sqlite-utils insert demo.db dogs dogs.json --pk=id`` inserts new records from ``dogs.json`` into the ``dogs`` table - ``sqlite-utils upsert demo.db dogs dogs.json --pk=id`` upserts records, replacing any records with duplicate primary keys One backwards incompatible change: the ``db["table"].table_names`` property is now a method: - ``db["table"].table_names()`` returns a list of table names - ``db["table"].table_names(fts4=True)`` returns a list of just the FTS4 tables - ``db["table"].table_names(fts5=True)`` returns a list of just the FTS5 tables A few other changes: - Plenty of updated documentation, including full coverage of the new command-line tool - Allow column names to be reserved words (use correct SQL escaping) - Added automatic column support for bytes and datetime.datetime .. _v0_6: 0.6 (2018-08-12) ---------------- - ``.enable_fts()`` now takes optional argument ``fts_version``, defaults to ``FTS5``. Use ``FTS4`` if the version of SQLite bundled with your Python does not support FTS5 - New optional ``column_order=`` argument to ``.insert()`` and friends for providing a partial or full desired order of the columns when a database table is created - :ref:`New documentation ` for ``.insert_all()`` and ``.upsert()`` and ``.upsert_all()`` .. _v0_5: 0.5 (2018-08-05) ---------------- - ``db.tables`` and ``db.table_names`` introspection properties - ``db.indexes`` property for introspecting indexes - ``table.create_index(columns, index_name)`` method - ``db.create_view(name, sql)`` method - Table methods can now be chained, plus added ``table.last_id`` for accessing the last inserted row ID 0.4 (2018-07-31) ---------------- - ``enable_fts()``, ``populate_fts()`` and ``search()`` table methods