Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Node.js Driver. Switch to the latest stable version.
LoadBalancingPolicy¶
policies/loadBalancing~LoadBalancingPolicy()
Base class for Load Balancing Policies
Constructor¶
new LoadBalancingPolicy()
Methods¶
getDistance(host)
Returns the distance assigned by this policy to the provided host.
Parameters:
| Name | Type | Description |
|---|---|---|
host |
Host |
getOptions()
Gets an associative array containing the policy options.
init(client, hosts, callback)
Initializes the load balancing policy, called after the driver obtained the information of the cluster.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
Client | |
hosts |
HostMap | |
callback |
function |
newQueryPlan(keyspace, executionOptions, callback)
Returns an iterator with the hosts for a new query. Each new query will call this method. The first host in the result will then be used to perform the query.
Parameters:
| Name | Type | Description |
|---|---|---|
keyspace |
String | Name of currently logged keyspace at |
executionOptions |
ExecutionOptions | null | The information related to the execution of the request. |
callback |
function | The function to be invoked with the error as first parameter and the host iterator as second parameter. |