SatelliteCollections

SatelliteCollections are only available in the Enterprise Edition, including ArangoDB Oasis.

When doing joins in an ArangoDB cluster data has to be exchanged between different servers.

Joins will be executed on a Coordinator. It will prepare an execution plan and execute it. When executing, the Coordinator will contact all shards of the starting point of the join and ask for their data. The DB-Servers carrying out this operation will load all their local data and then ask the cluster for the other part of the join. This again will be distributed to all involved shards of this join part.

In sum this results in much network traffic and slow results depending of the amount of data that has to be sent throughout the cluster.

SatelliteCollections are collections that are intended to address this issue.

They will facilitate the synchronous replication and replicate all its data to all DB-Servers that are part of the cluster.

This enables the DB-Servers to execute that part of any join locally.

This greatly improves performance for such joins at the costs of increased storage requirements and poorer write performance on this data.

To create a SatelliteCollection set the replicationFactor of this collection to “satellite”.

Using arangosh:

  1. arangosh> db._create("satellite", {"replicationFactor": "satellite"});

A full example

  1. arangosh> var explain = require("@arangodb/aql/explainer").explain
  2. arangosh> db._create("satellite", {"replicationFactor": "satellite"})
  3. arangosh> db._create("nonsatellite", {numberOfShards: 8})
  4. arangosh> db._create("nonsatellite2", {numberOfShards: 8})

Let’s analyse a normal join not involving SatelliteCollections:

  1. arangosh> explain("FOR doc in nonsatellite FOR doc2 in nonsatellite2 RETURN 1")
  3. Query string:
  4.  FOR doc in nonsatellite FOR doc2 in nonsatellite2 RETURN 1
  6. Execution plan:
  7.  Id   NodeType                  Site       Est.   Comment
  8.   1   SingletonNode             DBS           1   * ROOT
  9.   4   CalculationNode           DBS           1     - LET #2 = 1   /* json expression */   /* const assignment */
  10.   2   EnumerateCollectionNode   DBS           0     - FOR doc IN nonsatellite   /* full collection scan */
  11.  12   RemoteNode                COOR          0       - REMOTE
  12.  13   GatherNode                COOR          0       - GATHER
  13.   6   ScatterNode               COOR          0       - SCATTER
  14.   7   RemoteNode                DBS           0       - REMOTE
  15.   3   EnumerateCollectionNode   DBS           0       - FOR doc2 IN nonsatellite2   /* full collection scan */
  16.   8   RemoteNode                COOR          0         - REMOTE
  17.   9   GatherNode                COOR          0         - GATHER
  18.   5   ReturnNode                COOR          0         - RETURN #2
  20. Indexes used:
  21.  none
  23. Optimization rules applied:
  24.  Id   RuleName
  25.   1   move-calculations-up
  26.   2   scatter-in-cluster
  27.   3   remove-unnecessary-remote-scatter

All shards involved querying the nonsatellite collection will fan out via the Coordinator to the shards of nonsatellite. In sum 8 shards will open 8 connections to the Coordinator asking for the results of the nonsatellite2 join. The Coordinator will fan out to the 8 shards of nonsatellite2. So there will be quite some network traffic.

Let’s now have a look at the same using SatelliteCollections:

  1. arangosh> db._query("FOR doc in nonsatellite FOR doc2 in satellite RETURN 1")
  3. Query string:
  4.  FOR doc in nonsatellite FOR doc2 in satellite RETURN 1
  6. Execution plan:
  7.  Id   NodeType                  Site       Est.   Comment
  8.   1   SingletonNode             DBS           1   * ROOT
  9.   4   CalculationNode           DBS           1     - LET #2 = 1   /* json expression */   /* const assignment */
  10.   2   EnumerateCollectionNode   DBS           0     - FOR doc IN nonsatellite   /* full collection scan */
  11.   3   EnumerateCollectionNode   DBS           0       - FOR doc2 IN satellite   /* full collection scan, satellite */
  12.   8   RemoteNode                COOR          0         - REMOTE
  13.   9   GatherNode                COOR          0         - GATHER
  14.   5   ReturnNode                COOR          0         - RETURN #2
  16. Indexes used:
  17.  none
  19. Optimization rules applied:
  20.  Id   RuleName
  21.   1   move-calculations-up
  22.   2   scatter-in-cluster
  23.   3   remove-unnecessary-remote-scatter
  24.   4   remove-satellite-joins

In this scenario all shards of nonsatellite will be contacted. However as the join is a satellite join all shards can do the join locally as the data is replicated to all servers reducing the network overhead dramatically.

Caveats

The cluster will automatically keep all SatelliteCollections on all servers in sync by facilitating the synchronous replication. This means that write will be executed on the leader only and this server will coordinate replication to the followers. If a follower doesn’t answer in time (due to network problems, temporary shutdown etc.) it may be removed as a follower. This is being reported to the Agency.

The follower (once back in business) will then periodically check the Agency and know that it is out of sync. It will then automatically catch up. This may take a while depending on how much data has to be synced. When doing a join involving the satellite you can specify how long the DB-Server is allowed to wait for sync until the query is being aborted.

Check Accessing Cursors for details.

During network failure there is also a minimal chance that a query was properly distributed to the DB-Servers but that a previous satellite write could not be replicated to a follower and the leader dropped the follower. The follower however only checks every few seconds if it is really in sync so it might indeed deliver stale results.