index_spec.h

/*    Copyright 2014 MongoDB 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.
 */

#pragma once

#include <string>
#include <vector>
#include <utility>

#include "mongo/client/export_macros.h"
#include "mongo/db/jsobj.h"

namespace mongo {

class StringData;

class MONGO_CLIENT_API IndexSpec {
public:
    // An enumeration of symbolic names for index types.
    enum IndexType {
        kIndexTypeAscending,
        kIndexTypeDescending,
        kIndexTypeText,
        kIndexTypeGeo2D,
        kIndexTypeGeoHaystack,
        kIndexTypeGeo2DSphere,
        kIndexTypeHashed,
    };

    // The values to be encoded in BSON for each type of index.
    static const int kIndexValAscending = 1;
    static const int kIndexValDescending = -1;
    static const char kIndexValText[];
    static const char kIndexValGeo2D[];
    static const char kIndexValGeoHaystack[];
    static const char kIndexValGeo2DSphere[];
    static const char kIndexValHashed[];

    IndexSpec();

    //
    // Methods for adding keys. Methods on this class will prevent you from adding a given
    // key multiple times. Constraints on the validity of compound indexes are not enforced
    // here.
    //

    IndexSpec& addKey(const StringData& field, IndexType type = kIndexTypeAscending);

    IndexSpec& addKey(const BSONElement& fieldAndType);

    typedef std::vector<std::pair<std::string, IndexType> > KeyVector;
    IndexSpec& addKeys(const KeyVector& keys);

    IndexSpec& addKeys(const BSONObj& keys);


    //
    // Methods for adding options. As for keys, duplicated settings are checked and will
    // raise an error.
    //

    //
    // Common index options
    //

    IndexSpec& background(bool value = true);

    IndexSpec& unique(bool value = true);


    IndexSpec& name(const StringData& name);

    MONGO_CLIENT_DEPRECATED("deprecated in MongoDB 2.8")
    IndexSpec& dropDuplicates(bool value = true);

    IndexSpec& dropDuplicatesDeprecated(bool value = true);

    IndexSpec& sparse(bool value = true);

    IndexSpec& expireAfterSeconds(int value);

    IndexSpec& version(int value);

    IndexSpec& partialFilterExpression(const BSONObj& value);

    //
    // Text options
    //

    IndexSpec& textWeights(const BSONObj& value);

    IndexSpec& textDefaultLanguage(const StringData& value);

    IndexSpec& textLanguageOverride(const StringData& value);

    IndexSpec& textIndexVersion(int value);


    //
    // 2D Sphere Options
    //

    IndexSpec& geo2DSphereIndexVersion(int value);


    //
    // Geo2D Options
    //

    IndexSpec& geo2DBits(int value);

    IndexSpec& geo2DMin(double value);

    IndexSpec& geo2DMax(double value);


    //
    // Geo Haystack Options
    //

    IndexSpec& geoHaystackBucketSize(double value);


    //
    // Support for adding generic options. This is here so that if new index options
    // become available on the server those options can be set independently of the
    // named methods above.
    //

    IndexSpec& addOption(const BSONElement& option);

    IndexSpec& addOptions(const BSONObj& options);

    std::string name() const;

    BSONObj toBSON() const;

private:
    void _rename();

    std::string _name;
    bool _dynamicName;

    mutable BSONObjBuilder _keys;
    mutable BSONObjBuilder _options;
};

}  // namespace mongo