|
|
admin:group-set-audit-role-restriction(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$restriction-type as xs:string,
|
|
$roles as xs:string*
|
| ) as element(configuration) |
|
 |
Summary:
This function restricts the audit configuration by excluding or
including by role.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$restriction-type
:
The restriction type
(must be one of: "inclusion" or "exclusion").
|
$roles
:
The sequence of roles affected by the restriction type.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-audit-role-restriction($config, $groupid,
"exclusion",("admin-role","developer-role"))
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-audit-uri-restriction(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$restriction-type as xs:string,
|
|
$uris as xs:string*
|
| ) as element(configuration) |
|
 |
Summary:
This function restricts the audit configuration by excluding or
including by document uri(s).
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$restriction-type
:
The restriction type
(must be one of: "inclusion" or "exclusion").
|
$uris
:
The sequence of document-uris affected by the restriction type.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-audit-uri-restriction($config, $groupid,
"inclusion",("/important/foo.xml","/important/foo1.xml"))
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-audit-user-restriction(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$restriction-type as xs:string,
|
|
$users as xs:string*
|
| ) as element(configuration) |
|
 |
Summary:
This function restricts the audit configuration by excluding or
including by user.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$restriction-type
:
The restriction type
(must be one of: "inclusion" or "exclusion").
|
$users
:
The sequence of users affected by the restriction type.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-audit-user-restriction($config, $groupid,
"exclusion",("admin1","admin2"))
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-background-io-limit(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$max-megabytes-per-second as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function sets a limit on the amount of I/O that background tasks
(for example, merges) will consume. If the limit is reached, then
merges are throttled back to limit their maximum I/O. This can help
in situations when the I/O system on the computer is maxed out. In normal
operations, you should not need to set this parameter.
|
Parameters:
$config
:
A configuration specification, typically as returned from one of the Admin
module functions.
|
$group-id
:
The ID of the group to which the App Server belongs.
Typically, this is the result
of an admin:group-get-id call.
|
$max-megabytes-per-second
:
A number representing the maximum amount of I/O, in
megabytes-per-second, to allow for each host in the group.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-background-io-limit($config, $groupid, 100)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-compressed-tree-cache-partitions(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function changes the compressed tree cache
partitions setting of the group with the specified ID
to the specified value. More partitions allow more
concurrency, but make each individual cache partition
smaller, which could make it more likely for the cache
to fill up. This is a "cold" operation; when you use
admin:save-configuration to save the
configuration, it will automatically restart MarkLogic
Server.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
A new value for the number of cache partitions.
|
|
Usage Notes:
The server may use fewer or more partitions than the configured
value to keep partition sizes between 512 and 12288 megabytes.
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-compressed-tree-cache-partitions($config, $groupid, 2)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-expanded-tree-cache-partitions(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function changes the expanded tree cache
partitions setting of the group with the specified ID
to the specified value. More partitions allow more
concurrency, but make each individual cache partition
smaller, which could make it more likely for the cache
to fill up. This is a "cold" operation; when you use
admin:save-configuration to save the
configuration, it will automatically restart MarkLogic
Server.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
A new value for the number of cache partitions.
|
|
Usage Notes:
The server may use fewer or more partitions than the configured
value to keep partition sizes between 1024 and 12288 megabytes.
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-expanded-tree-cache-partitions($config, $groupid, 2)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-file-log-level(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:string
|
| ) as element(configuration) |
|
 |
Summary:
This function changes the host file log level setting
for the group in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
The new log level (must be one of finest,
finer, fine,
debug, config,
info, notice,
warning, error,
critical,
alert, emergency).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-file-log-level($config, $groupid, "debug")
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-list-cache-partitions(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function changes the list cache partitions
setting of the group with the specified ID to the
specified value. More partitions allow more
concurrency, but make each individual cache partition
smaller, which could make it more likely for the cache
to fill up. This is a "cold" operation; when you use
admin:save-configuration to save the
configuration, it will automatically restart MarkLogic
Server.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
A new value for the number of cache partitions.
|
|
Usage Notes:
The server may use fewer or more partitions than the configured
value to keep partition sizes between 2048 and 12288 megabytes.
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-list-cache-partitions($config, $groupid, 2)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-rotate-audit-files(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:string
|
| ) as element(configuration) |
|
 |
Summary:
This function changes the rotate audit files setting
for the group in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
The new audit level (must be one of never,
daily, monday,
tuesday, wednesday,
thursday, friday,
saturday, sunday,
monthly).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-rotate-audit-files($config, $groupid, "wednesday")
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-rotate-log-files(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:string
|
| ) as element(configuration) |
|
 |
Summary:
This function changes the rotate log files setting
for the group in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
The new log level (must be one of never,
daily, monday,
tuesday, wednesday,
thursday, friday,
saturday, sunday,
monthly).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-rotate-log-files($config, $groupid, "wednesday")
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-system-log-level(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:string
|
| ) as element(configuration) |
|
 |
Summary:
This function changes the host system log level setting
for the group in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
The new log level (must be one of finest,
finer, fine,
debug, config,
info, notice,
warning, error,
critical,
alert, emergency).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $groupid := admin:group-get-id($config, "Default")
return
admin:group-set-system-log-level($config, $groupid, "debug")
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-triple-cache-partitions(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the number of partitions to allocate for
the triple index cache. More partitions allow more
concurrency, but make each individual cache partition smaller,
which could make it more likely for the cache to fill up. This
is a "cold" operation; when you use
admin:save-configuration to save the
configuration, it will automatically restart MarkLogic Server.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
A new value for the number of cache partitions.
|
|
Usage Notes:
The server may use fewer or more partitions than the configured
value to keep partition sizes between 1024 and 12288 megabytes.
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $group-id := admin:group-get-id($config, "Default")
return
admin:group-set-triple-cache-partitions($config, $group-id, 1)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-triple-cache-timeout(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the timeout value for the triple cache.
This is a "cold" operation; when you use admin:save-configuration
to save the configuration, it will automatically restart MarkLogic Server.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
The time, in seconds, before a cached page can be flushed to disk.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $group-id := admin:group-get-id($config, "Default")
return
admin:group-set-triple-cache-timeout($config, $group-id, 300)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-triple-value-cache-partitions(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the number of partitons to allocate for the
triple value index cache. More partitions allow more
concurrency, but make each individual cache partition smaller,
which could make it more likely for the cache to fill up. This
is a "cold" operation; when you use
admin:save-configuration to save the
configuration, it will automatically restart MarkLogic Server.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
A new value for the number of cache partitions.
|
|
Usage Notes:
The server may use fewer or more partitions than the configured
value to keep partition sizes between 512 and 12288 megabytes.
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $group-id := admin:group-get-id($config, "Default")
return
admin:group-set-triple-value-cache-partitions($config, $group-id, 1)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|
|
admin:group-set-triple-value-cache-timeout(
|
|
$config as element(configuration),
|
|
$group-id as xs:unsignedLong,
|
|
$value as xs:unsignedInt
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the timeout value for the triple value cache.
This is a "cold" operation; when you use admin:save-configuration
to save the configuration, it will automatically restart MarkLogic Server.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$group-id
:
The ID of the group.
Typically, this is the result
of an admin:group-get-id call.
|
$value
:
The time, in seconds, before a cached page can be flushed to disk.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
let $group-id := admin:group-get-id($config, "Default")
return
admin:group-set-triple-value-cache-timeout($config, $group-id, 300)
(: returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes. :)
|
|
|