MarkLogic 9 Product Documentation

Ops Director Guide — Chapter 5

The total amount (in MB) of memory consumed by all of the hosts in the cluster.

The displayed metrics are:

• RSS: The total amount of MB of Process Resident Size (RSS) consumed by the cluster.
• Anon: The total amount of MB of Process Anonymous Memory consumed by the cluster.

The number of pages per second moved between memory and disk.

The displayed metrics are:

• Page-In Rate: The page-in rate (from Linux /proc/vmstat) for the cluster in pages per second.
• Page-Out Rate: The page-out rate (from Linux /proc/vmstat) for the cluster in pages per second.
• Swap-In Rate: The swap-in rate (from Linux /proc/vmstat) for the cluster in pages per second.
• Swap-Out Rate: The swap-out rate (from Linux /proc/vmstat) for the cluster in pages per second.

For more information, see Memory Performance Data.

The connection attributes for the bootstrap host on this cluster.

• Bootstrap Connect Port: The bind port for the bootstrap host.
• Bootstrap Host Name: The name of the bootstrap host.
• Bootstrap Host ID: The ID used to identify the bootstrap host.

For details, see Bootstrap Hosts in the Concepts Guide.

• minutely specifies how many minutes between each invocation of the module.
• hourly specifies how many hours and minutes between each invocation of the module.
• daily specifies how many days between each invocation of the module and the time of day (in 24:00 notation).
• weekly specifies how many weeks between each invocation of the module, check one or more days of the week, and the time of day (in 24:00 notation) for the task to start.
• monthly specifies how many months between each invocation of the module, select one day of the month (1-31), and the time of day (in 24:00 notation) for the task to start.
• one-time specifies the start date in MM/DD/YYYY notation (for example, 07/29/2009 for July 29, 2009) and time in 24:00 notation.

• normal specifies that the task is queued with normal priority.
• higher specifies that the task is queued with higher priority.

The total amount (in MB) of memory consumed by this host.

The displayed metrics are:

• RSS: The total amount of MB of Process Resident Size (RSS) consumed by the host.
• Anon: The total amount of MB of Process Anonymous Memory consumed by the host.

The number of pages per second moved between memory and disk.

The displayed metrics are:

• Page-In Rate: The page-in rate (from Linux /proc/vmstat) for the host in pages per second.
• Page-Out Rate: The page-out rate (from Linux /proc/vmstat) for the host in pages per second.
• Swap-In Rate: The swap-in rate (from Linux /proc/vmstat) for the host in pages per second.
• Swap-Out Rate: The swap-out rate (from Linux /proc/vmstat) for the host in pages per second.

Whether this host is a bootstrap host (true). If not, the value is false.

For details, see Bootstrap Hosts in the Concepts Guide.

• minutely specifies how many minutes between each invocation of the module.
• hourly specifies how many hours and minutes between each invocation of the module.
• daily specifies how many days between each invocation of the module and the time of day (in 24:00 notation).
• weekly specifies how many weeks between each invocation of the module, check one or more days of the week, and the time of day (in 24:00 notation) for the task to start.
• monthly specifies how many months between each invocation of the module, select one day of the month (1-31), and the time of day (in 24:00 notation) for the task to start.
• one-time specifies the start date in MM/DD/YYYY notation (for example, 07/29/2009 for July 29, 2009) and time in 24:00 notation.

• normal specifies the task is queued with normal priority.
• higher specifies the task is queued with higher priority.

The total amount (in MB) of memory consumed by the database.

The displayed metrics are:

• RSS: The total amount of MB of Process Resident Size (RSS) consumed by the database.
• Anon: The total amount of MB of Process Anonymous Memory consumed by the database.

The number of pages per second moved between memory and disk.

The displayed metrics are:

• Page-In Rate: The page-in rate (from Linux /proc/vmstat) for the database in pages per second.
• Page-Out Rate: The page-out rate (from Linux /proc/vmstat) for the database in pages per second.
• Swap-In Rate: The swap-in rate (from Linux /proc/vmstat) for the database in pages per second.
• Swap-Out Rate: The swap-out rate (from Linux /proc/vmstat) for the database in pages per second.

The number of locks set per second across all of the databases in the cluster.

The displayed lines are:

• Read: The number of read locks set per second.
• Write: The number of write locks set per second.
• Deadlock: The number of deadlocks per second.

The aggregate time (in seconds) transactions wait for locks.

The displayed lines are:

• Read: The time transactions wait for read locks.
• Write: The time transactions wait for write locks.

• automatic: Specifies that a directory hierarchy is automatically created to match the URI of a document or a directory that is created. This is the recommended setting, especially if you are accessing the database with a WebDAV Server or if you are using it as a Modules database.
• manual: Specifies that directories must be manually created. No directory hierarchy is enforced.
• manual-enforced: The same as manual, except it raises an error if the parent directory does not exist when creating a document or directory. For example, to create a document with the URI http://marklogic/file.xml, the directory http://marklogic/ must first exist.

The element markup to be searched through in searches that use the cts:element-word-query constructor.

Words contained in text node children of a phrase through or Element Word Query Through element node match words in a cts:element-word-query for both the element and for the element's parent. If the parent is also a Phrase Through or Element Word Query Through element, the words also match words in a cts:element-word-query for the grandparent.

• Namespace URI: The namespace for an element or an attribute.
• Localname: The local name for an XML element or attribute, or the name of a JSON property.

For details, see Element Word Query Throughs in the Administrator's Guide.

• automatic: Cleans up the locks as they expire. This is the default value and is recommended for most installations.
• none: The lock fragments remain in the database after the locks expire (although they will no longer be locking any documents) until they are explicitly removed with xdmp:lock-release. This setting is only recommended to speed cluster startup time for extremely large clusters.

• automatic: Auto-detect index. This is the default value and is recommended for most installations.
• none: Causes queries to use the current database index settings, even if some settings have not completed reindexing.

The size, in megabytes, of each journal file. The system uses journal files for recovery operations if a transaction fails to complete successfully. The default value is sufficient for most systems; it is calculated at database configuration time based on the size of your system. If you change the other memory settings, however, the journal size must equal the sum of the In-memory List Size and the In-memory Tree Size. Additionally, you must add space to the journal size if you use range indexes (particularly if you use a lot of range indexes or have extremely large range indexes), as range index data can take up journal space. Also, if your transactions span multiple forests, you may also need to add journal size, as each journal must keep the lock information for all of the documents in the transaction, not just for the documents that reside in the forest in which the journal exists.

When you change the journal size, the next time the system creates a new journal, it will use the new size limit; existing journals will continue to use the old size limit until they are replaced with new ones (for example, when a journal fills up, when a forest is cleared, or when the system is cleanly shutdown and restarted).

• strict: The journal protects against MarkLogic Server process failures, host operating system kernel failures, and host hardware failures.
• fast: The journal protects against MarkLogic Server process failures but not against host operating system kernel failures or host hardware failures.
• off: The journal does not protect against MarkLogic Server process failures, host operating system kernel failures, or host hardware failures.

• strict: Locking enforces mutual exclusion on existing documents and on new documents.
• fast: Locking enforces mutual exclusion on existing and new documents. Instead of locking all the forests on new documents, it uses a hash function to select one forest to lock. In general, this is faster than strict. However, for a short period of time after a new forest is added, some of the transactions need to be retried internally.
• off: Locking does not enforce mutual exclusion on existing documents or on new documents; only use this setting if you are sure all documents you are loading are new (a new bulk load, for example), otherwise you might create duplicate URIs in the database.

The maximum size, in megabytes, of a stand that will result from a merge. If a stand grows beyond the specified size, it will not be merged. If two stands would be larger than the specified size if merged, they will not be merged together. If you set this to smaller sizes, large merges (which may require more disk and CPU resources) will be prevented. The default is 48 GB (49152 MB), which is recommended because it provides a good balance between keeping the number of stands low and preventing very large merges from using large amounts of disk space. Set this to 0 to allow any sized stand to merge. Use care when setting this to a non-zero value lower than the default value, as this can prevent merges which are ultimately required for the system to maintain performance levels and to allow optimized updates to the system.

For details on controlling merges, see Understanding and Controlling Database Merges in the Administrator's Guide.

The minimum number of fragments that a stand can contain. Two or more stands with fewer than this number of fragments are automatically merged.

For details on controlling merges, see Understanding and Controlling Database Merges in the Administrator's Guide.

Specifies the CPU scheduler priority at which merges run. The settings are:

• normal: Specifies the same CPU scheduler priority as for requests.
• lower: Specifies a lower CPU scheduler priority than for requests.

Merges always run with normal priority on forests with more than 16 stands.

For details on controlling merges, see Understanding and Controlling Database Merges in the Administrator's Guide.

Specifies the element markup phrased around in searches. Searches for phrases can skip around element boundaries when a phrase-around is configured for that element. For example, if there is a Phrase Around configured on a <b> tag, the following XML snippet will return a match for a search for the phrase to be or not to be:

<p>to <b>be</b> or not to be</p> 

The phrase indexer needs to know phrases may cross these markup boundaries at load time and reindex time so that it includes the right information in the indexes supporting phrase search.

Each phrase-around has the following settings:

• Namespace URI: The namespace for an element or an attribute.
• Localname: The local name for an XML element or attribute.

For more detail, see Phrasing and Element-Word-Query Boundary Control in the Administrator's Guide.

Specifies the element markup to be phrased through in searches. Searches for phrases can cross element boundaries when a phrase-through is configured for that element. For example, if there is a phrase-through configured on a <b> tag, the following XML snippet returns a match for a search for the phrase to be or not to be:

<p>to <b>be</b> or not to be</p> 

The phrase indexer needs to know phrases may cross these markup boundaries at load time and reindex time so that it includes the right information in the indexes supporting phrase search.

Words contained in text node children of a phrase-through or Element Word Query Through element node match words in a cts:element-word-query for both the element and for the element's parent. If the parent is also a phrase-through or Element Word Query Through element, the words also match words in a cts:element-word-query for the grandparent.

If you delete a phrase-through, the system will not automatically reindex away the indexed phrase-throughs, even if reindexing is enabled; to reindex deleted phrase-throughs, force a reindex (for example, by clicking the reindex button on the database configuration page).

Each phrase-through has the following settings:

• Namespace URI: Specifies the namespace for an element or an attribute.
• Localname: Specifies the local name for an XML element or attribute.

For more detail, see Phrasing and Element-Word-Query Boundary Control in the Administrator's Guide.

The range indexes on attributes in XML elements.

The fields are as follows:

• Range Value Positions: Specifies whether index data is included that speeds up the performance of proximity queries involving range queries. Turn this index off if you are not interested in proximity queries and if you want to conserve disk space and decrease loading time.
• Parent Namespace URI: The namespace URI of the parent element.
• Parent Localname: The local name of the parent XML element or the name of the parent JSON property.
• Invalid Values: Specifies whether the server allows insertion of documents that contain XML elements or JSON properties on which range index is configured and their contents cannot be coerced to the index data type. It can be configured to either ignore or reject. By default server rejects insertion of such documents. However, if you set invalid values to ignore, these documents can be inserted. This setting does not change the behavior of queries on invalid values after documents are inserted in the database. Performing an operation on an invalid value at query time can still result in an error.
• Namespace URI: The namespace for an element or an attribute.
• Collation: The collation to use in the comparison operations.
• Scalar Type: The ordered domain for the index. Each of the types correspond with an XQuery type.
• Localname: The local name of an XML element or attribute, or the name of a JSON property.

For details, see Defining Attribute Range Indexes in the Administrator's Guide.

The range indexes on XML elements or JSON properties.

The fields are as follows:

• Range Value Positions: Specifies whether index data is included that speeds up the performance of proximity queries involving range queries. Turn this index off if you are not interested in proximity queries and if you want to conserve disk space and decrease loading time.
• Invalid Values: Specifies whether the server allows insertion of documents that contain XML elements or JSON properties on which range index is configured and their contents cannot be coerced to the index data type. It can be configured to either ignore or reject. By default server rejects insertion of such documents. However, if you set invalid values to ignore, these documents can be inserted. This setting does not change the behavior of queries on invalid values after documents are inserted in the database. Performing an operation on an invalid value at query time can still result in an error.
• Namespace URI: The namespace for an element or an attribute.
• Collation: The collation to use in the comparison operations.
• Scalar Type: The ordered domain for the index. Each of the types correspond with an XQuery type.
• Localname: The local name for an XML element or attribute, or the name for a JSON property.

For details, see Defining Element Range Indexes in the Administrator's Guide.

• facet-time: Range indexes are optimized to minimize the amount of CPU time used.
• memory-size: Range indexes are optimized to minimize the amount of memory used.

Specifies whether rebalancing are automatically performed in the background after configuration settings are changed. When set to true, the database rebalancer automatically redistributes the content across the database forests. When set to false, rebalancing is disabled.

For details, see Configuring the Rebalancer on a Database in the Administrator's Guide.

The priority of system resources devoted to rebalancing. Higher numbers give rebalancing a higher priority.

For details, see How the Rebalancer Moves Documents in the Administrator's Guide.

Specifies whether indexes are automatically rebuilt in the background after index configuration settings are changed. When set to true, index configuration changes automatically initiate a background reindexing operation on the entire database. When set to false, any new index settings take effect for future documents loaded into the database; existing documents retain the old settings until they are reloaded or until you set reindexer enable to true.

For details, see Understanding the Reindexer Enable Settings in the Administrator's Guide.

The priority of system resources devoted to reindexing. Reindexing occurs in batches, where each batch is approximately 200 fragments. When set to 5 (the default), the reindexer works aggressively, starting the next batch of reindexing soon after finishing the previous batch. When set to 4, it waits longer between batches, when set to 3 it waits longer still, and so on until when it is set to 1, when it waits the longest. Therefore, higher numbers give reindexing a higher priority and use the most system resources.

For details, see Understanding the Reindexer Enable Settings in the Administrator's Guide.

Specifies whether the deleted fragments are retained since the last full or incremental backup. When enabled, Retain Until Backup supersedes Merge Timestamp. Deleted fragments are not merged until backups are finished, regardless of the Merge Timestamp setting. Enabling Retain Until Backup is same to setting the Merge Timestamp to the timestamp of the last backup.

For more information, see Incremental Backup with Journal Archiving in the Administrator's Guide.

The number of forests used by the database to be retired.

For more information, see Retiring a Forest from the Database in the Administrator's Guide.

The security database used by the database.

For more information, see Overview of the Security Database in the Security Guide.

Specifies the term-frequency normalization. The values are described as follows:

• scaled-log: The default term-frequency normalization, which specifies the maximum scaling of the document based on document size.
• unscaled-log: No scaling based on document size.
• weakest-scaled-log, weakly-scaled-log, moderately-scaled-log, strongly-scaled-log: Increased degrees of scaling in between the least and the most scaling.

For more information, see Term Frequency Normalization in the Search Developer's Guide.

Specifies whether to enable wildcard searches where the search pattern contains three or more consecutive non-wildcard characters (for example, abc*x, *abc, a?bcd). When combined with a codepoint word lexicon, speeds the performance of any wildcard search (including searches with fewer than three consecutive non-wildcard characters). MarkLogic recommends combining the three character search index with a codepoint collation word lexicon.

For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.

Specifies whether index data is included in the database files to enable proximity searches (cts:near-query) within wildcard queries. You must also enable Three Character Searches to perform wildcard position searches. When set to true, positional searches are possible within a wildcard query, but document loading is slower and the database files are larger.

For details about wildcard searches, see Understanding the Wildcard Indexes in the Search Developer's Guide.

Specifies whether indexes are created to enable wildcard searches where the search pattern contains one or more consecutive non-wildcard characters at the beginning of the word, with the wildcard at the end of the word (for example, abc*). When this setting is true, character searches are faster, but document loading is slower and the database files are larger.

For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.

Specifies whether index data is included in the database files to enable proximity searches (cts:near-query) within trailing wildcard queries. You must also enable trailing wildcard searches to perform trailing wildcard position searches. When this setting is true, positional searches are possible within a trailing wildcard query, but document loading is slower and the database files are larger.

For details about wildcard searches, see Understanding the Wildcard Indexes in the Search Developer's Guide.

This feature requires a valid semantics license key.

Specifies whether index data is included which speeds up the performance of proximity queries that use the cts:triple-range-query function. Triple positions also improve the accuracy of the item-frequency option of cts:triples.

For details, see Triple Positions in the Semantics Developer's Guide.

Specifies whether to enable wildcard searches where the search pattern contains two or more consecutive non-wildcard characters (for example, ab*). This index is not needed if you have Three Character Searches and a word lexicon.

For details about wildcard searches, see Understanding and Using Wildcard Searches in the Search Developer's Guide.

Specifies whether to create a lexicon of all of the URIs used in a database. The URI lexicon speeds up queries that constrain on URIs. It is like a range index of all of the URIs in the database. To access values from the URI lexicon, use the cts:uris or cts:uri-match functions.

For details, see URI and Collection Lexicons in the Search Developer's Guide.

Specifies whether index data is included in the database files to enable proximity searches (cts:near-query). When set to true, positional searches are possible, but document loading is slower and the database files are larger.

For details, see Positions Indexes Can Help Speed Phrase Searches in the Query Performance and Tuning Guide.

Specifies whether index terms are included in the database files to support fast word searches. When this setting is true, word searches are faster, but document loading is slower and the database files are larger.

For details, see the Search Developer's Guide.

• minutely specifies how many minutes between each invocation of the module.
• hourly specifies how many hours and minutes between each invocation of the module.
• daily specifies how many days between each invocation of the module and the time of day (in 24:00 notation).
• weekly specifies how many weeks between each invocation of the module, check one or more days of the week, and the time of day (in 24:00 notation) for the task to start.
• monthly specifies how many months between each invocation of the module, select one day of the month (1-31), and the time of day (in 24:00 notation) for the task to start.
• one-time specifies the start date in MM/DD/YYYY notation (for example, 07/29/2009 for July 29, 2009) and time in 24:00 notation.

• normal specifies the task is queued with normal priority.
• higher specifies the task is queued with higher priority.

The default format for protocol errors for this server. The value can be:

• html: Errors formatted as HTML.
• xml: Errors formatted as XML.
• json: Errors formatted as JSON.
• compatible: Match as closely as possible the format used in prior releases for the type of request and error.

For more information, see set-error-format in the Application Developer's Guide.

• fast: Updates return as quickly as possible. No special timestamp notification messages are broadcasted to other hosts. Instead, timestamps are distributed to other hosts when any other message is sent. The maximum amount of time that could pass before other hosts see the timestamp is one second, because a heartbeat message is sent to other hosts every second.
• strict: Updates immediately broadcast timestamp notification messages to every other host in the group. Updates do not return until their timestamp has been distributed. This ensures timeliness of read-after-write query results from other hosts in the group, so requests made to this app server on other hosts in the group will see immediately consistent results.
• cluster: Updates immediately broadcast timestamp notification messages to every other host in the cluster. Updates do not return until their timestamp has been distributed. This ensures timeliness of read-after-write query results from any host in the cluster, so requests made to any app server on any host in the cluster will see immediately consistent results.

Specifies how the latest timestamp is chosen for lock-free queries. This only affects query statements, not update statements. The following are the possible values:

• contemporaneous: App Server chooses the latest timestamp for which any transaction is known to have committed, even though there still may be other transactions for that timestamp that have not yet fully committed. Queries will see more timely results, but may block waiting for contemporaneous transactions to fully commit.
• nonblocking: App Server chooses the latest timestamp for which all transactions are known to have committed, even though there may be a slightly later timestamp for which another transaction has committed. Queries won't block waiting for transactions, but they may see less timely results.

For details about queries and transactions in MarkLogic Server, see Understanding Transactions in MarkLogic Server in the Application Developer's Guide.

Output Byte Order Mark

Output Cdata Section Localname

Output Cdata Section Namespace URI

Output Doctype Public

Output Doctype System

Output Encoding

Output Escape URI Attributes

Output Include Content Type

Output Include Default Attributes

Output Indent

Output Indent Tabs

Output Indent Untyped

Output Media Type

Output Method

Output Normalization Form

Output Omit Xml Declaration

Output Sgml Character Entities

Output Standalone

Output Undeclare Prefixes

Output Version

The output options for the App Server.

For details about controlling App Server output, see Controlling App Server Access, Output, and Errors in the Application Developer's Guide and Setting Output Options for an HTTP Server, Setting Output Options for an XDBC Server, Setting Output Options for an ODBC Server, and Setting Output Options for a WebDAV Server in the Administrator's Guide.

For details on setting the serialization options in XQuery, see Declaring Options in the XQuery and XSLT Reference Guide. For XSLT output details, see the XSLT specification (http://www.w3.org/TR/xslt20#serialization).

The directory in which programs executed against this App Server are stored. If the Modules field is set to a database, the root must be a directory URI in the specified modules database.

If the Modules field is set to file system, the root directory is either a fully-qualified pathname or is relative to the directory in which MarkLogic Server is installed. For details on where the MarkLogic Server is installed by default on your platform, see Installing MarkLogic in the Installation Guide.