sqlite-utils rename-table command, refs #565

docs/cli-reference.rst

@@ -40,6 +40,8 @@ This page lists the ``--help`` for every ``sqlite-utils`` CLI sub-command.
         "vacuum": "cli_vacuum",
         "dump": "cli_dump",
         "add-column": "cli_add_column",
+        "rename-table": "cli_renaming_tables",
+        "duplicate": "cli_duplicate_table",
         "add-foreign-key": "cli_add_foreign_key",
         "add-foreign-keys": "cli_add_foreign_keys",
         "index-foreign-keys": "cli_index_foreign_keys",
@@ -1328,6 +1330,8 @@ reset-counts
 duplicate
 =========
 
+See :ref:`cli_duplicate_table`.
+
 ::
 
     Usage: sqlite-utils duplicate [OPTIONS] PATH TABLE NEW_TABLE
@@ -1340,6 +1344,25 @@ duplicate
       -h, --help             Show this message and exit.
 
 
+.. _cli_ref_rename_table:
+
+rename-table
+============
+
+See :ref:`cli_renaming_tables`.
+
+::
+
+    Usage: sqlite-utils rename-table [OPTIONS] PATH TABLE NEW_NAME
+
+      Rename this table.
+
+    Options:
+      --ignore               If table does not exist, do nothing
+      --load-extension TEXT  Path to SQLite extension, with optional :entrypoint
+      -h, --help             Show this message and exit.
+
+
 .. _cli_ref_drop_table:
 
 drop-table

docs/cli.rst

@@ -1936,6 +1936,19 @@ If a table with the same name already exists, you will get an error. You can cho
 
 You can also pass ``--transform`` to transform the existing table to match the new schema. See :ref:`python_api_explicit_create` in the Python library documentation for details of how this option works.
 
+.. _cli_renaming_tables:
+
+Renaming a table
+================
+
+Yo ucan rename a table using the ``rename-table`` command:
+
+.. code-block:: bash
+
+    sqlite-utils rename-table mydb.db oldname newname
+
+Pass ``--ignore`` to ignore any errors caused by the table not existing, or the new name already being in use.
+
 .. _cli_duplicate_table:
 
 Duplicating tables