Reference Information: MQL Indexing Commands

The following table lists the commands used to start and monitor an indexing process.

The file indexing queue is backed by a persistent, file-based queue that represents the pending jobs in the queue. This affects the MQL calls start, status, clear, and stop. For details on how the file-based queue affects a call, see the description of this specific call.

This page discusses:

MQL Commands

MQL Command Description
set system searchindex file CONFIGFILE_PATH_AND_NAME force; Applies the config.xml file to your database. For more information, see Applying Configuration.
start searchindex mode FULL; Starts a baseline indexing process. If there are files to index, they are submitted to the persistent queue. This command polls all the FCS servers in the topology that are alive, to see if they still have data in the queue and if so, waits. When there are no more jobs in the queue, the MQL process stops the thread that fetches data from the persistent queue on the remove FCS server. For more information, see Baseline Indexing Process.
start searchindex mode PARTIAL; Starts a partial indexing process. For more information, see Partial Indexing Process.
start searchindex mode PARTIAL modified DATE; Starts a partial indexing process for objects that have a modified timestamp greater than or equal to the specified DATE parameter. To know the DATE format,run: 
MQL> print system inivar MX_NORMAL_DATETIME_FORMAT;

MX_NORMAL_DATETIME_FORMAT is usually moy/dom/yr4 h12:min:sec mer

Example: "5/6/2018 9:25:36 AM"
resume searchindex; Resumes the indexing process. It is useful after a crash to avoid recrawling everything once again. For more information, see Resume Indexing After Failure.
status searchindex; Checks the status of an indexing process. This command polls each FCS server that it can reach to see if there is a persistent queue and if so, reports details of that queue including its directory.
Note: The output includes the start time and duration of the indexing process. For example: 
MQL<4>status searchindex;
 test: Complete last indexed: 08/23/2018 20:48:06 number of objects: 1 start: 9/9/2018 5:33:10 PM duration: 7 seconds
For more information, see Verifying the Indexing Status.
modify searchindex modified DATE [vault VAULT]; Updates the last-modified timestamp to set where to start the next partial indexing operation.
Note: The input to the modify searchindex command is interpreted as Greenwich Mean Time (GMT). This is compared to the now timestamp, and the earlier of the two is used.
clear searchindex; Clears an index from the CloudView server. This command clears the persistent queue on each FCS server that it can reach. For more information, see Clearing the Index.
help searchindex Shows the Help for all the indexing commands.
print system searchindex; Prints the config.xml stored in the database.

Directory Structure for File-Based Indexing Queue

The FCS server keeps the file-based indexing queue in a generated directory, based on the workspace directory using the call:

com.matrixone.fcs.common.Resources.getWorkspaceRoot() + "FILE_INDEXING/JOBS/*"

This directory is generated using the ematrix.fcs.workSpaceDir FCS property, or if it does not exist, the java system call System.getProperty("java.io.tmpdir"). The MQL indexing commands interact with this directory structure.

The status searchindex command reports the directory for each FCS server that it can contact.