ClusteredIndexOptions.cs

/* Copyright 2010-present 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.
*/

usingMongoDB.Bson;
usingMongoDB.Bson.Serialization;

namespaceMongoDB.Driver
{
/// <summary>
/// Options for creating a clustered index.
/// </summary>
/// <typeparam name="TDocument">The document type.</typeparam>
publicclassClusteredIndexOptions<TDocument>
{
privateIndexKeysDefinition<TDocument>_key;
privatestring_name;
privatebool_unique;

/// <summary>
/// Initializes a new instance of the <see cref="ClusteredIndexOptions{TDocument}"/> class.
/// </summary>
publicClusteredIndexOptions()
{
_key=newBsonDocument{{"_id",1}};
_unique=true;
}

/// <summary>
/// Gets or sets the index key, which must currently be {_id: 1}.
/// </summary>
publicIndexKeysDefinition<TDocument>Key
{
get=>_key;
set=>_key=value;
}

/// <summary>
/// Gets or sets the index name.
/// </summary>
publicstringName
{
get=>_name;
set=>_name=value;
}

/// <summary>
/// Gets or sets whether the index entries must be unique, which currently must be true.
/// </summary>
publicboolUnique
{
get=>_unique;
set=>_unique=value;
}

internalBsonDocumentRender(IBsonSerializer<TDocument>documentSerializer,IBsonSerializerRegistryserializerRegistry,ExpressionTranslationOptionstranslationOptions)
{
returnnewBsonDocument{
{"key",_key.Render(new(documentSerializer,serializerRegistry,translationOptions:translationOptions))},
{"unique",_unique},
{"name",_name,_name!=null}
};
}
}
}