How to use the dsindextool command

dsindextool

Note: This command applies to DocuShare 7.5 installations that are running Solr.

Syntax: dsindextool [options] (index_all | index | verify | stop)

The dsindextool command allows the administrator to compress, cleanup, and re-index the DocuShare search database. This tool is the replacement for dsindex, and while it works the same as dsindex, some of the operations have discontinued. These operations include but not limited to -optType, optimize, and max_clean.

The tool is in the {DSHOME}/bin directory.

Caution: While dsindextool is running, the accuracy of any ongoing searches may be affected.

Options for dsindextool

-c <chunksize>                          Chunk size. The number of handles per batch. Applies only to dsindextool index_all.

-classname <classname>          To reindex all objects of a specified classname; used with the index operation.

Example: dsindextool -classname Document index

-collection <collection handle>   Indexes all the children document objects in the specified Collection handle (applies only to index).

-count <number>                       The number of objects in the same class to index; Zero (0) will index all objects in the class.

-continue                                   After the interruption of a running dsindextool command; restart the command and pick up from where it stopped.

Example: dsindextool -continue index_all

-h                                             Help. Display available usage information for the command. Syntax would be dsindextool -h

-handles <”handles”>                 To reindex a specified list of handles separated by commas and enclosed in double quotes; used with the index and recover operation.

Example: dsindextool -handles "Document-11, Document-22, Collection-15" index

-l                                              Level. Write the specified level (debug, trace, info, warn, error, fatal) message to the log file.

-q                                             Quiet. Run the command in quiet mode. Suppresses all informational messages and user yes/no prompts. Assume Yes

-reindexSince <MM/dd/yyyy>    Re-indexes objects since the specified date.

-reindexSince <MM/dd/yyyy> or Re-indexes objects with modified or creation date between the two dates <MM/dd/yyyy>-<MM/dd/yyyy>   specified in the option; at or after the first date (<fromdate>inclusive) and

before the last date (<todate>exclusive).

-start <number>                         Starting index number of the object in the same class.

-startingHandle <handle>           (optional) Specifies the starting handle for continuing an index_all operation. startingHandle must be in the format Classname-index (i.e. Document-123); example: dsindextool.bat -startingHandle Collection-14 index_all

Stop                                         Used to stop a running dsindextool operation. Usage: dsindextool [options] (index_all | index | stop)

Use -continue option to continue index_all.

-threads <number>                    Tells index_all to create new additional threads to create/use for indexing on startup rather than the ones set up in Fulltextindex to handle the events coming in. This allows for multithreading for indexing for larger sites. This threading command is specific for indexing and not the server itself. The default is to use the thread pool already created in FulltextIndex to do index-all. In most cases, default is enough.

For example: dsindextool -threads 8 index_all runs with 8 threads to index all the documents into DocuShare

Verify                                       Verifies that the objects in the database are consistent with the indexed objects in Solr. This uses multithreading.

-metadataOnly                           Index metadata only. Content is not indexed. This can be verified by using the option with verify.

-deletedOnly                             Deleted objects are not indexed. This can be verified by using the option with verify.

Operations for dsindextool

-fsizemax <number>      Specifies the maximum file size (in bytes) for a Document object for content indexing. (Exclusive)

-fsizemin <number>       Specifies the minimum file size (in bytes) for a Document object for content indexing. (Inclusive)

Example: dsindextool -fsizemin 1000000 -fsizemax 5000000 index_all

This example indexes ALL DocuShare objects, but only those Document objects with file sizes greater than or equal to 1 million OR less than 5 million have content indexed; the rest of the objects have only metadata indexed.

Index                            Indexes the specified classname with the object class name, a specified list of handles, or by collection into Solr. Used with options: -classname or -handles. This also can be used with -reindexSince to index based on a date range.

index_all                       Enumerates all objects in the database, a class at a time, then indexes them in chunks.

Example using dsindextool

dsindextool -reindexSince 05/01/2014-05/30/2014 index_all — re-indexes all objects with modified/create date at or after 05/01/2014 (inclusive) and before 05/30/2014 (exclusive).

Solution Published: December 16, 2020

Solution ID: 2086