sqlite-utils

sqlite-utils rows data.db table --json-cols - fixed bug where --json-cols was not obeyed

• sqlite-utils rows data.db table --json-cols - fixed bug where --json-cols was not obeyed

• Option to automatically add new columns if you attempt to insert or upsert data with extra fields: sqlite-utils insert ... --alter - see Adding columns automatically with the sqlite-utils CLI

db["tablename"].insert(record, alter=True) - see Adding columns automatically using the Python API

New --json-cols option for outputting nested JSON, see Nested JSON values

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 Creating indexes

table.add_column(name, type) method, see Adding columns

$ sqlite-utils add-column mydb.db mytable nameofcolumn , see Adding columns (CLI)

db["books"].add_foreign_key("author_id", "authors", "id") , see Adding foreign key constraints

$ sqlite-utils add-foreign-key books.db books author_id authors id , see Adding foreign key constraints (CLI)

Improved (but backwards-incompatible) foreign_keys= argument to various methods, see Specifying foreign keys

• 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 cli_create_index

• table.add_column(name, type) method, see python_api_add_column

• $ sqlite-utils add-column mydb.db mytable nameofcolumn, see cli_add_column (CLI)

• db["books"].add_foreign_key("author_id", "authors", "id"), see python_api_add_foreign_key

• $ sqlite-utils add-foreign-key books.db books author_id authors id, see cli_add_foreign_key (CLI)

• Improved (but backwards-incompatible) foreign_keys= argument to various methods, see python_api_foreign_keys

New --table and --fmt options can be used to output query results in a variety of visual table formats, see Table-formatted output

New hash_id= argument can now be used for Setting an ID based on the hash of the row contents

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

• New --table and --fmt options can be used to output query results in a variety of visual table formats, see cli_query_table

• New hash_id= argument can now be used for 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

Added db[table].rows iterator - see Listing 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 Returning JSON and Returning CSV or TSV

New sqlite-utils rows data.db name-of-table command, see Returning all rows in a table

sqlite-utils table command now takes options --counts and --columns plus the standard output format options, see Listing tables

• Added db[table].rows iterator - see 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 cli_query_json and cli_query_csv

• New sqlite-utils rows data.db name-of-table command, see cli_rows

• sqlite-utils table command now takes options --counts and --columns plus the standard output format options, see cli_tables

New commands for enabling FTS against a table and columns:

sqlite-utils enable-fts db.db mytable col1 col2

See Configuring full-text search .

New commands for enabling FTS against a table and columns:

sqlite-utils enable-fts db.db mytable col1 col2

See cli_fts.

Handle datetime.date and datetime.time values.

New option for efficiently inserting rows from a CSV:

sqlite-utils insert db.db foo - --csv

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.

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 Returning CSV or TSV and Returning 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.

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 cli_query_csv and 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.

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 Inserting JSON 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

• Initial release to PyPI