You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| db | db:\<id\><br />name | Database to upgrade |
45
-
| and module | [upgrade module](#upgrade-module) command | Clause that allows the upgrade of a database and a specified Redis module in a single step with only one restart (can be specified multiple times). Deprecated as of Redis Enterprise Software v7.6. |
45
+
| and module | [upgrade module](#upgrade-module) command | Clause that allows the upgrade of a database and a specified Redis module in a single step with only one restart (can be specified multiple times). Deprecated as of Redis Enterprise Software v7.8.2. |
46
46
| discard_data || Indicates that data will not be saved after the upgrade |
47
47
| force || Forces upgrade and skips warnings and confirmations |
48
48
| force_discard || Forces `discard_data`if replication or persistence is enabled |
49
49
| keep_crdt_protocol_version || Keeps the current CRDT protocol version |
50
-
| keep_redis_version || Upgrades to a new patch release, not to the latest major.minor version. Deprecated as of Redis Enterprise Software v7.6. To upgrade modules without upgrading the Redis database version, set`redis_version` to the current Redis database version instead. |
50
+
| keep_redis_version || Upgrades to a new patch release, not to the latest major.minor version. Deprecated as of Redis Enterprise Software v7.8.2. To upgrade modules without upgrading the Redis database version, set`redis_version` to the current Redis database version instead. |
51
51
| latest_with_modules || Upgrades the Redis Enterprise Software version and all modules in the database. As of Redis Enterprise Software version 7.8.2, `upgrade db` will always upgrade modules. |
52
52
| parallel_shards_upgrade | integer <br />'all'| Maximum number of shards to upgrade all at once |
53
53
| preserve_roles || Performs an additional failover to guarantee the shards' roles are preserved |
@@ -74,7 +74,7 @@ Done
74
74
75
75
## `upgrade module`
76
76
77
-
Upgrades Redis modules in use by a specific database. Deprecated as of Redis Enterprise Software v7.6. Use [`upgrade db`](#upgrade-db) instead.
77
+
Upgrades Redis modules in use by a specific database. Deprecated as of Redis Enterprise Software v7.8.2. Use [`upgrade db`](#upgrade-db) instead.
78
78
79
79
For more information, see [Upgrade modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}).
Copy file name to clipboardExpand all lines: content/operate/rs/references/rest-api/objects/bdb/_index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ An API object that represents a managed database in the cluster.
29
29
| authorized_subjects | {{<code>}}[{<br /> "CN": string,<br /> "O": string,<br /> "OU": [array of strings],<br /> "L": string,<br /> "ST": string,<br /> "C": string<br />}, ...]{{</code>}} A list of valid subjects used for additional certificate validations during TLS client authentication. All subject attributes are case-sensitive.<br />**Required subject fields**:<br />"CN" for Common Name<br />**Optional subject fields:**<br />"O" for Organization<br />"OU" for Organizational Unit (array of strings)<br />"L" for Locality (city)<br />"ST" for State/Province<br />"C" for 2-letter country code |
30
30
| auto_upgrade | boolean (default: false); Upgrade the database automatically after a cluster upgrade |
31
31
| avoid_nodes | array of strings; Cluster node UIDs to avoid when placing the database's shards and binding its endpoints |
32
-
| background_op | Deprecated as of Redis Enterprise Software v7.6. Use [`GET /v1/actions/bdb/<bdb_uid>`]({{<relref "/operate/rs/references/rest-api/requests/actions/bdb">}}) instead.<br />{{<code>}}[{<br /> "status": string,<br /> "name": string,<br /> "error": object,<br /> "progress": number<br />}, ...]{{</code>}} (read-only); **progress**: Percent of completed steps in current operation |
32
+
| background_op | Deprecated as of Redis Enterprise Software v7.8.2. Use [`GET /v1/actions/bdb/<bdb_uid>`]({{<relref "/operate/rs/references/rest-api/requests/actions/bdb">}}) instead.<br />{{<code>}}[{<br /> "status": string,<br /> "name": string,<br /> "error": object,<br /> "progress": number<br />}, ...]{{</code>}} (read-only); **progress**: Percent of completed steps in current operation |
| backup_failure_reason | Reason of last failed backup process (read-only)<br />Values:<br />'no-permission'<br />'wrong-file-path'<br />'general-error' |
35
35
| backup_history | integer (default: 0); Backup history retention policy (number of days, 0 is forever) |
@@ -102,7 +102,7 @@ An API object that represents a managed database in the cluster.
102
102
| memory_size | integer (default: 0); Database memory limit (0 is unlimited), expressed in bytes. |
103
103
| metrics_export_all | boolean; Enable/disable exposing all shard metrics through the metrics exporter |
104
104
| mkms | boolean (default: true); Are MKMS (Multi Key Multi Slots) commands supported? |
105
-
| module_list | {{<code>}}[{<br /> "module_id": string,<br /> "module_args": [<br /> u'string',<br /> u'null'],<br /> "module_name": string,<br /> "semantic_version": string<br />}, ...]{{</code>}} List of modules associated with the database<br /><br />**module_id**: Module UID (deprecated; use `module_name` instead)<br />**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")<br />**module_name**: Module's name<br />**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)<br /><br />**module_id** and **semantic_version** are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.6. |
105
+
| module_list | {{<code>}}[{<br /> "module_id": string,<br /> "module_args": [<br /> u'string',<br /> u'null'],<br /> "module_name": string,<br /> "semantic_version": string<br />}, ...]{{</code>}} List of modules associated with the database<br /><br />**module_id**: Module UID (deprecated; use `module_name` instead)<br />**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")<br />**module_name**: Module's name<br />**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)<br /><br />**module_id** and **semantic_version** are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2. |
106
106
| mtls_allow_outdated_certs | boolean; An optional mTLS relaxation flag for certs verification |
107
107
| mtls_allow_weak_hashing | boolean; An optional mTLS relaxation flag for certs verification |
108
108
| name | string; Database name. Only letters, numbers, or hyphens are valid characters. The name must start and end with a letter or number. |
Copy file name to clipboardExpand all lines: content/operate/rs/references/rest-api/requests/bdbs/upgrade.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,15 +54,15 @@ Upgrade a database.
54
54
| Field | Type | Description |
55
55
|-------|------|-------------|
56
56
| force_restart | boolean | Restart shards even if no version change (default: false) |
57
-
| keep_redis_version | boolean | Keep current Redis version (default: false). Deprecated as of Redis Enterprise Software v7.6. To upgrade modules without upgrading the Redis database version, set `redis_version` to the current Redis database version instead. |
57
+
| keep_redis_version | boolean | Keep current Redis version (default: false). Deprecated as of Redis Enterprise Software v7.8.2. To upgrade modules without upgrading the Redis database version, set `redis_version` to the current Redis database version instead. |
58
58
| keep_crdt_protocol_version | boolean | Keep current crdt protocol version (default: false) |
59
59
| may_discard_data | boolean | Discard data in a non-replicated, non-persistent bdb (default: false) |
60
60
| force_discard | boolean | Discard data even if the bdb is replicated and/or persistent (default: false) |
61
61
| preserve_roles | boolean | Preserve shards' master/replica roles (requires an extra failover) (default: false) |
62
62
| parallel_shards_upgrade | integer | Max number of shards to upgrade in parallel (default: all) |
63
-
| modules | list of modules | List of dicts representing the modules that will be upgraded. As of Redis Enterprise Software v7.6, `current_module` and `new_module` are deprecated.<br></br>Each dict includes:<br></br>• `current_module`: uid of a module to upgrade (deprecated)<br></br>• `new_module`: uid of the module we want to upgrade to (deprecated)<br></br>• `new_module_args`: args list for the new module (no defaults for the three module-related parameters).
63
+
| modules | list of modules | List of dicts representing the modules that will be upgraded. As of Redis Enterprise Software v7.8.2, `current_module` and `new_module` are deprecated.<br></br>Each dict includes:<br></br>• `current_module`: uid of a module to upgrade (deprecated)<br></br>• `new_module`: uid of the module we want to upgrade to (deprecated)<br></br>• `new_module_args`: args list for the new module (no defaults for the three module-related parameters).
64
64
| redis_version | version number | Upgrades the database to the specified Redis version instead of the latest version. To upgrade modules without upgrading the Redis database version, set `redis_version` to the current Redis database version instead. |
65
-
| latest_with_modules | boolean | Upgrades the database to the latest Redis version and latest supported versions of modules available in the cluster. (default: true as of v7.6) Deprecated as of Redis Enterprise Software v7.6. |
65
+
| latest_with_modules | boolean | Upgrades the database to the latest Redis version and latest supported versions of modules available in the cluster. (default: true as of v7.8.2) Deprecated as of Redis Enterprise Software v7.8.2. |
Copy file name to clipboardExpand all lines: content/operate/rs/references/rest-api/requests/modules/upgrade.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ weight: $weight
19
19
20
20
POST /v1/modules/upgrade/bdb/{string: uid}
21
21
22
-
Upgrades the module version on a specific database. Deprecated as of Redis Enterprise Software v7.6. Use [`POST /v1/bdbs/<uid>/upgrade`]({{<relref "/operate/rs/references/rest-api/requests/bdbs/upgrade#post-bdbs-upgrade">}}) instead.
22
+
Upgrades the module version on a specific database. Deprecated as of Redis Enterprise Software v7.8.2. Use [`POST /v1/bdbs/<uid>/upgrade`]({{<relref "/operate/rs/references/rest-api/requests/bdbs/upgrade#post-bdbs-upgrade">}}) instead.
0 commit comments