RemovePolicy

RemovePolicy

A policy affecting the behavior of remove operations.

Constructor

new RemovePolicy(propsopt)

Description:
  • Initializes a new RemovePolicy from the provided policy values.

Source:
Since:
  • v3.0.0
Parameters:
Name Type Attributes Description
props Object <optional>

Policy values

Extends

Members

commitLevel :number

Description:
  • Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Source:
See:

Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Type:
  • number

commitLevel :number

Description:
  • Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Source:
See:

Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Type:
  • number

compress :boolean

Description:
  • Use zlib compression on write or batch read commands when the command buffer size is greater than 128 bytes. In addition, tell the server to compress it's response on read commands. The server response compression threshold is also 128 bytes.

    This option will increase cpu and memory usage (for extra compressed buffers), but decrease the size of data sent over the network.

    Requires Enterprise Server version >= 4.8.

Source:
Since:
  • v3.14.0
Overrides:

Use zlib compression on write or batch read commands when the command buffer size is greater than 128 bytes. In addition, tell the server to compress it's response on read commands. The server response compression threshold is also 128 bytes.

This option will increase cpu and memory usage (for extra compressed buffers), but decrease the size of data sent over the network.

Requires Enterprise Server version >= 4.8.

Type:
  • boolean

durableDelete :boolean

Description:
  • Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Source:
Default Value:
  • false (do not tombstone deleted records)

Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Type:
  • boolean

durableDelete :boolean

Description:
  • Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Source:
Default Value:
  • false (do not tombstone deleted records)

Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Type:
  • boolean

filterExpression

Description:
Source:
Overrides:

Optional expression filter. If filter exp exists and evaluates to false, the transaction is ignored. This can be used to eliminate a client/server roundtrip in some cases.

expression filters can only be applied to the following commands:

gen :number

Description:
  • Specifies the behavior for the generation value.

Source:
See:

Specifies the behavior for the generation value.

Type:
  • number

gen :number

Description:
  • Specifies the behavior for the generation value.

Source:
See:

Specifies the behavior for the generation value.

Type:
  • number

generation :number

Description:
  • The generation of the record.

Source:

The generation of the record.

Type:
  • number

generation :number

Description:
  • The generation of the record.

Source:

The generation of the record.

Type:
  • number

key :number

Description:
  • Specifies the behavior for the key.

Source:
See:

Specifies the behavior for the key.

Type:
  • number

key :number

Description:
  • Specifies the behavior for the key.

Source:
See:

Specifies the behavior for the key.

Type:
  • number

maxRetries :number

Description:
  • Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.

    If maxRetries is exceeded, the transaction will return error ERR_TIMEOUT.

    WARNING: Database writes that are not idempotent (such as "add") should not be retried because the write operation may be performed multiple times if the client timed out previous transaction attempts. It is important to use a distinct write policy for non-idempotent writes which sets maxRetries to zero.

Source:
Overrides:

Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.

If maxRetries is exceeded, the transaction will return error ERR_TIMEOUT.

WARNING: Database writes that are not idempotent (such as "add") should not be retried because the write operation may be performed multiple times if the client timed out previous transaction attempts. It is important to use a distinct write policy for non-idempotent writes which sets maxRetries to zero.

Type:
  • number

socketTimeout :number

Description:
  • Socket idle timeout in milliseconds when processing a database command.

    If socketTimeout is not zero and the socket has been idle for at least socketTimeout, both maxRetries and totalTimeout are checked. If maxRetries and totalTimeout are not exceeded, the transaction is retried.

    If both socketTimeout and totalTimeout are non-zero and socketTimeout > totalTimeout, then socketTimeout will be set to totalTimeout. If socketTimeout is zero, there will be no socket idle limit.

Source:
Overrides:
Default Value:
  • 0 (no socket idle time limit).

Socket idle timeout in milliseconds when processing a database command.

If socketTimeout is not zero and the socket has been idle for at least socketTimeout, both maxRetries and totalTimeout are checked. If maxRetries and totalTimeout are not exceeded, the transaction is retried.

If both socketTimeout and totalTimeout are non-zero and socketTimeout > totalTimeout, then socketTimeout will be set to totalTimeout. If socketTimeout is zero, there will be no socket idle limit.

Type:
  • number

totalTimeout :number

Description:
  • Total transaction timeout in milliseconds.

    The totalTimeout is tracked on the client and sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server also has the capability to timeout the transaction.

    If totalTimeout is not zero and totalTimeout is reached before the transaction completes, the transaction will return error ERR_TIMEOUT. If totalTimeout is zero, there will be no total time limit.

Source:
Overrides:
Default Value:
  • 1000

Total transaction timeout in milliseconds.

The totalTimeout is tracked on the client and sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server also has the capability to timeout the transaction.

If totalTimeout is not zero and totalTimeout is reached before the transaction completes, the transaction will return error ERR_TIMEOUT. If totalTimeout is zero, there will be no total time limit.

Type:
  • number

RemovePolicy

A policy affecting the behavior of remove operations.

Constructor

new RemovePolicy(propsopt)

Description:
  • Initializes a new RemovePolicy from the provided policy values.

Source:
Since:
  • v3.0.0
Parameters:
Name Type Attributes Description
props Object <optional>

Policy values

Extends

Members

commitLevel :number

Description:
  • Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Source:
See:

Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Type:
  • number

commitLevel :number

Description:
  • Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Source:
See:

Specifies the number of replicas required to be committed successfully when writing before returning transaction succeeded.

Type:
  • number

compress :boolean

Description:
  • Use zlib compression on write or batch read commands when the command buffer size is greater than 128 bytes. In addition, tell the server to compress it's response on read commands. The server response compression threshold is also 128 bytes.

    This option will increase cpu and memory usage (for extra compressed buffers), but decrease the size of data sent over the network.

    Requires Enterprise Server version >= 4.8.

Source:
Since:
  • v3.14.0
Overrides:

Use zlib compression on write or batch read commands when the command buffer size is greater than 128 bytes. In addition, tell the server to compress it's response on read commands. The server response compression threshold is also 128 bytes.

This option will increase cpu and memory usage (for extra compressed buffers), but decrease the size of data sent over the network.

Requires Enterprise Server version >= 4.8.

Type:
  • boolean

durableDelete :boolean

Description:
  • Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Source:
Default Value:
  • false (do not tombstone deleted records)

Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Type:
  • boolean

durableDelete :boolean

Description:
  • Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Source:
Default Value:
  • false (do not tombstone deleted records)

Specifies whether a tombstone should be written in place of a record that gets deleted as a result of this operation.

Type:
  • boolean

filterExpression

Description:
Source:
Overrides:

Optional expression filter. If filter exp exists and evaluates to false, the transaction is ignored. This can be used to eliminate a client/server roundtrip in some cases.

expression filters can only be applied to the following commands:

gen :number

Description:
  • Specifies the behavior for the generation value.

Source:
See:

Specifies the behavior for the generation value.

Type:
  • number

gen :number

Description:
  • Specifies the behavior for the generation value.

Source:
See:

Specifies the behavior for the generation value.

Type:
  • number

generation :number

Description:
  • The generation of the record.

Source:

The generation of the record.

Type:
  • number

generation :number

Description:
  • The generation of the record.

Source:

The generation of the record.

Type:
  • number

key :number

Description:
  • Specifies the behavior for the key.

Source:
See:

Specifies the behavior for the key.

Type:
  • number

key :number

Description:
  • Specifies the behavior for the key.

Source:
See:

Specifies the behavior for the key.

Type:
  • number

maxRetries :number

Description:
  • Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.

    If maxRetries is exceeded, the transaction will return error ERR_TIMEOUT.

    WARNING: Database writes that are not idempotent (such as "add") should not be retried because the write operation may be performed multiple times if the client timed out previous transaction attempts. It is important to use a distinct write policy for non-idempotent writes which sets maxRetries to zero.

Source:
Overrides:

Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry.

If maxRetries is exceeded, the transaction will return error ERR_TIMEOUT.

WARNING: Database writes that are not idempotent (such as "add") should not be retried because the write operation may be performed multiple times if the client timed out previous transaction attempts. It is important to use a distinct write policy for non-idempotent writes which sets maxRetries to zero.

Type:
  • number

socketTimeout :number

Description:
  • Socket idle timeout in milliseconds when processing a database command.

    If socketTimeout is not zero and the socket has been idle for at least socketTimeout, both maxRetries and totalTimeout are checked. If maxRetries and totalTimeout are not exceeded, the transaction is retried.

    If both socketTimeout and totalTimeout are non-zero and socketTimeout > totalTimeout, then socketTimeout will be set to totalTimeout. If socketTimeout is zero, there will be no socket idle limit.

Source:
Overrides:
Default Value:
  • 0 (no socket idle time limit).

Socket idle timeout in milliseconds when processing a database command.

If socketTimeout is not zero and the socket has been idle for at least socketTimeout, both maxRetries and totalTimeout are checked. If maxRetries and totalTimeout are not exceeded, the transaction is retried.

If both socketTimeout and totalTimeout are non-zero and socketTimeout > totalTimeout, then socketTimeout will be set to totalTimeout. If socketTimeout is zero, there will be no socket idle limit.

Type:
  • number

totalTimeout :number

Description:
  • Total transaction timeout in milliseconds.

    The totalTimeout is tracked on the client and sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server also has the capability to timeout the transaction.

    If totalTimeout is not zero and totalTimeout is reached before the transaction completes, the transaction will return error ERR_TIMEOUT. If totalTimeout is zero, there will be no total time limit.

Source:
Overrides:
Default Value:
  • 1000

Total transaction timeout in milliseconds.

The totalTimeout is tracked on the client and sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server also has the capability to timeout the transaction.

If totalTimeout is not zero and totalTimeout is reached before the transaction completes, the transaction will return error ERR_TIMEOUT. If totalTimeout is zero, there will be no total time limit.

Type:
  • number