BatchWritePolicy

BatchWritePolicy

A policy affecting the behavior of batch write operations.

Constructor

new BatchWritePolicy(propsopt)

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

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

Policy values

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

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

exists :number

Description:
  • Specifies the behavior for the existence of the record.

Source:
See:

Specifies the behavior for the existence of the record.

Type:
  • number

exists :number

Description:
  • Specifies the behavior for the existence of the record.

Source:
See:

Specifies the behavior for the existence of the record.

Type:
  • number

filterExpression

Description:
  • 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.

Source:

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.

filterExpression

Description:
  • 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.

Source:

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.

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

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

BatchWritePolicy

A policy affecting the behavior of batch write operations.

Constructor

new BatchWritePolicy(propsopt)

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

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

Policy values

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

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

exists :number

Description:
  • Specifies the behavior for the existence of the record.

Source:
See:

Specifies the behavior for the existence of the record.

Type:
  • number

exists :number

Description:
  • Specifies the behavior for the existence of the record.

Source:
See:

Specifies the behavior for the existence of the record.

Type:
  • number

filterExpression

Description:
  • 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.

Source:

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.

filterExpression

Description:
  • 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.

Source:

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.

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

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