Rename "bootstrap" to "migrate" mode

Fixes #18

Author: jcjones

README.md

@@ -89,15 +89,15 @@ partitionmanager:
     table4: {}
 ```
 
-For tables which are either partitioned but not yet using this tool's schema, or which have no empty partitions, the `bootstrap` command can be useful for proposing alterations to run manually. Note that `bootstrap` proposes commands that are likely to require partial copies of each table, so likely they will require a maintenance period.
+For tables which are either partitioned but not yet using this tool's schema, or which have no empty partitions, the `migrate` command can be useful for proposing alterations to run manually. Note that `migrate` proposes commands that are likely to require partial copies of each table, so likely they will require a maintenance period.
 
 ```sh
-partition-manager --mariadb ~/bin/rootsql-dev-primary bootstrap --out /tmp/bootstrap.yml --table orders
+partition-manager --mariadb ~/bin/rootsql-dev-primary migrate --out /tmp/migrate.yml --table orders
 INFO:write_state_info:Writing current state information
 INFO:write_state_info:(Table("orders"): {'id': 9236}),
 
 # wait some time
-partition-manager --mariadb ~/bin/rootsql-dev-primary bootstrap --in /tmp/bootstrap.yml --table orders
+partition-manager --mariadb ~/bin/rootsql-dev-primary migrate --in /tmp/migrate.yml --table orders
 INFO:calculate_sql_alters:Reading prior state information
 INFO:calculate_sql_alters:Table orders, 24.0 hours, [9236] - [29236], [20000] pos_change, [832.706363653845]/hour
 orders:
@@ -110,7 +110,7 @@ orders:
 
 - At start, if any configuration file specified as a CLI argument, read that configuration file to set all other values.
 - Then, process all remaining command line arguments, overriding values loaded from the configuration file in case of conflicts.
-- From those command-line arguments, determine whether to collect statistics `stats`, determine an initial partition layout `bootstrap`, or operate in the normal `maintain` mode.
+- From those command-line arguments, determine whether to collect statistics `stats`, determine an initial partition layout `migrate`, or operate in the normal `maintain` mode.
 - Use the configuration information as inputs to the required algorithm.
 
 ### How does `partman` determine when an additional partition is needed?
@@ -156,9 +156,9 @@ Procedure:
 
 The results of the algorithm are converted into `ALTER` statements; if the user configured `--noop` they're emitted to console and the logs for each table. If not set to `--noop`, the application will execute the ALTERs at the database server and emit the results, including execution time as prometheus statistics if so configured.
 
-#### "Bootstrap" algorithm
+#### "Migrate" algorithm
 
-The bootstrap mode is a limited form of the "Maintain" Algorithm, using a temporary state file to determine rates-of-change. The bootstrap mode also does not limit itself to only affecting empty partitions, it can and will request changes that will prompt row copies, in order to prepare a table for future use of the "Maintain" algorithm.
+The migrate mode is a limited form of the "Maintain" Algorithm, using a temporary state file to determine rates-of-change. The migrate mode also does not limit itself to only affecting empty partitions, it can and will request changes that will prompt row copies, in order to prepare a table for future use of the "Maintain" algorithm.
 
 ## TODOs
 

partitionmanager/cli.py

@@ -9,11 +9,11 @@
 import traceback
 import yaml
 
-import partitionmanager.bootstrap
+import partitionmanager.migrate
+import partitionmanager.sql
+import partitionmanager.stats
 import partitionmanager.table_append_partition as pm_tap
 import partitionmanager.types
-import partitionmanager.stats
-import partitionmanager.sql
 
 PARSER = argparse.ArgumentParser(
     description="""
@@ -235,49 +235,48 @@ def stats_cmd(args):
 STATS_PARSER.set_defaults(func=stats_cmd)
 
 
-def bootstrap_cmd(args):
-    """Runs bootstrap actions on the config that results from the CLI arguments.
+def migrate_cmd(args):
+    """Runs migration actions on the config that results from the CLI arguments.
 
     Helper for argparse.
     """
     conf = config_from_args(args)
 
     if args.outfile:
-        partitionmanager.bootstrap.write_state_info(conf, args.outfile)
+        partitionmanager.migrate.write_state_info(conf, args.outfile)
 
     if args.infile:
-        return partitionmanager.bootstrap.calculate_sql_alters_from_state_info(
+        return partitionmanager.migrate.calculate_sql_alters_from_state_info(
             conf, args.infile
         )
     return {}
 
 
-BOOTSTRAP_PARSER = SUBPARSERS.add_parser(
-    "bootstrap",
-    help="bootstrap partitions that haven't been used with this tool before",
+MIGRATE_PARSER = SUBPARSERS.add_parser(
+    "migrate", help="migrate partitions that haven't been used with this tool before"
 )
-BOOTSTRAP_GROUP = BOOTSTRAP_PARSER.add_mutually_exclusive_group()
-BOOTSTRAP_GROUP.add_argument(
+MIGRATE_GROUP = MIGRATE_PARSER.add_mutually_exclusive_group()
+MIGRATE_GROUP.add_argument(
     "--in", "-i", dest="infile", type=argparse.FileType("r"), help="input YAML"
 )
-BOOTSTRAP_GROUP.add_argument(
+MIGRATE_GROUP.add_argument(
     "--out", "-o", dest="outfile", type=argparse.FileType("w"), help="output YAML"
 )
-BOOTSTRAP_PARSER.add_argument(
+MIGRATE_PARSER.add_argument(
     "--table",
     "-t",
     type=partitionmanager.types.SqlInput,
     nargs="+",
     help="table names, overwriting config",
 )
-BOOTSTRAP_PARSER.add_argument(
+MIGRATE_PARSER.add_argument(
     "--assume-partitioned-on",
     type=partitionmanager.types.SqlInput,
     action="append",
     help="Assume tables are partitioned by this column name, can be specified "
     "multiple times for multi-column partitions",
 )
-BOOTSTRAP_PARSER.set_defaults(func=bootstrap_cmd)
+MIGRATE_PARSER.set_defaults(func=migrate_cmd)
 
 
 def do_partition(conf):

partitionmanager/cli_test.py

@@ -6,14 +6,14 @@
 from pathlib import Path
 from .cli import (
     all_configured_tables_are_compatible,
-    bootstrap_cmd,
+    migrate_cmd,
     config_from_args,
     do_partition,
     PARSER,
     partition_cmd,
     stats_cmd,
 )
-from .bootstrap import calculate_sql_alters_from_state_info
+from .migrate import calculate_sql_alters_from_state_info
 
 
 fake_exec = Path(__file__).absolute().parent.parent / "test_tools/fake_mariadb.sh"
@@ -410,13 +410,13 @@ def test_cli_sqlurl_override_yaml(self):
                 datetime.now(),
             )
 
-    def test_bootstrap_cmd_out(self):
+    def test_migrate_cmd_out(self):
         with tempfile.NamedTemporaryFile() as outfile:
             args = PARSER.parse_args(
                 [
                     "--mariadb",
                     str(fake_exec),
-                    "bootstrap",
+                    "migrate",
                     "--out",
                     outfile.name,
                     "--table",
@@ -425,7 +425,7 @@ def test_bootstrap_cmd_out(self):
                 ]
             )
 
-            output = bootstrap_cmd(args)
+            output = migrate_cmd(args)
             self.assertEqual({}, output)
 
             out_yaml = yaml.safe_load(Path(outfile.name).read_text())
@@ -438,13 +438,13 @@ def test_bootstrap_cmd_out(self):
                 {"tables": {"partitioned_yesterday": {"id": 150}, "two": {"id": 150}}},
             )
 
-    def test_bootstrap_cmd_out_unpartitioned(self):
+    def test_migrate_cmd_out_unpartitioned(self):
         with tempfile.NamedTemporaryFile() as outfile:
             args = PARSER.parse_args(
                 [
                     "--mariadb",
                     str(fake_exec),
-                    "bootstrap",
+                    "migrate",
                     "--out",
                     outfile.name,
                     "--table",
@@ -456,15 +456,15 @@ def test_bootstrap_cmd_out_unpartitioned(self):
             with self.assertRaisesRegex(
                 Exception, "Table unpartitioned is not partitioned"
             ):
-                bootstrap_cmd(args)
+                migrate_cmd(args)
 
-    def test_bootstrap_cmd_out_unpartitioned_with_override(self):
+    def test_migrate_cmd_out_unpartitioned_with_override(self):
         with tempfile.NamedTemporaryFile() as outfile:
             args = PARSER.parse_args(
                 [
                     "--mariadb",
                     str(fake_exec),
-                    "bootstrap",
+                    "migrate",
                     "--assume-partitioned-on",
                     "id",
                     "--out",
@@ -473,7 +473,7 @@ def test_bootstrap_cmd_out_unpartitioned_with_override(self):
                     "unpartitioned",
                 ]
             )
-            output = bootstrap_cmd(args)
+            output = migrate_cmd(args)
             self.assertEqual({}, output)
 
             out_yaml = yaml.safe_load(Path(outfile.name).read_text())
@@ -483,7 +483,7 @@ def test_bootstrap_cmd_out_unpartitioned_with_override(self):
 
             self.assertEqual(out_yaml, {"tables": {"unpartitioned": {"id": 150}}})
 
-    def test_bootstrap_cmd_in(self):
+    def test_migrate_cmd_in(self):
         with tempfile.NamedTemporaryFile(mode="w+") as infile:
             yaml.dump(
                 {
@@ -497,7 +497,7 @@ def test_bootstrap_cmd_in(self):
                 [
                     "--mariadb",
                     str(fake_exec),
-                    "bootstrap",
+                    "migrate",
                     "--in",
                     infile.name,
                     "--table",
@@ -571,7 +571,7 @@ def test_bootstrap_cmd_in(self):
                 },
             )
 
-    def test_bootstrap_cmd_in_unpartitioned_with_override(self):
+    def test_migrate_cmd_in_unpartitioned_with_override(self):
         with tempfile.NamedTemporaryFile(mode="w+") as infile:
             yaml.dump(
                 {
@@ -585,7 +585,7 @@ def test_bootstrap_cmd_in_unpartitioned_with_override(self):
                 [
                     "--mariadb",
                     str(fake_exec),
-                    "bootstrap",
+                    "migrate",
                     "--assume-partitioned-on",
                     "id",
                     "--in",
@@ -633,7 +633,7 @@ def test_bootstrap_cmd_in_unpartitioned_with_override(self):
                 },
             )
 
-    def test_bootstrap_cmd_in_out(self):
+    def test_migrate_cmd_in_out(self):
         with tempfile.NamedTemporaryFile() as outfile, tempfile.NamedTemporaryFile(
             mode="w+"
         ) as infile:
@@ -642,7 +642,7 @@ def test_bootstrap_cmd_in_out(self):
                     [
                         "--mariadb",
                         str(fake_exec),
-                        "bootstrap",
+                        "migrate",
                         "--out",
                         outfile.name,
                         "--in",

partitionmanager/bootstrap.py renamed to partitionmanager/migrate.py

@@ -3,7 +3,7 @@
 import yaml
 from datetime import datetime, timedelta
 
-from .bootstrap import (
+from .migrate import (
     _generate_sql_copy_commands,
     _get_time_offsets,
     _suffix,