Changelog¶
2.9.1 (2020-05-11)¶
- Added custom project links to the PyPI listing.
2.9 (2020-05-10)¶
- New
sqlite-utils drop-table
command, see Dropping tables. (#111) - New
sqlite-utils drop-view
command, see Dropping views. - Python
decimal.Decimal
objects are now stored asFLOAT
. (#110)
2.8 (2020-05-03)¶
- New
sqlite-utils create-table
command, see Creating tables. (#27) - New
sqlite-utils create-view
command, see Creating views. (#107)
2.7.2 (2020-05-02)¶
db.create_view(...)
now has additional parametersignore=True
orreplace=True
, see Creating views. (#106)
2.7.1 (2020-05-01)¶
- New
sqlite-utils views my.db
command for listing views in a database, see Listing views. (#105) sqlite-utils tables
(andviews
) has a new--schema
option which outputs the table/view schema, see Listing tables. (#104)- Nested structures containing invalid JSON values (e.g. Python bytestrings) are now serialized using
repr()
instead of throwing an error. (#102)
2.7 (2020-04-17)¶
- New
columns=
argument for the.insert()
,.insert_all()
,.upsert()
and.upsert_all()
methods, for over-riding the auto-detected types for columns and specifying additional columns that should be added when the table is created. See Custom column order and column types. (#100)
2.6 (2020-04-15)¶
- New
table.rows_where(..., order_by="age desc")
argument, see Listing rows. (#76)
2.5 (2020-04-12)¶
2.4.2 (2020-03-14)¶
table.column_dicts
now works with all column types - previously it would throw errors on types other thanTEXT
,BLOB
,INTEGER
orFLOAT
. (#92)- Documentation for
NotFoundError
thrown bytable.get(pk)
- see Retrieving a specific record.
2.4 (2020-02-26)¶
table.disable_fts()
can now be used to remove FTS tables and triggers that were created usingtable.enable_fts(...)
. (#88)- The
sqlite-utils disable-fts
command can be used to remove FTS tables and triggers from the command-line. (#88) - Trying to create table columns with square braces ([ or ]) in the name now raises an error. (#86)
- Subclasses of
dict
,list
andtuple
are now detected as needing a JSON column. (#87)
2.3 (2020-02-08)¶
table.exists()
is now a method, not a property. This was not a documented part of the API before so I’m considering this a non-breaking change. (#83)
2.2 (2020-02-01)¶
New feature: sqlite_utils.suggest_column_types([records])
returns the suggested column types for a list of records. See Suggesting column types. (#81).
This replaces the undocumented table.detect_column_types()
method.
2.1 (2020-01-30)¶
New feature: conversions={...}
can be passed to the .insert()
family of functions to specify SQL conversions that should be applied to values that are being inserted or updated. See Converting column values using SQL functions . (#77).
2.0.1 (2020-01-05)¶
The .upsert()
and .upsert_all()
methods now raise a sqlite_utils.db.PrimaryKeyRequired
exception if you call them without specifying the primary key column using pk=
(#73).
2.0 (2019-12-29)¶
This release changes the behaviour of upsert
. It’s a breaking change, hence 2.0
.
The upsert
command-line utility and the .upsert()
and .upsert_all()
Python API methods have had their behaviour altered. They used to completely replace the affected records: now, they update the specified values on existing records but leave other columns unaffected.
See Upserting data using the Python API and Upserting data using the CLI for full details.
If you want the old behaviour - where records were completely replaced - you can use $ sqlite-utils insert ... --replace
on the command-line and .insert(..., replace=True)
and .insert_all(..., replace=True)
in the Python API. See Insert-replacing data using the Python API and Insert-replacing data using the CLI for more.
For full background on this change, see issue #66.
1.12.1 (2019-11-06)¶
- Fixed error thrown when
.insert_all()
and.upsert_all()
were called with empty lists (#52)
1.12 (2019-11-04)¶
Python library utilities for deleting records (#62)
db["tablename"].delete(4)
to delete by primary key, see Deleting a specific recorddb["tablename"].delete_where("id > ?", [3])
to delete by a where clause, see Deleting multiple records
1.11 (2019-09-02)¶
Option to create triggers to automatically keep FTS tables up-to-date with newly inserted, updated and deleted records. Thanks, Amjith Ramanujam! (#57)
sqlite-utils enable-fts ... --create-triggers
- see Configuring full-text search using the CLIdb["tablename"].enable_fts(..., create_triggers=True)
- see Configuring full-text search using the Python library- Support for introspecting triggers for a database or table - see Introspection (#59)
1.10 (2019-08-23)¶
Ability to introspect and run queries against views (#54)
db.view_names()
method and anddb.views
property- Separate
View
andTable
classes, both subclassing newQueryable
class view.drop()
method
See Listing views.
1.9 (2019-08-04)¶
table.m2m(...)
method for creating many-to-many relationships: Working with many-to-many relationships (#23)
1.8 (2019-07-28)¶
table.update(pk, values)
method: Updating a specific record (#35)
1.7.1 (2019-07-28)¶
- Fixed bug where inserting records with 11 columns in a batch of 100 triggered a “too many SQL variables” error (#50)
- Documentation and tests for
table.drop()
method: Dropping a table or view
1.7 (2019-07-24)¶
Support for lookup tables.
- New
table.lookup({...})
utility method for building and querying lookup tables - see Working with lookup tables (#44) - New
extracts=
table configuration option, see Populating lookup tables automatically during insert/upsert (#46) - Use pysqlite3 if it is available, otherwise use
sqlite3
from the standard library - Table options can now be passed to the new
db.table(name, **options)
factory function in addition to being passed toinsert_all(records, **options)
and friends - see Table configuration options - In-memory databases can now be created using
db = Database(memory=True)
1.5 (2019-07-14)¶
- Support for compound primary keys (#36)
- Configure these using the CLI tool by passing
--pk
multiple times - In Python, pass a tuple of columns to the
pk=(..., ...)
argument: Compound primary keys
- Configure these using the CLI tool by passing
- New
table.get()
method for retrieving a record by its primary key: Retrieving a specific record (#39)
1.4.1 (2019-07-14)¶
- Assorted minor documentation fixes: changes since 1.4
1.4 (2019-06-30)¶
1.3 (2019-06-28)¶
- New mechanism for adding multiple foreign key constraints at once: db.add_foreign_keys() documentation (#31)
1.2.2 (2019-06-25)¶
- Fixed bug where
datetime.time
was not being handled correctly
1.2 (2019-06-12)¶
- Improved foreign key definitions: you no longer need to specify the
column
,other_table
ANDother_column
to define a foreign key - if you omit theother_table
orother_column
the script will attempt to guess the correct values by instrospecting the database. See Adding foreign key constraints for details. (#25) - Ability to set
NOT NULL
constraints andDEFAULT
values when creating tables (#24). Documentation: Setting defaults and not null constraints (Python API), Setting defaults and not null constraints (CLI) - Support for
not_null_default=X
/--not-null-default
for setting aNOT NULL DEFAULT 'x'
when adding a new column. Documentation: Adding columns (Python API), Adding columns (CLI)
1.1 (2019-05-28)¶
- Support for
ignore=True
/--ignore
for ignoring inserted records if the primary key alread exists (#21) - documentation: Inserting data (Python API), Inserting data (CLI) - Ability to add a column that is a foreign key reference using
fk=...
/--fk
(#16) - documentation: Adding columns (Python API), Adding columns (CLI)
1.0.1 (2019-05-27)¶
sqlite-utils rows data.db table --json-cols
- fixed bug where--json-cols
was not obeyed
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 Adding columns automatically with the sqlite-utils CLIdb["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
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 Creating indexestable.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
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 Running queries and outputting a table - 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 totable.last_rowid
table.last_pk
now contains the last inserted primary key, ifpk=
was specified- Prettier indentation in the
CREATE TABLE
generated schemas
0.12 (2019-02-22)¶
- Added
db[table].rows
iterator - see Listing rows - Replaced
sqlite-utils json
andsqlite-utils csv
with a new default subcommand calledsqlite-utils query
which defaults to JSON and takes formatting options--nl
,--csv
and--no-headers
- see Running queries and returning JSON and Running queries and returning CSV - 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
0.11 (2019-02-07)¶
New commands for enabling FTS against a table and columns:
sqlite-utils enable-fts db.db mytable col1 col2
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
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.
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 Running queries and returning CSV and Running queries 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.
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 databasesqlite-utils tables demo.db --fts4
shows just the FTS4 tablessqlite-utils tables demo.db --fts5
shows just the FTS5 tablessqlite-utils vacuum demo.db
runs VACUUM against the databasesqlite-utils optimize demo.db
runs OPTIMIZE against all FTS tables, then VACUUMsqlite-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 fromdogs.json
into thedogs
tablesqlite-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 namesdb["table"].table_names(fts4=True)
returns a list of just the FTS4 tablesdb["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
0.6 (2018-08-12)¶
.enable_fts()
now takes optional argumentfts_version
, defaults toFTS5
. UseFTS4
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 - New documentation for
.insert_all()
and.upsert()
and.upsert_all()
0.5 (2018-08-05)¶
db.tables
anddb.table_names
introspection propertiesdb.indexes
property for introspecting indexestable.create_index(columns, index_name)
methoddb.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()
andsearch()
table methods