Skip to content

Commit 2170415

Browse files
committed
📝 update docs
1 parent a51185d commit 2170415

File tree

2 files changed

+24
-19
lines changed

2 files changed

+24
-19
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ sqlite3mysql --help
3232
```
3333
Usage: sqlite3mysql [OPTIONS]
3434
35-
Transfer SQLite to MySQL using the provided CLI options.
35+
sqlite3mysql version 2.1.10 Copyright (c) 2018-2024 Klemen Tusar
3636
3737
Options:
3838
-f, --sqlite-file PATH SQLite3 database file [required]
@@ -52,7 +52,7 @@ Options:
5252
-h, --mysql-host TEXT MySQL host. Defaults to localhost.
5353
-P, --mysql-port INTEGER MySQL port. Defaults to 3306.
5454
-S, --skip-ssl Disable MySQL connection encryption.
55-
-i, --mysql-insert-method [UPDATE|IGNORE|DEFAULT]
55+
-i, --mysql-insert-method [DEFAULT|IGNORE|UPDATE]
5656
MySQL insert method. DEFAULT will throw
5757
errors when encountering duplicate records;
5858
UPDATE will update existing rows; IGNORE
@@ -64,7 +64,7 @@ Options:
6464
to INT(11).
6565
--mysql-string-type TEXT MySQL default string field type. Defaults to
6666
VARCHAR(255).
67-
--mysql-text-type [MEDIUMTEXT|TEXT|TINYTEXT|LONGTEXT]
67+
--mysql-text-type [LONGTEXT|MEDIUMTEXT|TEXT|TINYTEXT]
6868
MySQL default text field type. Defaults to
6969
TEXT.
7070
--mysql-charset TEXT MySQL database and table character set
@@ -75,6 +75,8 @@ Options:
7575
not support InnoDB FULLTEXT indexes!
7676
--with-rowid Transfer rowid columns.
7777
-c, --chunk INTEGER Chunk reading/writing SQL records
78+
-K, --mysql-skip-create-tables Skip creating tables in MySQL.
79+
-J, --mysql-skip-transfer-data Skip transferring data to MySQL.
7880
-l, --log-file PATH Log file
7981
-q, --quiet Quiet. Display only errors.
8082
--debug Debug mode. Will throw exceptions.

docs/README.rst

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,37 +23,40 @@ Password Options
2323
- ``-p, --prompt-mysql-password``: Prompt for MySQL password
2424
- ``--mysql-password TEXT``: MySQL password
2525

26-
Table Options
27-
""""""""""""""
26+
Connection Options
27+
""""""""""""""""""
2828

29-
- ``-t, --sqlite-tables TUPLE``: Transfer only these specific tables (space separated table names). Implies ``--without-foreign-keys`` which inhibits the transfer of foreign keys.
30-
- ``-X, --without-foreign-keys``: Do not transfer foreign keys.
31-
- ``-W, --ignore-duplicate-keys``: Ignore duplicate keys. The default behavior is to create new ones with a numerical suffix, e.g. 'existing_key' -> 'existing_key_1'
32-
- ``-E, --mysql-truncate-tables``: Truncates existing tables before inserting data.
29+
- ``-h, --mysql-host TEXT``: MySQL host. Defaults to localhost.
30+
- ``-P, --mysql-port INTEGER``: MySQL port. Defaults to 3306.
31+
- ``-S, --skip-ssl``: Disable MySQL connection encryption.
3332

3433
Transfer Options
3534
""""""""""""""""
3635

36+
- ``-t, --sqlite-tables TUPLE``: Transfer only these specific tables (space separated table names). Implies ``--without-foreign-keys`` which inhibits the transfer of foreign keys.
37+
- ``-E, --mysql-truncate-tables``: Truncates existing tables before inserting data.
38+
- ``-K, --mysql-skip-create-tables``: Skip creating tables in MySQL.
3739
- ``-i, --mysql-insert-method [UPDATE|IGNORE|DEFAULT]``: MySQL insert method. DEFAULT will throw errors when encountering duplicate records; UPDATE will update existing rows; IGNORE will ignore insert errors. Defaults to IGNORE.
40+
- ``-J, --mysql-skip-transfer-data``: Skip transferring data to MySQL.
41+
- ``--mysql-integer-type TEXT``: MySQL default integer field type. Defaults to INT(11).
42+
- ``--mysql-string-type TEXT``: MySQL default string field type. Defaults to VARCHAR(255).
43+
- ``--mysql-text-type [LONGTEXT|MEDIUMTEXT|TEXT|TINYTEXT]``: MySQL default text field type. Defaults to TEXT.
44+
- ``--mysql-charset TEXT``: MySQL database and table character set. Defaults to utf8mb4.
45+
` ``--mysql-collation TEXT``: MySQL database and table collation
46+
- ``-T, --use-fulltext``: Use FULLTEXT indexes on TEXT columns. Will throw an error if your MySQL version does not support InnoDB FULLTEXT indexes!
47+
- ``-X, --without-foreign-keys``: Do not transfer foreign keys.
48+
- ``-W, --ignore-duplicate-keys``: Ignore duplicate keys. The default behavior is to create new ones with a numerical suffix, e.g. 'existing_key' -> 'existing_key_1'
3849
- ``--with-rowid``: Transfer rowid columns.
3950
- ``-c, --chunk INTEGER``: Chunk reading/writing SQL records
4051

41-
Connection Options
42-
""""""""""""""""""
43-
44-
- ``-h, --mysql-host TEXT``: MySQL host. Defaults to localhost.
45-
- ``-P, --mysql-port INTEGER``: MySQL port. Defaults to 3306.
46-
- ``-S, --skip-ssl``: Disable MySQL connection encryption.
47-
4852
Other Options
49-
""""""""""""""
53+
"""""""""""""
5054

51-
- ``-T, --use-fulltext``: Use FULLTEXT indexes on TEXT columns. Will throw an error if your MySQL version does not support InnoDB FULLTEXT indexes!
5255
- ``-l, --log-file PATH``: Log file
5356
- ``-q, --quiet``: Quiet. Display only errors.
5457
- ``--debug``: Debug mode. Will throw exceptions.
5558
- ``--version``: Show the version and exit.
56-
- ``--help``: Show this message and exit.
59+
- ``--help``: Show help message and exit.
5760

5861
Docker
5962
^^^^^^

0 commit comments

Comments
 (0)