Upgrader
Class to handle the upgrade of a module. This class is used to install a new instance or to upgrade an existing instance of a module. It stores the info about the upgrade in a table on the database.
Source code in pum/upgrader.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
|
__init__
Initialize the Upgrader class. This class is used to install a new instance or to upgrade an existing instance of a module. Stores the info about the upgrade in a table on the database. The table is created in the schema defined in the config file if it does not exist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection
|
The database connection to use for the upgrade. |
required | |
config
|
PumConfig
|
The configuration object |
required |
max_version
|
Version | str | None
|
Maximum (including) version to run the deltas up to. |
None
|
Source code in pum/upgrader.py
install
install(connection: Connection | None = None, *, parameters: dict | None = None, max_version: str | Version | None = None, roles: bool = False, grant: bool = False, commit: bool = False) -> None
Installs the given module This will create the schema_migrations table if it does not exist. The changelogs are applied in the order they are found in the directory. It will also set the baseline version to the current version of the module.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
connection
|
Connection | None
|
The database connection to use for the upgrade. |
None
|
parameters
|
dict | None
|
The parameters to pass for the migration. |
None
|
max_version
|
str | Version | None
|
The maximum version to apply. If None, all versions are applied. |
None
|
roles
|
bool
|
If True, roles will be created. |
False
|
grant
|
bool
|
If True, permissions will be granted to the roles. |
False
|
commit
|
bool
|
If True, the changes will be committed to the database. |
False
|