basho-riak-client-covs/lib/commands/yokozuna/deleteindex.js

Basho's officially supported NodeJS client for Riak

/**
 *
 * Copyright 2014-present Basho Technologies, 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';

var CommandBase = require('../commandbase');
var inherits = require('util').inherits;
var Joi = require('joi');

/**
 * Provides the (Yokozuna) DeleteIndex command and its builder.
 * @module YZ
 */

/**
 * Command used to Delete a Yokozuna index.
 *
 * As a convenience, a builder class is provided:
 *
 *     var del = DeleteIndex.Builder()
 *                  .withIndexName('index_name')
 *                  .withCallback(callback)
 *                  .build();
 *
 * See {{#crossLink "DeleteIndex.Builder"}}DeleteIndex.Builder{{/crossLink}}
 *
 * @class DeleteIndex
 * @constructor
 * @param {Object} options The options for this command
 * @param {String} [options.indexName] The name of the index to delete.
 * @param {Function} callback The callback to be executed when the operation completes.
 * @param {String} callback.err An error message. Will be null if no error.
 * @param {Boolean} callback.response operation either succeeds or returns error. This will be true.
 * @param {Object} callback.data additional error data. Will be null if no error.
 * @extends CommandBase
 */
function DeleteIndex(options, callback) {
    CommandBase.call(this, 'RpbYokozunaIndexDeleteReq' , 'RpbDelResp', callback);
    this.validateOptions(options, schema);
}

inherits(DeleteIndex, CommandBase);

DeleteIndex.prototype.constructPbRequest = function() {

    var protobuf = this.getPbReqBuilder();

    protobuf.setName(new Buffer(this.options.indexName));

    return protobuf;

};

DeleteIndex.prototype.onSuccess = function(RpbDelResp) {
    // RpbDelResp is simply null (no body)
    this._callback(null, true);
    return true;
};

var schema = Joi.object().keys({
    indexName: Joi.string().required()
});

/**
 * A builder for constructing DeleteIndex instances.
 *
 * Rather than having to manually construct the __options__ and instantiating
 * a DeleteIndex directly, this builder may be used.
 *
 *     var del = DeleteIndex.Builder()
 *                  .withIndexName('index_name')
 *                  .withCallback(callback)
 *                  .build();
 *
 * @class DeleteIndex.Builder
 * @constructor
 */
function Builder(){}

Builder.prototype = {

    /**
     * The name of the index to delete.
     * If one is not supplied, all indexes are returned.
     * @method withIndexName
     * @param {String} indexName the name of the index
     * @chainable
     */
    withIndexName : function(indexName) {
        this.indexName = indexName;
        return this;
    },
    /**
     * Set the callback to be executed when the operation completes.
     * @method withCallback
     * @param {Function} callback the callback to execute
     * @param {String} callback.err An error message
     * @param {Boolean} callback.response will always be true.
     * @chainable
     */
    withCallback : function(callback) {
        this.callback = callback;
        return this;
    },
    /**
     * Construct a DeleteIndex instance.
     * @method build
     * @return {DeleteIndex}
     */
    build : function() {
        var cb = this.callback;
        delete this.callback;
        return new DeleteIndex(this, cb);
    }
};

module.exports = DeleteIndex;
module.exports.Builder = Builder;