@@ -131,7 +131,7 @@ See :ref:`cli_query`.
131131 -r, --raw Raw output, first column of first row
132132 --raw-lines Raw output, first column of each row
133133 -p, --param <TEXT TEXT>... Named :parameters for SQL query
134- --functions TEXT Python code or file path defining custom SQL
134+ --functions TEXT Python code defining one or more custom SQL
135135 functions
136136 --load-extension TEXT Path to SQLite extension, with optional
137137 :entrypoint
@@ -174,7 +174,7 @@ See :ref:`cli_memory`.
174174 sqlite-utils memory animals.csv --schema
175175
176176 Options:
177- --functions TEXT Python code or file path defining custom SQL
177+ --functions TEXT Python code defining one or more custom SQL
178178 functions
179179 --attach <TEXT FILE>... Additional databases to attach - specify alias and
180180 filepath
@@ -270,7 +270,6 @@ See :ref:`cli_inserting_data`, :ref:`cli_insert_csv_tsv`, :ref:`cli_insert_unstr
270270 --nl Expect newline-delimited JSON
271271 -c, --csv Expect CSV input
272272 --tsv Expect TSV input
273- --empty-null Treat empty strings as NULL
274273 --lines Treat each line as a single value called 'line'
275274 --text Treat input as a single value called 'text'
276275 --convert TEXT Python code to convert each item
@@ -281,16 +280,13 @@ See :ref:`cli_inserting_data`, :ref:`cli_insert_csv_tsv`, :ref:`cli_insert_unstr
281280 --no-headers CSV file has no header row
282281 --encoding TEXT Character encoding for input, defaults to utf-8
283282 --batch-size INTEGER Commit every X records
284- --stop-after INTEGER Stop after X records
285283 --alter Alter existing table to add any missing columns
286284 --not-null TEXT Columns that should be created as NOT NULL
287285 --default <TEXT TEXT>... Default value that should be set for a column
288- -d, --detect-types Detect types for columns in CSV/TSV data (default)
289- --no-detect-types Treat all CSV/TSV columns as TEXT
286+ -d, --detect-types Detect types for columns in CSV/TSV data
290287 --analyze Run ANALYZE at the end of this operation
291288 --load-extension TEXT Path to SQLite extension, with optional :entrypoint
292289 --silent Do not show progress bar
293- --strict Apply STRICT mode to created table
294290 --ignore Ignore records if pk already exists
295291 --replace Replace records if pk already exists
296292 --truncate Truncate table before inserting records, if table
@@ -328,7 +324,6 @@ See :ref:`cli_upsert`.
328324 --nl Expect newline-delimited JSON
329325 -c, --csv Expect CSV input
330326 --tsv Expect TSV input
331- --empty-null Treat empty strings as NULL
332327 --lines Treat each line as a single value called 'line'
333328 --text Treat input as a single value called 'text'
334329 --convert TEXT Python code to convert each item
@@ -339,16 +334,13 @@ See :ref:`cli_upsert`.
339334 --no-headers CSV file has no header row
340335 --encoding TEXT Character encoding for input, defaults to utf-8
341336 --batch-size INTEGER Commit every X records
342- --stop-after INTEGER Stop after X records
343337 --alter Alter existing table to add any missing columns
344338 --not-null TEXT Columns that should be created as NOT NULL
345339 --default <TEXT TEXT>... Default value that should be set for a column
346- -d, --detect-types Detect types for columns in CSV/TSV data (default)
347- --no-detect-types Treat all CSV/TSV columns as TEXT
340+ -d, --detect-types Detect types for columns in CSV/TSV data
348341 --analyze Run ANALYZE at the end of this operation
349342 --load-extension TEXT Path to SQLite extension, with optional :entrypoint
350343 --silent Do not show progress bar
351- --strict Apply STRICT mode to created table
352344 -h, --help Show this message and exit.
353345
354346
@@ -376,13 +368,12 @@ See :ref:`cli_bulk`.
376368
377369 Options:
378370 --batch-size INTEGER Commit every X records
379- --functions TEXT Python code or file path defining custom SQL functions
371+ --functions TEXT Python code defining one or more custom SQL functions
380372 --flatten Flatten nested JSON objects, so {"a": {"b": 1}} becomes
381373 {"a_b": 1}
382374 --nl Expect newline-delimited JSON
383375 -c, --csv Expect CSV input
384376 --tsv Expect TSV input
385- --empty-null Treat empty strings as NULL
386377 --lines Treat each line as a single value called 'line'
387378 --text Treat input as a single value called 'text'
388379 --convert TEXT Python code to convert each item
@@ -459,25 +450,20 @@ See :ref:`cli_transform_table`.
459450 --rename column2 column_renamed
460451
461452 Options:
462- --type <TEXT CHOICE>... Change column type to INTEGER, TEXT, FLOAT,
463- REAL or BLOB
464- --drop TEXT Drop this column
465- --rename <TEXT TEXT>... Rename this column to X
466- -o, --column-order TEXT Reorder columns
467- --not-null TEXT Set this column to NOT NULL
468- --not-null-false TEXT Remove NOT NULL from this column
469- --pk TEXT Make this column the primary key
470- --pk-none Remove primary key (convert to rowid table)
471- --default <TEXT TEXT>... Set default value for this column
472- --default-none TEXT Remove default from this column
473- --add-foreign-key <TEXT TEXT TEXT>...
474- Add a foreign key constraint from a column to
475- another table with another column
476- --drop-foreign-key TEXT Drop foreign key constraint for this column
477- --sql Output SQL without executing it
478- --load-extension TEXT Path to SQLite extension, with optional
479- :entrypoint
480- -h, --help Show this message and exit.
453+ --type <TEXT CHOICE>... Change column type to INTEGER, TEXT, FLOAT or BLOB
454+ --drop TEXT Drop this column
455+ --rename <TEXT TEXT>... Rename this column to X
456+ -o, --column-order TEXT Reorder columns
457+ --not-null TEXT Set this column to NOT NULL
458+ --not-null-false TEXT Remove NOT NULL from this column
459+ --pk TEXT Make this column the primary key
460+ --pk-none Remove primary key (convert to rowid table)
461+ --default <TEXT TEXT>... Set default value for this column
462+ --default-none TEXT Remove default from this column
463+ --drop-foreign-key TEXT Drop foreign key constraint for this column
464+ --sql Output SQL without executing it
465+ --load-extension TEXT Path to SQLite extension, with optional :entrypoint
466+ -h, --help Show this message and exit.
481467
482468
483469.. _cli_ref_extract :
@@ -605,9 +591,9 @@ See :ref:`cli_convert`.
605591
606592 Convert columns using Python code you supply. For example:
607593
608- sqlite-utils convert my.db mytable mycolumn \
609- '"\n".join(textwrap.wrap(value, 10))' \
610- --import=textwrap
594+ sqlite-utils convert my.db mytable mycolumn \
595+ '"\n".join(textwrap.wrap(value, 10))' \
596+ --import=textwrap
611597
612598 "value" is a variable with the column value to be converted.
613599
@@ -617,30 +603,30 @@ See :ref:`cli_convert`.
617603
618604 r.jsonsplit(value, delimiter=',', type=<class 'str'>)
619605
620- Convert a string like a,b,c into a JSON array ["a", "b", "c"]
606+ Convert a string like a,b,c into a JSON array ["a", "b", "c"]
621607
622608 r.parsedate(value, dayfirst=False, yearfirst=False, errors=None)
623609
624- Parse a date and convert it to ISO date format: yyyy-mm-dd
625-
626- - dayfirst=True: treat xx as the day in xx/yy/zz
627- - yearfirst=True: treat xx as the year in xx/yy/zz
628- - errors=r.IGNORE to ignore values that cannot be parsed
629- - errors=r.SET_NULL to set values that cannot be parsed to null
610+ Parse a date and convert it to ISO date format: yyyy-mm-dd
611+
612+ - dayfirst=True: treat xx as the day in xx/yy/zz
613+ - yearfirst=True: treat xx as the year in xx/yy/zz
614+ - errors=r.IGNORE to ignore values that cannot be parsed
615+ - errors=r.SET_NULL to set values that cannot be parsed to null
630616
631617 r.parsedatetime(value, dayfirst=False, yearfirst=False, errors=None)
632618
633- Parse a datetime and convert it to ISO datetime format: yyyy-mm-ddTHH:MM:SS
634-
635- - dayfirst=True: treat xx as the day in xx/yy/zz
636- - yearfirst=True: treat xx as the year in xx/yy/zz
637- - errors=r.IGNORE to ignore values that cannot be parsed
638- - errors=r.SET_NULL to set values that cannot be parsed to null
619+ Parse a datetime and convert it to ISO datetime format: yyyy-mm-ddTHH:MM:SS
620+
621+ - dayfirst=True: treat xx as the day in xx/yy/zz
622+ - yearfirst=True: treat xx as the year in xx/yy/zz
623+ - errors=r.IGNORE to ignore values that cannot be parsed
624+ - errors=r.SET_NULL to set values that cannot be parsed to null
639625
640626 You can use these recipes like so:
641627
642- sqlite-utils convert my.db mytable mycolumn \
643- 'r.jsonsplit(value, delimiter=":")'
628+ sqlite-utils convert my.db mytable mycolumn \
629+ 'r.jsonsplit(value, delimiter=":")'
644630
645631 Options:
646632 --import TEXT Python modules to import
@@ -655,8 +641,8 @@ See :ref:`cli_convert`.
655641 --output-type [integer|float|blob|text]
656642 Column type to use for the output column
657643 --drop Drop original column afterwards
644+ --no-skip-false Don't skip falsey values
658645 -s, --silent Don't show a progress bar
659- --pdb Open pdb debugger on first error
660646 -h, --help Show this message and exit.
661647
662648
@@ -923,7 +909,6 @@ See :ref:`cli_create_table`.
923909 --replace If table already exists, replace it
924910 --transform If table already exists, try to transform the schema
925911 --load-extension TEXT Path to SQLite extension, with optional :entrypoint
926- --strict Apply STRICT mode to created table
927912 -h, --help Show this message and exit.
928913
929914
@@ -1045,6 +1030,21 @@ disable-fts
10451030 -h, --help Show this message and exit.
10461031
10471032
1033+ .. _cli_ref_tui :
1034+
1035+ tui
1036+ ===
1037+
1038+ ::
1039+
1040+ Usage: sqlite-utils tui [OPTIONS]
1041+
1042+ Open Textual TUI.
1043+
1044+ Options:
1045+ -h, --help Show this message and exit.
1046+
1047+
10481048.. _cli_ref_optimize :
10491049
10501050optimize
@@ -1144,7 +1144,7 @@ See :ref:`cli_add_column`.
11441144::
11451145
11461146 Usage: sqlite-utils add-column [OPTIONS] PATH TABLE COL_NAME
1147- [[integer|int| float|real |text|str|blob|bytes ]]
1147+ [[integer|float|blob |text|INTEGER|FLOAT|BLOB|TEXT ]]
11481148
11491149 Add a column to the specified table
11501150
@@ -1180,6 +1180,8 @@ See :ref:`cli_add_foreign_key`.
11801180
11811181 sqlite-utils add-foreign-key my.db books author_id authors id
11821182
1183+ WARNING: Could corrupt your database! Back up your database file first.
1184+
11831185 Options:
11841186 --ignore If foreign key already exists, do nothing
11851187 --load-extension TEXT Path to SQLite extension, with optional :entrypoint
@@ -1335,25 +1337,6 @@ See :ref:`cli_duplicate_table`.
13351337 -h, --help Show this message and exit.
13361338
13371339
1338- .. _cli_ref_rename_table :
1339-
1340- rename-table
1341- ============
1342-
1343- See :ref: `cli_renaming_tables `.
1344-
1345- ::
1346-
1347- Usage: sqlite-utils rename-table [OPTIONS] PATH TABLE NEW_NAME
1348-
1349- Rename this table.
1350-
1351- Options:
1352- --ignore If table does not exist, do nothing
1353- --load-extension TEXT Path to SQLite extension, with optional :entrypoint
1354- -h, --help Show this message and exit.
1355-
1356-
13571340.. _cli_ref_drop_table :
13581341
13591342drop-table
@@ -1434,14 +1417,13 @@ See :ref:`cli_install`.
14341417
14351418::
14361419
1437- Usage: sqlite-utils install [OPTIONS] [ PACKAGES] ...
1420+ Usage: sqlite-utils install [OPTIONS] PACKAGES...
14381421
14391422 Install packages from PyPI into the same environment as sqlite-utils
14401423
14411424 Options:
1442- -U, --upgrade Upgrade packages to latest version
1443- -e, --editable TEXT Install a project in editable mode from this path
1444- -h, --help Show this message and exit.
1425+ -U, --upgrade Upgrade packages to latest version
1426+ -h, --help Show this message and exit.
14451427
14461428
14471429.. _cli_ref_uninstall :
@@ -1516,19 +1498,4 @@ See :ref:`cli_spatialite_indexes`.
15161498 -h, --help Show this message and exit.
15171499
15181500
1519- .. _cli_ref_plugins :
1520-
1521- plugins
1522- =======
1523-
1524- ::
1525-
1526- Usage: sqlite-utils plugins [OPTIONS]
1527-
1528- List installed plugins
1529-
1530- Options:
1531- -h, --help Show this message and exit.
1532-
1533-
15341501.. [[[end]]]
0 commit comments