Clustering
Last updated
4.5
Last updated
The following operations are available for configuring and managing .\
If you are using NATS for clustering, please see the documentation.
Adds a new Harper instance to the cluster. If subscriptions are provided, it will also create the replication relationships between the nodes. If they are not provided a fully replicating system will be created. .
Operation is restricted to super_user roles only
operation (required) - must always be add_node
hostname or url (required) - one of these fields is required. You must provide either the hostname or the url of the node you want to add
verify_tls (optional) - a boolean which determines if the TLS certificate should be verified. This will allow the Harper default self-signed certificates to be accepted. Defaults to true
authorization (optional) - an object or a string which contains the authorization information for the node being added. If it is an object, it should contain username and password fields. If it is a string, it should use HTTP Authorization style credentials
retain_authorization (optional) - a boolean which determines if the authorization credentials should be retained/stored and used everytime a connection is made to this node. If true, the authorization will be stored on the node record. Generally this should not be used, as mTLS/certificate based authorization is much more secure and safe, and avoids the need for storing credentials. Defaults to false.
revoked_certificates (optional) - an array of revoked certificates serial numbers. If a certificate is revoked, it will not be accepted for any connections.
shard (optional) - a number which can be used to indicate which shard this node belongs to. This is only needed if you are using sharding.
subscriptions (optional) - The relationship created between nodes. If not provided a fully replicated cluster will be setup. Must be an object array and include database, table, subscribe and publish:
database - the database to replicate
table - the table to replicate
subscribe - a boolean which determines if transactions on the remote table should be replicated on the local table
publish - a boolean which determines if transactions on the local table should be replicated on the remote table
Modifies an existing Harper instance in the cluster.
Operation is restricted to super_user roles only
Note: will attempt to add the node if it does not exist
operation (required) - must always be update_node
hostname (required) - the hostname of the remote node you are updating
revoked_certificates (optional) - an array of revoked certificates serial numbers. If a certificate is revoked, it will not be accepted for any connections.
shard (optional) - a number which can be used to indicate which shard this node belongs to. This is only needed if you are using sharding.
subscriptions (required) - The relationship created between nodes. Must be an object array and include database, table, subscribe and publish:
database - the database to replicate from
table - the table to replicate from
subscribe - a boolean which determines if transactions on the remote table should be replicated on the local table
publish - a boolean which determines if transactions on the local table should be replicated on the remote table
Operation is restricted to super_user roles only
operation (required) - must always be remove_node
name (required) - The name of the node you are removing
Returns an array of status objects from a cluster.
database_sockets shows the actual websocket connections that exist between nodes.
Operation is restricted to super_user roles only
operation (required) - must always be cluster_status
There is a separate socket for each database for each node. Each node is represented in the connections array, and each database connection to that node is represented in the database_sockets array. Additional timing statistics include:
lastCommitConfirmed: When a commit is sent out, it should receive a confirmation from the remote server; this is the last receipt of confirmation of an outgoing commit.
lastReceivedRemoteTime: This is the timestamp of the transaction that was last received. The timestamp is from when the original transaction occurred.
lastReceivedLocalTime: This is local time when the last transaction was received. If there is a different between this and lastReceivedRemoteTime, it means there is a delay from the original transaction to * receiving it and so it is probably catching-up/behind.
sendingMessage: The timestamp of transaction is actively being sent. This won't exist if the replicator is waiting for the next transaction to send.
Bulk create/remove subscriptions for any number of remote nodes. Resets and replaces any existing clustering setup.
Operation is restricted to super_user roles only
operation (required) - must always be configure_cluster
connections (required) - must be an object array with each object following the add_node schema.
Adds a route/routes to the replication.routes configuration. This operation behaves as a PATCH/upsert, meaning it will add new routes to the configuration while leaving existing routes untouched.
Operation is restricted to super_user roles only
operation (required) - must always be cluster_set_routes
routes (required) - the routes field is an array that specifies the routes for clustering. Each element in the array can be either a string or an object with hostname and port properties.
Gets the replication routes from the Harper config file.
Operation is restricted to super_user roles only
operation (required) - must always be cluster_get_routes
Removes route(s) from the Harper config file. Returns a deletion success message and arrays of deleted and skipped records.
Operation is restricted to super_user roles only
operation (required) - must always be cluster_delete_routes
routes required - Must be an array of route object(s)
Removes a Harper node from the cluster and stops replication, .