Real-time index

Real-time index is a main type of Manticore indexes. It allows adding, updating and deleting documents with immediate availability of the changes. Real-time index settings can be defined in a configuration file or online via CREATE/UPDATE/DELETE/ALTER commands.

Real-time index internally consists of one or multiple plain indexes called chunks. There can be:

• multiple disk chunks. They are stored on disk with the same structure as any plain index
• single ram chunk. Stored in memory and used as an accumulator of changes

RAM chunk size is controlled by rt_mem_limit. Once the limit is exceeded the RAM chunk is flushed to disk in a form of a disk chunk. When there are too many disk chunks they can be merged into one for better performance using command OPTIMIZE.

Creating a real-time index via SQL protocol:

CREATE TABLE products(title text, price float) morphology='stem_en';

Query OK, 0 rows affected (0.00 sec)

Creating a real-time index via JSON over HTTP:

POST /cli -d "CREATE TABLE products(title text, price float)  morphology='stem_en'"

{
"total":0,
"error":"",
"warning":""
}

Creating a real-time index via PHP client:

$index = new \Manticoresearch\Index($client);
$index->setName('products');
$index->create([
    'title'=>['type'=>'text'],
    'price'=>['type'=>'float'],
]);

Python:

utilsApi.sql('mode=raw&query=CREATE TABLE forum(title text, price float)')

Javascript:

res = await utilsApi.sql('mode=raw&query=CREATE TABLE forum(title text, price float)');

Java:

utilsApi.sql("mode=raw&query=CREATE TABLE forum(title text, price float)");

Creating a real-time index via a configuration file:

index products {
  type = rt
  path = idx
  rt_field = title
  rt_attr_uint = price
  stored_fields = title
}

👍 What you can do with a real-time index:

• Add documents
• Update attributes and full-text fields
• Delete documents
• Truncate index
• Change schema online with help of command ALTER
• Define index in a configuration file
• Use UUID for automatic ID provisioning

⛔ What you cannot do with a real-time index:

• Index data with help of indexer
• Link it with sources for easy indexing from external storages
• Update it’s killlist_target, it’s just not needed as the real-time index takes controls of it automatically

Real-time index files structure