Creating a cluster > Setting up replication > Deleting a replication cluster

To create a replication cluster you should set at least its name.

In case of a single cluster or if the cluster you are creating is the first one path option may be omitted, in this case data_dir option will be used as the cluster path. For all subsequent clusters you need to specify path and this path should be available. nodes option may be also set to enumerate all the nodes in the cluster.

‹›

SQL
HTTP
PHP
Python
javascript
Java

📋

CREATE CLUSTER posts
CREATE CLUSTER click_query '/var/data/click_query/' as path
CREATE CLUSTER click_query '/var/data/click_query/' as path, 'clicks_mirror1:9312,clicks_mirror2:9312,clicks_mirror3:9312' as nodes

POST /sql -d "mode=raw&query=
CREATE CLUSTER posts
"
POST /sql -d "mode=raw&query=
CREATE CLUSTER click_query '/var/data/click_query/' as path
"
POST /sql -d "mode=raw&query=
CREATE CLUSTER click_query '/var/data/click_query/' as path, 'clicks_mirror1:9312,clicks_mirror2:9312,clicks_mirror3:9312' as nodes
"

$params = [
    'cluster' => 'posts',
    ]
];
$response = $client->cluster()->create($params);
$params = [
    'cluster' => 'click_query',
    'body' => [
        'path' => '/var/data/click_query/'
    ]    
    ]
];
$response = $client->cluster()->create($params);
$params = [
    'cluster' => 'click_query',
    'body' => [
        'path' => '/var/data/click_query/',
        'nodes' => 'clicks_mirror1:9312,clicks_mirror2:9312,clicks_mirror3:9312'
    ]    
    ]
];
$response = $client->cluster()->create($params);

utilsApi.sql('mode=raw&query=CREATE CLUSTER posts')
utilsApi.sql('mode=raw&query=CREATE CLUSTER click_query \'/var/data/click_query/\' as path')
utilsApi.sql('mode=raw&query=CREATE CLUSTER click_query \'/var/data/click_query/\' as path, \'clicks_mirror1:9312,clicks_mirror2:9312,clicks_mirror3:9312\' as nodes')

res = await utilsApi.sql('mode=raw&query=CREATE CLUSTER posts');
res = await utilsApi.sql('mode=raw&query=CREATE CLUSTER click_query \'/var/data/click_query/\' as path');
res = await utilsApi.sql('mode=raw&query=CREATE CLUSTER click_query \'/var/data/click_query/\' as path, \'clicks_mirror1:9312,clicks_mirror2:9312,clicks_mirror3:9312\' as nodes');

utilsApi.sql("mode=raw&query=CREATE CLUSTER posts");
utilsApi.sql("mode=raw&query=CREATE CLUSTER click_query '/var/data/click_query/' as path");
utilsApi.sql("mode=raw&query=CREATE CLUSTER click_query '/var/data/click_query/' as path, 'clicks_mirror1:9312,clicks_mirror2:9312,clicks_mirror3:9312' as nodes");

‹›

Response

{u'error': u'', u'total': 0, u'warning': u''}

If a cluster is created without the nodes option, the first node that gets joined to the cluster will be saved as nodes.

Joining a replication cluster

To join an existing cluster name and any working node should be set. In case of a single cluster path might be omitted, data_dir will be used as the cluster path. For all subsequent clusters path needs to be set and it should be available.

‹›

SQL
HTTP
PHP
Python
javascript
Java

📋

JOIN CLUSTER posts AT '10.12.1.35:9312'

POST /sql -d "mode=raw&query=
JOIN CLUSTER posts AT '10.12.1.35:9312'
"

$params = [
  'cluster' => 'posts',
  'body' => [
      '10.12.1.35:9312'
  ]
];
$response = $client->cluster->join($params);

utilsApi.sql('mode=raw&query=JOIN CLUSTER posts AT \'10.12.1.35:9312\'')

res = await utilsApi.sql('mode=raw&query=JOIN CLUSTER posts AT \'10.12.1.35:9312\'');

utilsApi.sql("mode=raw&query=JOIN CLUSTER posts AT '10.12.1.35:9312'");

‹›

Response

{u'error': u'', u'total': 0, u'warning': u''}

A node joins a cluster by getting the data from the node provided and, if successful, it updates node lists in all the other cluster nodes similar to ALTER CLUSTER ... UPDATE nodes. This list is used to rejoin nodes to the cluster on restart.

There are two lists of nodes. One is used to rejoin nodes to the cluster on restart, it is updated across all nodes same way as ALTER CLUSTER ... UPDATE nodes does. JOIN CLUSTER does the same update automatically. Cluster status shows this list as cluster_post_nodes_set. The second list is a list of all active nodes used for replication. This list doesn't require manual management. ALTER CLUSTER ... UPDATE nodes actually copies this list of nodes to the list of nodes used to rejoin on restart. Cluster status shows this list as cluster_post_nodes_view.

When nodes are located at different network segments or in different datacenters nodes option may be set explicitly. That allows to minimize traffic between nodes and to use gateway nodes for datacenters intercommunication. The following command joins an existing cluster using the nodes option.

Note: that when this syntax is used, cluster_post_nodes_set list is not updated automatically. Use ALTER CLUSTER ... UPDATE nodes to update it.

‹›

SQL
HTTP
PHP
Python
javascript
Java

📋

JOIN CLUSTER click_query 'clicks_mirror1:9312;clicks_mirror2:9312;clicks_mirror3:9312' as nodes

POST /sql -d "mode=raw&query=
JOIN CLUSTER click_query 'clicks_mirror1:9312;clicks_mirror2:9312;clicks_mirror3:9312' as nodes
"

$params = [
  'cluster' => 'posts',
  'body' => [
      'nodes' => 'clicks_mirror1:9312;clicks_mirror2:9312;clicks_mirror3:9312'
  ]
];
$response = $client->cluster->join($params);

utilsApi.sql('mode=raw&query=JOIN CLUSTER click_query \'clicks_mirror1:9312;clicks_mirror2:9312;clicks_mirror3:9312\' as nodes')

res = await utilsApi.sql('mode=raw&query=JOIN CLUSTER click_query \'clicks_mirror1:9312;clicks_mirror2:9312;clicks_mirror3:9312\' as nodes');

utilsApi.sql("mode=raw&query=JOIN CLUSTER click_query 'clicks_mirror1:9312;clicks_mirror2:9312;clicks_mirror3:9312' as nodes");

‹›

Response

{u'error': u'', u'total': 0, u'warning': u''}

JOIN CLUSTER completes when a node receives all the necessary data to be in sync with all the other nodes in the cluster.

Creating a replication cluster Deleting a replication cluster

Delete statement removes a cluster specified with name. The cluster gets removed from all the nodes, but its indexes are left intact and become active local non-replicated indexes.

‹›

SQL
HTTP
PHP
Python
javascript
Java

📋

DELETE CLUSTER click_query

POST /sql -d "mode=raw&query=DELETE CLUSTER click_query"

$params = [
    'cluster' => 'click_query',
    'body' => []
];
$response = $client->cluster()->delete($params);

utilsApi.sql('mode=raw&query=DELETE CLUSTER click_query')

res = await utilsApi.sql('mode=raw&query=DELETE CLUSTER click_query');

utilsApi.sql("mode=raw&query=DELETE CLUSTER click_query");

‹›

Response

{u'error': u'', u'total': 0, u'warning': u''}

Joining a replication cluster Adding and removing an index from a replication cluster

ALTER CLUSTER <cluster_name> ADD <index_name> adds an existing local index to the cluster. The node which receives the ALTER query sends the index to the other nodes in the cluster. All the local indexes with the same name on the other nodes of the cluster get replaced with the new index.

After the index is replicated, write statements can be performed on any node but index name must be prefixed with the cluster name like INSERT INTO <clusterName>:<indexName>.

‹›

SQL
HTTP
PHP
Python
javascript
Java

📋

ALTER CLUSTER click_query ADD clicks_daily_index

POST /sql -d "mode=raw&query=
ALTER CLUSTER click_query ADD clicks_daily_index
"

$params = [
  'cluster' => 'click_query',
  'body' => [
     'operation' => 'add',
     'index' => 'clicks_daily_index'

  ]
];
$response = $client->cluster()->alter($params);

utilsApi.sql('mode=raw&query=ALTER CLUSTER click_query ADD clicks_daily_index')

res = await utilsApi.sql('mode=raw&query=ALTER CLUSTER click_query ADD clicks_daily_index');

utilsApi.sql("mode=raw&query=ALTER CLUSTER click_query ADD clicks_daily_index");

‹›

Response

{u'error': u'', u'total': 0, u'warning': u''}

ALTER CLUSTER <cluster_name> DROP <index_name> forgets about a local index, i.e., it doesn't remove the index files on the nodes but just makes it an active non-replicated index.

After an index is removed from a cluster, it becomes a 'local' index and write statements must use just the index name as INSERT INTO <indexName>, without the cluster prefix.

‹›

SQL
HTTP
PHP
Python
javascript
Java

📋

ALTER CLUSTER posts DROP weekly_index

POST /sql -d "mode=raw&query=
ALTER CLUSTER posts DROP weekly_index
"

$params = [
  'cluster' => 'posts',
  'body' => [
     'operation' => 'drop',
     'index' => 'weekly_index'

  ]
];
$response = $client->cluster->alter($params);

utilsApi.sql('mode=raw&query=ALTER CLUSTER posts DROP weekly_index')

res = await utilsApi.sql('mode=raw&query=ALTER CLUSTER posts DROP weekly_index');

utilsApi.sql("mode=raw&query=ALTER CLUSTER posts DROP weekly_index");

‹›

Response

{u'error': u'', u'total': 0, u'warning': u''}

Deleting a replication cluster Managing replication nodes