Node fulltext index

Required Permission: Settings management (Read more about Permissions)

Table of Contents

Data in Graphlytic are indexed. You can select which node properties are indexed in fulltext index. You have to have at least one valid DB property defined in propertiesFullText in order to Graphlytic work properly, mainly the search functions.

  1. Main menu (top right) - Page Settings

  2. See panel "Node fulltext index"

Panel contains information:

  • Reindex status: POPULATING, ONLINE, ERROR, REINDEX_REQUIRED

  • Progress: progress of reindexing

  • Indexed properties: list of node properties which will be indexed

  • Use all labels: all currently existing node labels will be used in next reindexing

  • Indexed labels: choose the list of node labels that will be used in next reindexing

Start reindex

Indexing of all nodes can take a while. It depends on the number of indexed nodes and the number of indexed properties. Use the "Node Fulltext Search Settings" widget's "Start reindex" button to start the reindexing and to view the progress of indexing.

Stop indexing

It is useful if reindex takes long time and you forget to change some data or you make incorrect configuration of indexer.

  1. Press button "Stop indexing" to interrupt current running reindex (it will drop the index in DB).

  2. Reindex is interrupted and the index is dropped.

Drop index

Press the "Drop index" button to drop the fulltext index in DB. The fulltext search on Search & Manage Data page and in Visualization will stop working. This is a global change and all users of the system will be affected.

Configuration

There are two options how to configure the Fulltext index:

  1. With JSON setting (more info is in the next chapter)

  2. With the user interface - use the Node Fulltext Search Settings for changing the search or fulltext index options. More info about the user interface can be found here: Search Settings

Fulltext Index configuration with the JSON setting

  • upload the JSON file with the setting via the drag&drop area or

  • manually change the JSON data:

    1. Use the Application Settings widget and click on the "Update setting" button in the "FULLTEXT_INDEX" row of the table.

    2. Enter the setting JSON in the modal window.

    3. Confirm by clicking on the Save button.

    4. If the configuration is different then the currently used one the reindex is needed ("Start reindex" button).

It is strictly recommended to reindex the database with the new configuration every time the configuration is changed.

Configuration is entered in JSON format. Example:

{
"tokens":[
"Person",
"Company",
"Contract"
],
"properties":[
"name",
"address",
"email"
]
}

Explanation of JSON properties:

Property

Values

Default

Description

Usage

tokens

MANDATORY

Array of strings

List of node labels. Only nodes with at least one of these labels will be indexed.

Search Page, Visualization

properties

MANDATORY

Array of strings

List of DB properties of nodes, that will be indexed and used for fulltext search. Property value is normalized and transformed to lower case before insert into index. Normalization means NFD normalization with removing not ASCII characters.

Search Page, Visualization

Explanation of automatic configuration:

Automatic configuration is used to generate configuration which contains properties of several random data nodes. Random nodes are selected as first 1000 nodes.