Full-Text Search Commands

You can use the command line to perform the following actions on full-text search:

  • Creating Indexes
  • Updating Indexes

Creating Indexes

You can use the command line to create indexes on the full-text search server.
For DB distributed Garoon, run the command on the server where you want to administer queues.

Command

Execute commands in the FTS directory.

fts/full_index.csp
Parameters
Parameters Required item Description
number The input type of this argument is a string (one line).
Specify how many indexes a process creates at one time.
Specify 50 unless otherwise specified.
startTime   The input type of this argument is an integer.
Specify the time in 24-hour notation where you want to start indexing.
  • Minimum value: 0
  • Maximum value: 23
Set the time in the time zone that is set to the default value of the locale on the Garoon System Administration screen. For details, see Setting up a Default Locale.
StartTime and stopTime are specified in pair. The same value cannot be specified for startTime and stopTime.
stopTime   The input type of this argument is an integer.
Specify the time in 24-hour notation to stop indexing.
  • Minimum value: 0
  • Maximum value: 23
Set the time in the time zone that is set to the default value of the locale on the Garoon System Administration screen. For details, see Setting up a Default Locale.
StartTime and stopTime are specified in pair. The same value cannot be specified for startTime and stopTime.
Execution Example

Assuming the example setting below, the command usage is as follows:

  • Number of indexes created by the process at a time: 50
  • Start time: 20:00
  • End time: 8:00 on the next day

On Windows:

.\grn.exe -C -q code\command\fts\full_index.csp number=50 startTime=20 stopTime=8
On Linux:
./grn.cgi -C -q code/command/fts/full_index.csp number=50 startTime=20 stopTime=8

Updating Indexes

You can use the command line to update indexes on the full-text search server.
However, if you have executed "full_index.csp" to recreate indexes after the upgrade, you do not need to update indexes.
Index updates can be updated during business hours, because the load on Garoon is low.
For DB distributed Garoon, run the command on the server where you want to administer queues.

  • When to Update Indexes
    From the next version, if you upgrade Garoon to the latest version, it is recommended to update indexes after the upgrade.

    • Garoon 4.0.x
    • Garoon 4.2.0
    • Garoon 4.2.1
    • Garoon 4.2.2
      If you upgrade Garoon 4.2.3 or later to the latest version, you do not need to update indexes.

  • Messages Displayed after the Command Execution
    By executing the command, indexes of the data related to Messages and Spaces are updated. Messages that are displayed are as follows.

    • When indexes of the data related to Messages are updated:
      "Finish indexing of message data" is displayed. If you can search the data related to Messages, updating indexes has been completed.
    • When indexes of the data related to Spaces are updated:
      "Finish indexing of space data." is displayed. If you can search the data related to Spaces, updating indexes has been completed.
    • When updating indexes is not necessary:
      "No need to update index." is displayed.
Command

Execute commands in the FTS directory.

fts/update_index.csp
Parameters
Parameters Required item Description
exec Update indexes.
Execution Example

On Windows:

.\grn.exe -C -q code\command\fts\update_index.csp exec
On Linux:
./grn.cgi -C -q code/command/fts/update_index.csp exec