BatchReadPolicy

BatchReadPolicy

A policy affecting the behavior of batch read operations.

Constructor

new BatchReadPolicy(propsopt)

Description:

  • Initializes a new BatchReadPolicy from the provided policy values.

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

Policy values

Members

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.

readModeAP :number

Description:

  • Read policy for AP (availability) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeAP.ONE
See:

Read policy for AP (availability) namespaces.

Type:
  • number

readModeAP :number

Description:

  • Read policy for AP (availability) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeAP.ONE
See:

Read policy for AP (availability) namespaces.

Type:
  • number

readModeSC :number

Description:

  • Read policy for SC (strong consistency) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeSC.SESSION
See:

Read policy for SC (strong consistency) namespaces.

Type:
  • number

readModeSC :number

Description:

  • Read policy for SC (strong consistency) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeSC.SESSION
See:

Read policy for SC (strong consistency) namespaces.

Type:
  • number

readTouchTtlPercent :number

Description:

  • Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

    For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Source:
Default Value:
  • 0

Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Type:
  • number

readTouchTtlPercent :number

Description:

  • Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

    For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Source:
Default Value:
  • 0

Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Type:
  • number

BatchReadPolicy

A policy affecting the behavior of batch read operations.

Constructor

new BatchReadPolicy(propsopt)

Description:

  • Initializes a new BatchReadPolicy from the provided policy values.

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

Policy values

Members

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.

readModeAP :number

Description:

  • Read policy for AP (availability) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeAP.ONE
See:

Read policy for AP (availability) namespaces.

Type:
  • number

readModeAP :number

Description:

  • Read policy for AP (availability) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeAP.ONE
See:

Read policy for AP (availability) namespaces.

Type:
  • number

readModeSC :number

Description:

  • Read policy for SC (strong consistency) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeSC.SESSION
See:

Read policy for SC (strong consistency) namespaces.

Type:
  • number

readModeSC :number

Description:

  • Read policy for SC (strong consistency) namespaces.

Source:
Default Value:
  • Aerospike.policy.readModeSC.SESSION
See:

Read policy for SC (strong consistency) namespaces.

Type:
  • number

readTouchTtlPercent :number

Description:

  • Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

    For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Source:
Default Value:
  • 0

Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Type:
  • number

readTouchTtlPercent :number

Description:

  • Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

    For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Source:
Default Value:
  • 0

Determine how record TTL (time to live) is affected on reads. When enabled, the server can efficiently operate as a read-based LRU cache where the least recently used records are expired. The value is expressed as a percentage of the TTL sent on the most recent write such that a read within this interval of the record’s end of life will generate a touch.

For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most recent write) will result in a touch, resetting the TTL to another 10 hours. *

Type:
  • number