|
|
admin:database-add-element-attribute-word-lexicon(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$element-attribute-word-lexicons as element(db:element-attribute-word-lexicon)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds an element attribute word lexicon to the
specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$element-attribute-word-lexicons
:
An element word lexicon specification, typically the result of an
admin:database-element-word-lexicon call.
|
|
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 $dbid := xdmp:database("Documents")
let $lexspec := admin:database-element-attribute-word-lexicon("my/namepsace",
"elementname", "", "myAttribute", "http://marklogic.com/collation/" )
return
admin:database-add-element-attribute-word-lexicon($config, $dbid, $lexspec)
(: 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:database-add-field-excluded-element(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$excluded-elements as element(db:excluded-element)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds the field excluded
element specification in the specified
database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$excluded-elements
:
The excluded elements specification, typically the result of
an admin:database-excluded-element call.
|
|
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 $dbid := xdmp:database("myDatabase")
let $fieldspec := admin:database-excluded-element("http://myuri/namespace",
"element-name")
return
admin:database-add-field-excluded-element($config, $dbid,
"myField", $fieldspec)
(: 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:database-add-field-included-element(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$included-elements as element(db:included-element)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds the field included
element specification tn the specified
database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$included-elements
:
The included elements specification, typically the result of
an admin:database-included-element call.
|
|
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 $dbid := xdmp:database("myDatabase")
let $fieldspec := admin:database-included-element("http://myuri/namespace",
"element-name", 1.0, "", "myAttribute", "some value")
return
admin:database-add-field-included-element($config, $dbid,
"myField", $fieldspec)
(: 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:database-add-geospatial-element-attribute-pair-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$geospatial-element-attribute-pair-indexes as element(db:geospatial-element-attribute-pair-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds a geospatial element attribute
pair index to the specified
database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$geospatial-element-attribute-pair-indexes
:
A geospatial element attribute pair index specification, typically
the result of an
admin:database-geospatial-element-attribute-pair-index
call.
|
|
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 $geospec := admin:database-geospatial-element-attribute-pair-index(
"/my/namespace", "elementname", "/my/namespace", "lat",
"/my/namespace", "long", "wgs84", fn:false() )
return
admin:database-add-geospatial-element-attribute-pair-index($config,
xdmp:database("myDatabase"), $geospec)
(: 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:database-add-geospatial-element-child-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$geospatial-element-child-indexes as element(db:geospatial-element-child-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds a geospatial element child index to
the specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$geospatial-element-child-indexes
:
A geospatial element child index specification, typically
the result of
an admin:database-geospatial-element-child-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $geospec := admin:database-geospatial-element-child-index("/my/namespace",
"elementname", "/my/namespace", "child-element",
"wgs84", fn:false() )
return
admin:database-add-geospatial-element-child-index($config, $dbid, $geospec)
(: 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:database-add-geospatial-element-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$geospatial-element-indexes as element(db:geospatial-element-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds a range element index to the specified
database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$geospatial-element-indexes
:
A geospatial element index specification, typically the result of
an admin:database-geospatial-element-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $geospec := admin:database-geospatial-element-index("/my/namespace",
"elementname", "wgs84", fn:false() )
return
admin:database-add-geospatial-element-index($config, $dbid, $geospec)
(: 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:database-add-geospatial-element-pair-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$geospatial-element-pair-indexes as element(db:geospatial-element-pair-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds a geospatial element pair index to
the specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$geospatial-element-pair-indexes
:
A geospatial element pair index specification, typically
the result of
an admin:database-geospatial-element-pair-index call.
|
|
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 $geospec := admin:database-geospatial-element-pair-index("/my/namespace",
"elementname", "/my/namespace", "lat",
"/my/namespace", "long", "wgs84", fn:false() )
return
admin:database-add-geospatial-element-pair-index($config,
xdmp:database("myDatabase"), $geospec)
(: 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:database-add-merge-blackout(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$merge-blackouts as element(db:merge-blackout)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds a merge blackout specification for a
database to a configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$merge-blackouts
:
The merge blackout specification(s), typically the result of
an admin:database-one-time-merge-blackout or
an admin:database-recurring-merge-blackout call
|
|
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 $dbid := xdmp:database("myDatabase")
let $mergespec := admin:database-one-time-merge-blackout(500,
xs:dateTime("2008-02-14T09:45:00"),
(), xs:dayTimeDuration("PT3H") )
return
admin:database-add-merge-blackout($config, $dbid, $mergespec)
(: 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:database-add-range-element-attribute-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$attribute-indexes as element(db:range-element-attribute-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds a range element attribute index to the
specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$attribute-indexes
:
An element attribute range index specification, typically the result of an
admin:database-range-element-attribute-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $rangespec := admin:database-range-element-attribute-index("string",
"/my/namespace", "elementname", "", "myAttribute",
"http://marklogic.com/collation/", fn:false() )
return
admin:database-add-range-element-attribute-index($config, $dbid, $rangespec)
(: 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:database-add-range-element-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$range-indexes as element(db:range-element-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds a range element index to the specified
database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$range-indexes
:
An element range index specification, typically the result of an
admin:database-range-element-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $rangespec := admin:database-range-element-index("string", "/my/namespace",
"elementname", "http://marklogic.com/collation/",
fn:false() )
return
admin:database-add-range-element-index($config, $dbid, $rangespec)
(: 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:database-add-word-query-included-element(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$included-elements as element(db:included-element)*
|
| ) as element(configuration) |
|
 |
Summary:
This function adds the word query included
element specification to the specified
database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$included-elements
:
The included elements specification, typically the result of
an admin:database-included-element call.
|
|
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 $dbid := xdmp:database("myDatabase")
let $wqspec := admin:database-included-element("http://myuri/namespace",
"element-name", 1.0, "", "myAttribute", "some value")
return
admin:database-add-word-query-included-element($config, $dbid, $wqspec)
(: 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:database-daily-backup(
|
|
$backup-dir as xs:string,
|
|
$backup-period as xs:positiveInteger,
|
|
$start-time as xs:time,
|
|
$max-backups as xs:unsignedLong,
|
|
$backup-security-db as xs:boolean,
|
|
$backup-schemas-db as xs:boolean,
|
|
$backup-triggers-db as xs:boolean
|
| ) as element(db:database-backup) |
|
 |
Summary:
This function constructs a daily scheduled database backup.
|
Parameters:
$backup-dir
:
The directory to save the backup.
|
$backup-period
:
The number of days to elapse between each backup
|
$start-time
:
The time of day of the backup, in 24:00:00 notation.
|
$max-backups
:
The maximum number of backups to keep. When you reach the specified
maximum number of backups, the next backup will delete the oldest backup.
Specify 0 to keep an unlimited number of backups.
|
$backup-security-db
:
Whether to backup the security database alongside the current backup.
|
$backup-schemas-db
:
Whether to backup the schemas database alongside the current backup.
|
$backup-triggers-db
:
Whether to backup the triggers database alongside the current backup.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-daily-backup("/backup-dir", 2,
xs:time("19:45:00"),10,true(),true(),true())
(: returns the daily database backup specification :)
|
|
|
|
admin:database-delete-element-attribute-word-lexicon(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$lexicons as element(db:element-attribute-word-lexicon)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes an element attribute word lexicon for the
specified database from the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$lexicons
:
An element attribute word lexicon specification, typically the result of an
admin:database-element-attribute-word-lexicon call.
|
|
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 $dbid := xdmp:database("Documents")
let $lexspec := admin:database-element-attribute-word-lexicon("my/namepsace",
"elementname", "", "myAttribute", "http://marklogic.com/collation/" )
return
admin:database-delete-element-attribute-word-lexicon($config, $dbid, $lexspec)
(: 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:database-delete-field-excluded-element(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$excluded-elements as element(db:excluded-element)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes the field excluded
element specification in the specified
database from the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$excluded-elements
:
The excluded elements specification, typically the result of
an admin:database-excluded-element call.
|
|
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 $dbid := xdmp:database("myDatabase")
let $fieldspec := admin:database-excluded-element("http://myuri/namespace",
"element-name")
return
admin:database-delete-field-excluded-element($config, $dbid,
"myField", $fieldspec)
(: 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:database-delete-field-included-element(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$included-elements as element(db:included-element)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes the field included
element specification in the specified
database from the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$included-elements
:
The included elements specification, typically the result of
an admin:database-included-element call.
|
|
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 $dbid := xdmp:database("myDatabase")
let $fieldspec := admin:database-included-element("http://myuri/namespace",
"element-name", 1.0, "", "myAttribute", "some value")
return
admin:database-delete-field-included-element($config, $dbid,
"myField", $fieldspec)
(: 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:database-delete-geospatial-element-attribute-pair-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$indexes as element(db:geospatial-element-attribute-pair-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes a geospatial element attribute
pair index in the specified
database from the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$indexes
:
A geospatial element attribute pair index specification,
typically the result of an
admin:database-geospatial-element-attribute-pair-index
call.
|
|
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 $geospec := admin:database-geospatial-element-attribute-pair-index(
"/my/namespace", "elementname", "/my/namespace", "lat",
"/my/namespace", "long", "wgs84", fn:false() )
return
admin:database-delete-geospatial-element-pair-index($config,
xdmp:database("myDatabase"), $geospec)
(: 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:database-delete-geospatial-element-child-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$geospatial-element-child-indexes as element(db:geospatial-element-child-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes a geospatial element child index for the
specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$geospatial-element-child-indexes
:
A geospatial element child index specification, typically
the result of an
admin:database-geospatial-element-child-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $geospec := admin:database-geospatial-element-child-index("/my/namespace",
"elementname", "/my/namespace", "child-element", "wgs84", fn:false() )
return
admin:database-delete-geospatial-element-child-index($config, $dbid, $geospec)
(: 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:database-delete-geospatial-element-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$geospatial-element-indexes as element(db:geospatial-element-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes a geospatial element index for the
specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$geospatial-element-indexes
:
A geospatial element index specification, typically the result of an
admin:database-geospatial-element-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $geospec := admin:database-geospatial-element-index("/my/namespace",
"elementname", "wgs84", fn:false() )
return
admin:database-delete-geospatial-element-index($config, $dbid, $geospec)
(: 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:database-delete-geospatial-element-pair-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$geospatial-element-pair-indexes as element(db:geospatial-element-pair-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes a geospatial element pair index for
the specified database from the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$geospatial-element-pair-indexes
:
A geospatial element pair index specification, typically
the result of
an admin:database-geospatial-element-pair-index call.
|
|
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 $geospec := admin:database-geospatial-element-pair-index("/my/namespace",
"elementname", "/my/namespace", "lat",
"/my/namespace", "long", "wgs84", fn:false() )
return
admin:database-delete-geospatial-element-pair-index($config,
xdmp:database("myDatabase"), $geospec)
(: 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:database-delete-range-element-attribute-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$attribute-indexes as element(db:range-element-attribute-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes a range element attribute index for
the specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$attribute-indexes
:
An element attribute range index specification, typically the
result of an
admin:database-range-element-attribute-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $rangespec := admin:database-range-element-attribute-index("string",
"/my/namespace", "elementname", "", "myAttribute",
"http://marklogic.com/collation/", fn:false() )
return
admin:database-delete-range-element-attribute-index($config, $dbid, $rangespec)
(: 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:database-delete-range-element-index(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$range-indexes as element(db:range-element-index)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes a range element index for the specified
database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$range-indexes
:
An element range index specification, typically the result of an
admin:database-range-element-index call.
|
|
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 $dbid := xdmp:database("Documents")
let $rangespec := admin:database-range-element-index("string", "/my/namespace",
"elementname", "http://marklogic.com/collation/",
fn:false() )
return
admin:database-delete-range-element-index($config, $dbid, $rangespec)
(: 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:database-delete-word-query-included-element(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$included-elements as element(db:included-element)*
|
| ) as element(configuration) |
|
 |
Summary:
This function deletes the word query included
element specification in the specified
database from the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$included-elements
:
The included elements specification, typically the result of
an admin:database-included-element call.
|
|
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 $dbid := xdmp:database("myDatabase")
let $wqspec := admin:database-included-element("http://myuri/namespace",
"element-name", 1.0, "", "myAttribute", "some value")
return
admin:database-delete-word-query-included-element($config, $dbid, $wqspec)
(: 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:database-geospatial-element-attribute-pair-index(
|
|
$parent-namespace as xs:string,
|
|
$parent-localname as xs:string,
|
|
$latitude-namespace as xs:string,
|
|
$latitude-localname as xs:string,
|
|
$longitude-namespace as xs:string,
|
|
$longitude-localname as xs:string,
|
|
$coordinate-system as xs:string,
|
|
$range-value-positions as xs:boolean
|
| ) as element(db:geospatial-element-attribute-pair-index) |
|
 |
Summary:
This function constructs a geospatial element attribute
pair index specification.
|
Parameters:
$parent-namespace
:
The namespace of the parent element for the attribute.
|
$parent-localname
:
The local name of the parent element for the attribute.
|
$latitude-namespace
:
The namespace for the element containing the latitude.
|
$latitude-localname
:
The local name for the element containing the latitude.
|
$longitude-namespace
:
The namespace for the element containing the longitude.
|
$longitude-localname
:
The local name for the element containing the longitude.
|
$coordinate-system
:
The coordinate system. Must be one of wgs84 or
raw.
|
$range-value-positions
:
A boolean specifying whether to maintain value postions
in this index (used with co-occurrences).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-geospatial-element-attribute-pair-index("/my/namespace",
"elementname", "/my/namespace", "lat",
"/my/namespace", "long", "wgs84", fn:false() )
(: returns the geospatial element attribute pair index specification :)
|
|
|
|
admin:database-geospatial-element-child-index(
|
|
$parent-namespace as xs:string,
|
|
$parent-localname as xs:string,
|
|
$namespace as xs:string,
|
|
$localname as xs:string,
|
|
$coordinate-system as xs:string,
|
|
$range-value-positions as xs:boolean
|
| ) as element(db:geospatial-element-child-index) |
|
 |
Summary:
This function constructs a geospatial element child index
specification.
|
Parameters:
$parent-namespace
:
The namespace of the parent element for the attribute.
|
$parent-localname
:
The local name of the parent element for the attribute.
|
$namespace
:
The namespace URI. Specify an empty string if the
element is in no namespace.
|
$localname
:
The local name for the node.
|
$coordinate-system
:
The coordinate system. Must be one of wgs84 or
raw.
|
$range-value-positions
:
A boolean specifying whether to maintain value postions
in this index (used with co-occurrences).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-geospatial-element-child-index("/my/namespace",
"elementname", "/my/namespace", "child-element",
"wgs84", fn:false() )
(: returns the geospatial element child index specification :)
|
|
|
|
admin:database-geospatial-element-child-index(
|
|
$parent-namespace as xs:string,
|
|
$parent-localname as xs:string,
|
|
$namespace as xs:string,
|
|
$localname as xs:string,
|
|
$coordinate-system as xs:string,
|
|
$point-format as xs:string,
|
|
$range-value-positions as xs:boolean
|
| ) as element(db:geospatial-element-child-index) |
|
 |
Summary:
This function constructs a geospatial element child index
specification.
|
Parameters:
$parent-namespace
:
The namespace of the parent element for the attribute.
|
$parent-localname
:
The local name of the parent element for the attribute.
|
$namespace
:
The namespace URI. Specify an empty string if the
element is in no namespace.
|
$localname
:
The local name for the node.
|
$coordinate-system
:
The coordinate system. Must be one of wgs84 or
raw.
|
$point-format
:
The point format in the data: "point" means latitude precedes
longitude (this is the default); "long-lat-point" means
longitude precedes latitude. To use the default value of
"point", simply omit this parameter. Do not specify an empty
string.
|
$range-value-positions
:
A boolean specifying whether to maintain value postions
in this index (used with co-occurrences).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-geospatial-element-child-index("/my/namespace",
"elementname", "/my/namespace", "child-element",
"wgs84", "long-lat-point", fn:false() )
(: returns the geospatial element child index specification :)
|
|
|
|
admin:database-geospatial-element-pair-index(
|
|
$parent-namespace as xs:string,
|
|
$parent-localname as xs:string,
|
|
$latitude-namespace as xs:string,
|
|
$latitude-localname as xs:string,
|
|
$longitude-namespace as xs:string,
|
|
$longitude-localname as xs:string,
|
|
$coordinate-system as xs:string,
|
|
$range-value-positions as xs:boolean
|
| ) as element(db:geospatial-element-pair-index) |
|
 |
Summary:
This function constructs a geospatial element pair index
specification.
|
Parameters:
$parent-namespace
:
The namespace of the parent element for the attribute.
|
$parent-localname
:
The local name of the parent element for the attribute.
|
$latitude-namespace
:
The namespace for the element containing the latitude.
|
$latitude-localname
:
The local name for the element containing the latitude.
|
$longitude-namespace
:
The namespace for the element containing the longitude.
|
$longitude-localname
:
The local name for the element containing the longitude.
|
$coordinate-system
:
The coordinate system. Must be one of wgs84 or
raw.
|
$range-value-positions
:
A boolean specifying whether to maintain value postions
in this index (used with co-occurrences).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-geospatial-element-pair-index("/my/namespace",
"elementname", "/my/namespace", "lat",
"/my/namespace", "long", "wgs84", fn:false() )
(: returns the geospatial element pair index specification :)
|
|
|
|
admin:database-get-id(
|
|
$config as element(configuration),
|
|
$database-name as xs:string
|
| ) as xs:unsignedLong |
|
 |
Summary:
This function returns the ID for the specified database from the configuration.
As shown in the example below, the returned ID enables you to completely
configure a newly created database without the need to first save the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-name
:
The name of the database.
|
|
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 $config := admin:database-create($config, "myNewDatabase",
xdmp:database("Security"), xdmp:database("Schemas"))
let $databaseID := admin:database-get-id($config, "myNewDatabase")
let $fieldspec := admin:database-field("myField", fn:true() )
let $config := admin:database-add-field($config, $databaseID, $fieldspec)
return
admin:database-attach-forest($config, $databaseID,
xdmp:forest("newForest") )
(: Attaches "newForest" and adds the field, "myField" to the newly created
database, "myNewDatabase" :)
|
|
|
|
admin:database-hourly-backup(
|
|
$backup-dir as xs:string,
|
|
$backup-period as xs:positiveInteger,
|
|
$start-minute as xs:nonNegativeInteger,
|
|
$max-backups as xs:unsignedLong,
|
|
$backup-security-db as xs:boolean,
|
|
$backup-schemas-db as xs:boolean,
|
|
$backup-triggers-db as xs:boolean
|
| ) as element(db:database-backup) |
|
 |
Summary:
This function constructs a hourly scheduled database backup.
|
Parameters:
$backup-dir
:
The directory to save the backup.
|
$backup-period
:
The number of hours to elapse between each backup.
|
$start-minute
:
The number of minutes after the hour to start the backup. Note that this
setting does not add to the backup period value.
|
$max-backups
:
The maximum number of backups to keep. When you reach the specified
maximum number of backups, the next backup will delete the oldest backup.
Specify 0 to keep an unlimited number of backups.
|
$backup-security-db
:
Whether to backup the security database alongside the current backup.
|
$backup-schemas-db
:
Whether to backup the schemas database alongside the current backup.
|
$backup-triggers-db
:
Whether to backup the triggers database alongside the current backup.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-hourly-backup("/backup-dir", 2,
30, 10, true(), true(), true())
(: Returns the hourly database backup specification. For example, if the current
time is 2:15pm, the backup will run at 4:30pm, 6:30pm, 8:30pm, and so on. :)
|
|
|
|
admin:database-included-element(
|
|
$namespace as xs:string,
|
|
$localname as xs:string,
|
|
$weight as xs:double,
|
|
$attribute-namespace as xs:string,
|
|
$attribute-localname as xs:string,
|
|
$attribute-value as xs:string
|
| ) as element(db:included-element) |
|
 |
Summary:
This function constructs an included element specification.
|
Parameters:
$namespace
:
The namespace URI. Specify an empty string if the
element is in no namespace.
|
$localname
:
The local name for the node.
|
$weight
:
The query weight to use in relavance calculations.
|
$attribute-namespace
:
The namespace for the attribute to constrain on. Specify an
empty string if there is no attribute to constrain on or if the
attribute is in no namespace.
|
$attribute-localname
:
The local name of the attribute to constrain on. Specify an
empty string if there is no attribute to constrain on.
|
$attribute-value
:
The value for the attribute to constrain on (only attributes with
this value). Specify an empty string if there is no attribute
to constrain on.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-included-element("http://myuri/namespace",
"element-name", 1.0, "", "myAttribute", "some value")
(: the constructed element :)
|
|
|
|
admin:database-minutely-backup(
|
|
$backup-dir as xs:string,
|
|
$backup-period as xs:positiveInteger,
|
|
$max-backups as xs:unsignedLong,
|
|
$backup-security-db as xs:boolean,
|
|
$backup-schemas-db as xs:boolean,
|
|
$backup-triggers-db as xs:boolean
|
| ) as element(db:database-backup) |
|
 |
Summary:
This function constructs a scheduled database backup on a number-of-minutes basis.
|
Parameters:
$backup-dir
:
The directory to save the backup.
|
$backup-period
:
The number of minutes to elapse between each backup.
|
$max-backups
:
The maximum number of backups to keep. When you reach the specified
maximum number of backups, the next backup will delete the oldest backup.
Specify 0 to keep an unlimited number of backups.
|
$backup-security-db
:
Whether to backup the security database alongside the current backup.
|
$backup-schemas-db
:
Whether to backup the schemas database alongside the current backup.
|
$backup-triggers-db
:
Whether to backup the triggers database alongside the current backup.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-minutely-backup("/backup-dir", 45,
10, true(), true(), true())
(: Returns the minutely database backup specification. :)
|
|
|
|
admin:database-monthly-backup(
|
|
$backup-dir as xs:string,
|
|
$backup-period as xs:positiveInteger,
|
|
$backup-month-day as xs:unsignedLong,
|
|
$start-time as xs:time,
|
|
$max-backups as xs:unsignedLong,
|
|
$backup-security-db as xs:boolean,
|
|
$backup-schemas-db as xs:boolean,
|
|
$backup-triggers-db as xs:boolean
|
| ) as element(db:database-backup) |
|
 |
Summary:
This function constructs a monthly scheduled backup.
|
Parameters:
$backup-dir
:
The directory where the backup will be saved to.
|
$backup-period
:
The number of months to elapse between each backup.
|
$backup-month-day
:
The day of the month the backup will happen (between 1 and 31)
|
$start-time
:
A time for the scheduled backup to start.
|
$max-backups
:
The maximum number of backups to keep in the backup
directory.
|
$backup-security-db
:
Whether to backup the security database alongside the
current backup.
|
$backup-schemas-db
:
Whether to backup the schemas database alongside the
current backup.
|
$backup-triggers-db
:
Whether to backup the triggers database alongside the
current backup.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-monthly-backup("/backup-dir", 2, 1,
xs:time("09:45:00"),10,true(),true(),true())
(: returns the monthly backup specification :)
|
|
|
|
admin:database-one-time-backup(
|
|
$backup-dir as xs:string,
|
|
$start as xs:dateTime,
|
|
$max-backups as xs:unsignedLong,
|
|
$backup-security-db as xs:boolean,
|
|
$backup-schemas-db as xs:boolean,
|
|
$backup-triggers-db as xs:boolean
|
| ) as element(db:database-backup) |
|
 |
Summary:
This function constructs a one-time backup.
|
Parameters:
$backup-dir
:
The directory where the backup will be saved to.
|
$start
:
The starting dateTime of the scheduled backup.
|
$max-backups
:
The maximum number of backups to keep in the backup
directory.
|
$backup-security-db
:
Whether to backup the security database alongside the
current backup.
|
$backup-schemas-db
:
Whether to backup the schemas database alongside the
current backup.
|
$backup-triggers-db
:
Whether to backup the triggers database alongside the
current backup.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-one-time-backup("/backup-dir",
xs:dateTime("2008-02-14T09:45:00"),10,true(),true(),true())
(: returns the one-time backup :)
|
|
|
|
admin:database-range-element-attribute-index(
|
|
$scalar-type as xs:string,
|
|
$parent-namespace as xs:string,
|
|
$parent-localname as xs:string,
|
|
$namespace as xs:string,
|
|
$localname as xs:string,
|
|
$collation as xs:string,
|
|
$range-value-positions as xs:boolean
|
| ) as element(db:range-element-attribute-index) |
|
 |
Summary:
This function constructs a range element attribute index
specification.
|
Parameters:
$scalar-type
:
A valid type for the range index. Must be one of:
int, unsignedInt,
long, unsignedLong,
float, double,
decimal, dateTime,
time, date,
gYearMonth, gYear,
gMonth, gDay,
yearMonthDuration, dayTimeDuration,
string, anyURI, or
point.
|
$parent-namespace
:
The namespace of the parent element for the attribute.
|
$parent-localname
:
The local name of the parent element for the attribute.
|
$namespace
:
The namespace URI.
|
$localname
:
The local name for the node.
|
$collation
:
The collation URI (for example,
http://marklogic.com/collation/. The collation
is only needed for string and anyURI indexes; for other indexes,
specify the empty string ("") for this parameter.
|
$range-value-positions
:
A boolean specifying whether to maintain value postions
in this index (used with co-occurrences).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-range-element-attribute-index("string", "/my/namespace",
"elementname", "", "myAtribute", "http://marklogic.com/collation/",
fn:false() )
(: returns the range element attribute-index specification :)
|
|
|
|
admin:database-range-element-index(
|
|
$scalar-type as xs:string,
|
|
$namespace as xs:string,
|
|
$localname as xs:string,
|
|
$collation as xs:string,
|
|
$range-value-positions as xs:boolean
|
| ) as element(db:range-element-index) |
|
 |
Summary:
This function constructs a range element index
specification.
|
Parameters:
$scalar-type
:
A valid type for the range index. Must be one of:
int, unsignedInt,
long, unsignedLong,
float, double,
decimal, dateTime,
time, date,
gYearMonth, gYear,
gMonth, gDay,
yearMonthDuration, dayTimeDuration,
string, anyURI, or
point.
|
$namespace
:
The namespace URI.
|
$localname
:
The local name for the node.
|
$collation
:
The collation URI (for example,
http://marklogic.com/collation/). The collation
is only needed for string and anyURI indexes; for other indexes,
specify the empty string ("") for this parameter.
|
$range-value-positions
:
A boolean specifying whether to maintain value postions
in this index (used with co-occurrences).
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-range-element-index("string", "/my/namespace",
"elementname", "http://marklogic.com/collation/",
fn:false() )
(: returns the range element index specification :)
|
|
|
|
admin:database-recurring-merge-blackout(
|
|
$limit as xs:unsignedInt,
|
|
$days as xs:string+,
|
|
$start-time as xs:time?,
|
|
$end-time as xs:time?,
|
|
$duration as xs:duration?
|
| ) as element(db:merge-blackout) |
|
 |
Summary:
This function constructs a merge-blackout specification.
|
Parameters:
$limit
:
The maximum number of megabytes for a merge.
|
$days
:
The day(s) of the week. Must be a sequence of zero
or more of monday, tuesday,
wednesday, thusday,
friday, saturday,
sunday.
|
$start-time
:
A time for the merge blackout to start.
|
$end-time
:
A time for the merge blackout to end.
|
$duration
:
The amount of time for the blackout to last.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-recurring-merge-blackout(500, "lower", "monday",
xs:time("09:45:00"), xs:time("11:45:00"), () )
(: returns the merge-blackout specification :)
|
|
|
|
admin:database-set-field-fast-case-sensitive-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field fast case sensitive
searches setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-fast-case-sensitive-searches($config,
xdmp:database("myDatabase"), "myField", fn:true())
(: 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:database-set-field-fast-diacritic-sensitive-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field fast diacritic sensitive
searches setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-fast-diacritic-sensitive-searches($config,
xdmp:database("myDatabase"), "myField", fn:false())
(: 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:database-set-field-fast-phrase-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field fast phrase searches setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-fast-phrase-searches($config,
xdmp:database("myDatabase"), "myField", fn:true())
(: 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:database-set-field-include-document-root(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field include document root setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false() to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-include-document-root($config,
xdmp:database("myDatabase"), "myField", fn:true())
(: 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:database-set-field-one-character-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field one character searches setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-one-character-searches($config,
xdmp:database("myDatabase"), "myField", fn:false())
(: 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:database-set-field-stemmed-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:string?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field stemmed searches setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
The new stemmed search value. Must be one of
basic, advanced,
or decompounding. It must be equal to or greater
than the database setting. The empty sequence turns this
setting off for the field.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-stemmed-searches($config,
xdmp:database("myDatabase"), "myField", "decompounding")
(: 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:database-set-field-three-character-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field three character searches
setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-three-character-searches($config,
xdmp:database("myDatabase"), "myField", fn:true())
(: 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:database-set-field-three-character-word-positions(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field three character
word positions setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-three-character-word-positions($config,
xdmp:database("myDatabase"), "myField", fn:true())
(: 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:database-set-field-trailing-wildcard-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field trailing wildcard
searches setting
for the specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-trailing-wildcard-searches($config,
xdmp:database("myDatabase"), "myField", fn:true())
(: 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:database-set-field-trailing-wildcard-word-positions(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field trailing wildcard word
positions setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-wildcard-word-positions($config,
xdmp:database("myDatabase"), "myField", fn:false())
(: 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:database-set-field-two-character-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field two character searches setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-get-field-two-character-searches($config,
xdmp:database("myDatabase"), "myField", fn:false())
(: 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:database-set-field-word-searches(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$field-name as xs:string,
|
|
$value as xs:boolean?
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the field word searches setting
for the specified field in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$field-name
:
The name of the field.
|
$value
:
A boolean value, fn:true() to enable, fn:false()
or the empty sequence to disable.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-field-word-searches($config,
xdmp:database("myDatabase"), "myField", fn:true())
(: 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:database-set-format-compatibility(
|
|
$config as element(configuration),
|
|
$database-id as xs:unsignedLong,
|
|
$value as xs:string
|
| ) as element(configuration) |
|
 |
Summary:
This function sets the format cpmpatibility setting
for the specified database in the configuration.
|
Parameters:
$config
:
A configuration specification, typically as returned
from one of the Admin module functions.
|
$database-id
:
The id of the database (for example,
xdmp:database("myDatabase")).
|
$value
:
The new format-compatibility setting. Must be one of:
automatic, 4.0,
3.2, 3.1, 3.0,
or 2.2.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
let $config := admin:get-configuration()
return
admin:database-set-format-compatibility($config,
xdmp:database("myDatabase"), "automatic")
(: 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:database-weekly-backup(
|
|
$backup-dir as xs:string,
|
|
$backup-period as xs:positiveInteger,
|
|
$days as xs:string+,
|
|
$start-time as xs:time,
|
|
$max-backups as xs:unsignedLong,
|
|
$backup-security-db as xs:boolean,
|
|
$backup-schemas-db as xs:boolean,
|
|
$backup-triggers-db as xs:boolean
|
| ) as element(db:database-backup) |
|
 |
Summary:
This function constructs a weekly scheduled backup.
|
Parameters:
$backup-dir
:
The directory where the backup will be saved to.
|
$backup-period
:
The how many weeks between each backup.
|
$days
:
The day(s) of the week. Must be a sequence of zero
or more of monday, tuesday,
wednesday, thusday,
friday, saturday,
sunday.
|
$start-time
:
A time for the scheduled backup to start.
|
$max-backups
:
The maximum number of backups to keep in the backup
directory.
|
$backup-security-db
:
Whether to backup the security database alongside the
current backup.
|
$backup-schemas-db
:
Whether to backup the schemas database alongside the
current backup.
|
$backup-triggers-db
:
Whether to backup the triggers database alongside the
current backup.
|
|
Example:
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-weekly-backup("/backup-dir", 2, "monday",
xs:time("09:45:00"),10,true(),true(),true())
(: returns the weekly backup specification :)
|
|
|