Global

Members

ReplicaAckPolicy :number

A replicated environment makes it possible to increase an application's transaction commit guarantees by committing changes to its replicas on the network. ReplicaAckPolicy defines the policy for how such network commits are handled.
Type:
  • number
Properties:
Name Type Description
ALL number All replicas must acknowledge that they have committed the transaction.
NONE number No transaction commit acknowledgments are required and the master will never wait for replica acknowledgments.
SIMPLE_MAJORITY number A simple majority of replicas must acknowledge that they have committed the transaction.
Source:

ReturnChoice :number

Specifies whether to return the row value, version, both or neither. For best performance, it is important to choose only the properties that are required. The store is optimized to avoid I/O when the requested properties are in cache.
Type:
  • number
Properties:
Name Type Description
ALL number Return both the value and the version.
NONE number Do not return the value or the version.
VALUE number Return the value only.
VERSION number Return the version only.
Source:

SimpleConsistency :number

Used to provide consistency guarantees for read operations. In general, read operations may be serviced either at a Master or Replica node. When serviced at the Master node, consistency is always absolute. If absolute consistency is required, ABSOLUTE may be specified to force the operation to be serviced at the Master. For other types of consistency, when the operation is serviced at a Replica node, the transaction will not begin until the consistency policy is satisfied. The Consistency is specified as an argument to all read operations, for example, get.
Type:
  • number
Properties:
Name Type Description
ABSOLUTE number A consistency policy that requires that a transaction be serviced on the Master so that consistency is absolute.
NONE_REQUIRED number A consistency policy that lets a transaction on a replica using this policy proceed regardless of the state of the Replica relative to the Master.
NONE_REQUIRED_NO_MASTER number A consistency policy that requires that a read operation be serviced on a replica; never the Master.
Source:

SyncPolicy :number

Defines the synchronization policy to be used when committing a transaction. High levels of synchronization offer a greater guarantee that the transaction is persistent to disk, but trade that off for lower performance.
Type:
  • number
Properties:
Name Type Description
NO_SYNC number Do not write or synchronously flush the log on transaction commit.
SYNC number Write and synchronously flush the log on transaction commit.
WRITE_NO_SYNC number Write but do not synchronously flush the log on transaction commit.
Source:

Methods

readProxyConfiguration(filename) → {ProxyConfiguration}

Tries to read a file with a ProxyConfiguration object
Parameters:
Name Type Description
filename string the full path for the file
Source:
Returns:
Type
ProxyConfiguration

startProxy(proxyConfiguration, callback)

starts a proxy with the given configuration
Parameters:
Name Type Description
proxyConfiguration ProxyConfiguration the configuration used to start the proxy
callback function function called after the proxy is started
Source:

stopProxy(proxyConfiguration, callback)

Shutdown the proxy. If a proxy was started, this method will shutdown it.
Parameters:
Name Type Description
proxyConfiguration ProxyConfiguration the configuration used to start the proxy
callback function function called after trying to shutdown the proxy
Source: