cma.applyConfig

cma.applyConfig(
   config as (binary()|node())[],
   [config-options as Object?],
   [params as Object?],
   [format as String?]
) as (emptySeq|node())

Summary

Apply a named configuration, overriding parameters and setting options.

Usage Notes

This function applies a named configuration, overriding parameters and setting options.

The default namespace for configuration packages is http://marklogic.com/manage/config.

<configuration xmlns="http://marklogic.com/manage/config">
      

The available core scenarios are summarized below. The details on each scenario follow.

• HA Local Failover

HA Local Failover

The parameters for HA Local Failover scenario are:

replicaSameZoneAsMaster

Create forests on hosts in the same zone. The allowed values are true or false. The default value is true.

masterDatabase

Create if does not exist, add replicas (if none exist). The value is string, for example "myHADatabase".

triggersDatabase

Create if does not exist, add replicas (if none exist). The value is string, for example "myHATriggers".

schemasDatabase

Create if does not exist, add replicas (if none exist). The value is string, for example "myHASchemas".

securityDatabase

When defined, will attempt to add replicas to xdmp:security-database() (if none exist). The value is string, for example "Security".

addReplicaToExistingForests

When set to false - no attempt is made to add replicas; when set to true - replicas will be added to the forest, with total summing up to number-of-replicas-per-forest. The allowed values are true or false. The default value is false.

numberOfMasterForests

Calculated number of master forests. The value is positive integer.

numberOfReplicasPerForest

Calculated number of replicas per forest. The value is positive integer.

numberOfForestsPerHost

Calculated based on number of available hosts, equally balance forests across hosts. The value is positive integer.

masterDataDirectory

Data directory used by master forests. The value is string, for example "/tmp" (e.g. returned by xdmp:data-directory()) function call).

masterFastDataDirectory

Fast directory used by master forests. The value is string, for example "/tmp".

masterLargeDataDirectory

Large directory used by master forests. The value is string, for example "/tmp".

masterReplicaDataDirectory

Data directory used by master forest replicas. The value is string, for example "/tmp".

masterReplicaFastDataDirectory

Fast directory used by master forest replicas. The value is string, for example "/tmp".

masterReplicaLargeDataDirectory

Large directory used by master forest replicas. The value is string, for example "/tmp".

Example

// Apply configuration ZIP.
'use strict';
const cma = require('/MarkLogic/cma.sjs');
cma.applyConfig($zip);
    

Example

// Create a REST server.
'use strict';

var cma = require('/MarkLogic/cma.sjs');

var json = {
    "config": [{
    "forest":[{"forest-name":"mydb1-f1"},{"forest-name":"mymodulesdb-f1"}],
        "database": [{
                "database-name": "myDb",
        "forest":["mydb1-f1"]
            },
            {
                "database-name": "myModulesDb",
        "forest":["mymodulesdb1-f1"]
            }
        ],
        "server": [{
            "server-name": "restapiServer",
            "server-type": "http",
      "group-name":"Default",
            "root": "/",
            "port": "8900",
      "url-rewriter": "/MarkLogic/rest-api/8000-rewriter.xml",
            "content-database": "myDb",
            "modules-database": "myModulesDb"
        }]
    }]
};
 
cma.applyConfig(json);