// *****************************************************************************
// Copyright 2013-2020 Aerospike, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// *****************************************************************************
'use strict'
/**
* @module aerospike/operations
*
* @description This module provides functions to easily define operations to
* be performed on a record via the {@link Client#operate} command.
*
* @see {@link Client#operate}
*
* @example
*
* const Aerospike = require('aerospike')
* const op = Aerospike.operations
* const key = new Aerospike.Key('test', 'demo', 'mykey1')
*
* var ops = [
* op.append('a', 'xyz'),
* op.incr('b', 10),
* op.read('b')
* ]
*
* Aerospike.connect((error, client) => {
* if (error) throw error
* client.put(key, { a: 'abc', b: 42 }, (error) => {
* if (error) throw error
* client.operate(key, ops, (error, record) => {
* if (error) throw error
* console.log(record) // => { b: 52 }
* client.close()
* })
* })
* })
*/
const as = require('bindings')('aerospike.node')
const ops = as.scalarOperations
/**
* @class module:aerospike/operations~Operation
*
* @classdesc Base class for all operations executed with the {@link
* Client#operate} command.
*
* Operations can be created using the methods in one of the following modules:
* * {@link module:aerospike/operations} - General operations on all types.
* * {@link module:aerospike/lists} - Operations on CDT List values.
* * {@link module:aerospike/maps} - Operations on CDT Map values.
* * {@link module:aerospike/bitwise} - Operations on Bytes values.
*/
class Operation {
/**
* @protected
*/
constructor (op, bin, props) {
this.op = op
this.bin = bin
if (props) {
Object.assign(this, props)
}
}
}
exports.Operation = Operation
/**
* @summary Read the value of the bin.
*
* @param {string} bin - The name of the bin.
* @returns {Operation} Operation that can be passed to the {@link Client#operate} command.
*/
exports.read = function (bin) {
return new Operation(ops.READ, bin)
}
/**
* @summary Update the value of the bin.
*
* @param {string} bin - The name of the bin.
* @param {any} value - The value to set the bin to.
* @returns {Operation} Operation that can be passed to the {@link Client#operate} command.
*/
exports.write = function (bin, value) {
return new Operation(ops.WRITE, bin, {
value
})
}
/**
* @summary Increment the value of the bin by the given value.
*
* @description The bin must contain either an Integer or a Double, and the
* value must be of the same type.
*
* @param {string} bin - The name of the bin.
* @param {(number|Object)} value - The number|{@link Double} value to increment the bin by.
* @returns {Operation} Operation that can be passed to the {@link Client#operate} command.
*/
exports.add = function (bin, value) {
return new Operation(ops.INCR, bin, {
value
})
}
/**
* @summary Alias for the {@link module:aerospike/operations.add} operation.
*/
exports.incr = function (bin, value) {
return new Operation(ops.INCR, bin, {
value
})
}
/**
* @summary Append the value to the bin.
*
* @description The bin must contain either String or a Byte Array, and the
* value must be of the same type.
*
* @param {string} bin - The name of the bin.
* @param {(string|Buffer)} value - The value to append to the bin.
* @returns {Operation} Operation that can be passed to the {@link Client#operate} command.
*/
exports.append = function (bin, value) {
return new Operation(ops.APPEND, bin, {
value
})
}
/**
* @summary Prepend the value to the bin.
*
* @description The bin must contain either String or a Byte Array, and the
* value must be of the same type.
*
* @param {string} bin - The name of the bin.
* @param {(string|Buffer)} value - The value to prepend to the bin.
* @returns {Operation} Operation that can be passed to the {@link Client#operate} command.
*/
exports.prepend = function (bin, value) {
return new Operation(ops.PREPEND, bin, {
value
})
}
/**
* @summary Update the TTL (time-to-live) for a record.
*
* @description If the optional `ttl` parameter is not specified, the server
* will reset the record's TTL value to the default TTL value for the
* namespace.
*
* @param {number} [ttl=Aerospike.ttl.NAMESPACE_DEFAULT] - The new, relative TTL to set for the record, when it is touched.
* @returns {Operation} Operation that can be passed to the {@link Client#operate} command.
*
* @see {@link module:aerospike.ttl} for "special" TTL values.
*/
exports.touch = function (ttl) {
return new Operation(ops.TOUCH, undefined, {
ttl
})
}
/**
* @summary Deletes the record.
*
* @description Returns true on success. Otherwise an error occurred.
*
* @returns {Operation} Operation that can be passed to the {@link Client#operate} command.
*
* @since v3.14.0
*/
exports.delete = function () {
return new Operation(ops.DELETE, undefined)
}