Creating an index > Creating a distributed index > Creating a local distributed index

Manticore supports distributed indexes. They look like usual plain or real-time indexes, but internally they are just a 'proxy', or named collection of another child indexes used for actual searching. When a query is directed at such index, it is distributed among all indexes in the collection. Server collects responses of the queries and processes them as necessary:

applies sorting
recalculates final values of aggregates, etc

From the client's standpoint it looks transparent, as if you just queried any single index.

Distributed indexes can be composed from any other indexes fitting your requirements

local storage indexes (plain index, Real-Time)
remote indexes
combined local storage and remote indexes
percolate indexes (local, remote and combinations)
single local and several remotes or any other combinations

Nesting distributed indexes is supported by declaring them with agent (even if they are on the same machine). Distributed indexes cannot be declared with local and they will be ignored.

Percolate and template indexes should not be mixed with plain and/or RT indexes.

Distributed index is defined by type 'distributed' in the configuration file or via SQL clause CREATE TABLE

index foo {
    type = distributed
    local = bar
    local = bar1, bar2
    agent = 127.0.0.1:9312:baz
    agent = host1|host2:idx
    agent = host1:9301:idx1|host2:idx2 [ha_strategy=random retry_count=10]
    ...
}

CREATE TABLE distributed_index type='distributed' local='local_index' agent='127.0.0.1:9312:remote_index'

Either way the key component of a distributed index is a list of children (the indexes it points to).

Lines, starting with local = enumerate local indexes, served in the same server. Several local indexes may be written as several local = lines, or combined into one list, separated by commas.
Lines, starting with agent = enumerate remote indexes, served anywhere. Each line represents one agent, or endpoint.

Each agent can include several external locations and options specifying how to work with them.

Note, that for remotes the server knows nothing about the type of the index, and it may cause errors, if, say, you issue CALL PQ to remote 'foo' which is not a percolate index.

Creating a local distributed index

A distributed index in Manticore Search doesn't hold any data. Instead it acts as a 'master node' to proxy the demanded query to other indexes and provide merged results from the responses it receives from the 'node' indexes. A distributed index can connect to local indexes or indexes located on other servers. The simplest example of a distributed index looks so:

‹›

Configuration file
RT mode
PHP
Python
javascript
Java

📋

index index_dist {
  type  = distributed
  local = index1
  local = index2
  ...
 }

CREATE TABLE local_dist type='distributed' local='index1' local='index2';

$params = [
    'body' => [
        'settings' => [
            'type' => 'distributed',
            'local' => [
                'index1',
                'index2'
            ]
        ]
    ],
    'index' => 'products'
];
$index = new \Manticoresearch\Index($client);
$index->create($params);

utilsApi.sql('mode=raw&query=CREATE TABLE local_dist type=\'distributed\' local=\'index1\' local=\'index2\'')

res = await utilsApi.sql('mode=raw&query=CREATE TABLE local_dist type=\'distributed\' local=\'index1\' local=\'index2\'');

utilsApi.sql("mode=raw&query=CREATE TABLE local_dist type='distributed' local='index1' local='index2'");

Creating a distributed index Remote indexes

Creating a distributed index

In a configuration file

Via SQL

Children

Creating a local distributed index