|
|
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-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 :)
|
|
|