Skip to content

Commit 1535deb

Browse files
Automatically enable free servers #837 (#914)
The ability to automatically enable free servers results in the following docs change: 1. Addition of a config setting `initial.dbms.automatically_enable_free_servers` 2. Adjustment of `dbms.showTopologyGraphConfig()` procedure's output 3. Introduction of `dbms.cluster.setAutomaticallyEnableFreeServers()` procedure Cherry-picked from #837 Co-authored-by: Jack Waudby <[email protected]>
1 parent e5bc25d commit 1535deb

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

modules/ROOT/pages/configuration/configuration-settings.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -571,6 +571,22 @@ a|a duration (Valid units are: `ns`, `μs`, `ms`, `s`, `m`, `h` and `d`; default
571571
m|+++20m+++
572572
|===
573573

574+
[[config_initial.dbms.automatically_enable_free_servers]]
575+
=== `initial.dbms.automatically_enable_free_servers`
576+
577+
label:enterprise-edition[Enterprise Edition]
578+
579+
.initial.dbms.automatically_enable_free_servers
580+
[frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
581+
|===
582+
|Description
583+
a|Automatically enable free servers.
584+
|Valid values
585+
a|a boolean
586+
|Default value
587+
m|+++false+++
588+
|===
589+
574590
[[config_initial.dbms.database_allocator]]
575591
=== `initial.dbms.database_allocator`
576592

modules/ROOT/pages/reference/procedures.adoc

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,11 @@ In 4.2, signature changed to `db.listLocks() :: (mode :: STRING?, resourceType :
210210
// Internal
211211
// dbms.clientConfig()
212212

213+
| xref:reference/procedures.adoc#procedure_dbms_cluster_setAutomaticallyEnableFreeServers[`dbms.cluster.setAutomaticallyEnableFreeServers()`]
214+
| label:no[]
215+
| label:yes[]
216+
| label:admin-only[]
217+
213218
| xref:reference/procedures.adoc#procedure_dbms_cluster_checkConnectivity[`dbms.cluster.checkConnectivity()`]
214219
| label:no[]
215220
| label:yes[]
@@ -1226,6 +1231,19 @@ m|DBMS
12261231
// m|admin
12271232
|===
12281233

1234+
[[procedure_dbms_cluster_setAutomaticallyEnableFreeServers]]
1235+
.dbms.cluster.setAutomaticallyEnableFreeServers() label:enterprise-edition[] label:admin-only[]
1236+
[cols="<15s,<85"]
1237+
|===
1238+
| Description
1239+
a|
1240+
With this method you can set whether free servers are automatically enabled.
1241+
| Signature
1242+
m|dbms.cluster.setAutomaticallyEnableFreeServers(autoEnable :: BOOLEAN?)
1243+
| Mode
1244+
m|WRITE
1245+
|===
1246+
12291247
[[procedure_dbms_cluster_checkConnectivity]]
12301248
.dbms.cluster.checkConnectivity() label:enterprise-edition[] label:admin-only[]
12311249
[cols="<15s,<85"]
@@ -1739,7 +1757,7 @@ m|DBMS
17391757
| Description
17401758
a| With this method the configuration of the Topology Graph can be displayed.
17411759
| Signature
1742-
m|dbms.showTopologyGraphConfig() :: (allocator :: STRING?, defaultPrimariesCount :: INTEGER?, defaultSecondariesCount :: INTEGER?, defaultDatabase :: STRING?)
1760+
m|dbms.showTopologyGraphConfig() :: (allocator :: STRING?, defaultPrimariesCount :: INTEGER?, defaultSecondariesCount :: INTEGER?, defaultDatabase :: STRING?, autoEnableFreeServers :: BOOLEAN?)
17431761
| Mode
17441762
m|READ
17451763
|===

0 commit comments

Comments
 (0)