Skip to content

Commit 4a5f947

Browse files
committed
Rename IndexDefinition to IndexKeysDefinition.
1 parent 0e94593 commit 4a5f947

10 files changed

+578
-578
lines changed

src/MongoDB.Driver.Tests/IndexDefinitionBuilderTests.cs renamed to src/MongoDB.Driver.Tests/IndexKeysDefinitionBuilderTests.cs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
namespace MongoDB.Driver.Tests
2424
{
2525
[TestFixture]
26-
public class IndexDefinitionBuilderTests
26+
public class IndexKeysDefinitionBuilderTests
2727
{
2828
[Test]
2929
public void Ascending()
@@ -47,23 +47,23 @@ public void Combine()
4747
{
4848
var subject = CreateSubject<BsonDocument>();
4949

50-
var definition = subject.Combine(
50+
var result = subject.Combine(
5151
"{a: 1, b: -1}",
5252
subject.Descending("c"));
5353

54-
Assert(definition, "{a: 1, b: -1, c: -1}");
54+
Assert(result, "{a: 1, b: -1, c: -1}");
5555
}
5656

5757
[Test]
5858
public void Combine_with_repeated_fields()
5959
{
6060
var subject = CreateSubject<BsonDocument>();
6161

62-
var definition = subject.Combine(
62+
var combined = subject.Combine(
6363
"{a: 1, b: -1}",
6464
subject.Descending("a"));
6565

66-
Action act = () => Render(definition);
66+
Action act = () => Render(combined);
6767

6868
act.ShouldThrow<MongoException>();
6969
}
@@ -73,25 +73,25 @@ public void Combine_many_texts()
7373
{
7474
var subject = CreateSubject<BsonDocument>();
7575

76-
var definition = subject.Combine(
76+
var result = subject.Combine(
7777
subject.Text("a"),
7878
subject.Text("b"),
7979
subject.Text("c"));
8080

81-
Assert(definition, "{a: 'text', b: 'text', c: 'text'}");
81+
Assert(result, "{a: 'text', b: 'text', c: 'text'}");
8282
}
8383

8484
[Test]
8585
public void Combine_with_repeated_fields_using_extension_methods()
8686
{
8787
var subject = CreateSubject<BsonDocument>();
8888

89-
var definition = subject.Ascending("a")
89+
var result = subject.Ascending("a")
9090
.Ascending("b")
9191
.Descending("c")
9292
.Descending("a");
9393

94-
Action act = () => Render(definition);
94+
Action act = () => Render(result);
9595

9696
act.ShouldThrow<MongoException>();
9797
}
@@ -185,22 +185,22 @@ public void Text_Typed()
185185
Assert(subject.Text("$**"), "{'$**': 'text'}");
186186
}
187187

188-
private void Assert<TDocument>(IndexDefinition<TDocument> definition, string expectedJson)
188+
private void Assert<TDocument>(IndexKeysDefinition<TDocument> keys, string expectedJson)
189189
{
190-
var renderedSort = Render<TDocument>(definition);
190+
var renderedSort = Render<TDocument>(keys);
191191

192192
renderedSort.Should().Be(expectedJson);
193193
}
194194

195-
private BsonDocument Render<TDocument>(IndexDefinition<TDocument> definition)
195+
private BsonDocument Render<TDocument>(IndexKeysDefinition<TDocument> keys)
196196
{
197197
var documentSerializer = BsonSerializer.SerializerRegistry.GetSerializer<TDocument>();
198-
return definition.Render(documentSerializer, BsonSerializer.SerializerRegistry);
198+
return keys.Render(documentSerializer, BsonSerializer.SerializerRegistry);
199199
}
200200

201-
private IndexDefinitionBuilder<TDocument> CreateSubject<TDocument>()
201+
private IndexKeysDefinitionBuilder<TDocument> CreateSubject<TDocument>()
202202
{
203-
return new IndexDefinitionBuilder<TDocument>();
203+
return new IndexKeysDefinitionBuilder<TDocument>();
204204
}
205205

206206
private class Person

src/MongoDB.Driver.Tests/MongoDB.Driver.Tests.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
<Compile Include="Linq\Translators\PredicateTranslatorTests.cs" />
9999
<Compile Include="PipelineDefinitionTests.cs" />
100100
<Compile Include="ProjectionDefinitionBuilderTests.cs" />
101-
<Compile Include="IndexDefinitionBuilderTests.cs" />
101+
<Compile Include="IndexKeysDefinitionBuilderTests.cs" />
102102
<Compile Include="SortDefinitionBuilderTests.cs" />
103103
<Compile Include="UpdateDefinitionBuilderTests.cs" />
104104
<Compile Include="FilterDefinitionBuilderTests.cs" />

src/MongoDB.Driver/Builders.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace MongoDB.Driver
2222
public static class Builders<TDocument>
2323
{
2424
private static FilterDefinitionBuilder<TDocument> __filter = new FilterDefinitionBuilder<TDocument>();
25-
private static IndexDefinitionBuilder<TDocument> __index = new IndexDefinitionBuilder<TDocument>();
25+
private static IndexKeysDefinitionBuilder<TDocument> __index = new IndexKeysDefinitionBuilder<TDocument>();
2626
private static ProjectionDefinitionBuilder<TDocument> __projection = new ProjectionDefinitionBuilder<TDocument>();
2727
private static SortDefinitionBuilder<TDocument> __sort = new SortDefinitionBuilder<TDocument>();
2828
private static UpdateDefinitionBuilder<TDocument> __update = new UpdateDefinitionBuilder<TDocument>();
@@ -36,9 +36,9 @@ public static FilterDefinitionBuilder<TDocument> Filter
3636
}
3737

3838
/// <summary>
39-
/// Gets an <see cref="IndexDefinitionBuilder{TDocument}"/>.
39+
/// Gets an <see cref="IndexKeysDefinitionBuilder{TDocument}"/>.
4040
/// </summary>
41-
public static IndexDefinitionBuilder<TDocument> Index
41+
public static IndexKeysDefinitionBuilder<TDocument> IndexKeys
4242
{
4343
get { return __index; }
4444
}

src/MongoDB.Driver/IMongoIndexManager.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,19 @@ public interface IMongoIndexManager<TDocument>
4848
/// <summary>
4949
/// Creates an index.
5050
/// </summary>
51-
/// <param name="definition">The definition.</param>
51+
/// <param name="keys">The keys.</param>
5252
/// <param name="options">The options.</param>
5353
/// <param name="cancellationToken">The cancellation token.</param>
5454
/// <returns>A task.</returns>
55-
Task CreateAsync(IndexDefinition<TDocument> definition, CreateIndexOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
55+
Task CreateAsync(IndexKeysDefinition<TDocument> keys, CreateIndexOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
5656

5757
/// <summary>
5858
/// Drops an index.
5959
/// </summary>
60-
/// <param name="definition">The definition.</param>
60+
/// <param name="keys">The keys.</param>
6161
/// <param name="cancellationToken">The cancellation token.</param>
6262
/// <returns>A task.</returns>
63-
Task DropAsync(IndexDefinition<TDocument> definition, CancellationToken cancellationToken = default(CancellationToken));
63+
Task DropAsync(IndexKeysDefinition<TDocument> keys, CancellationToken cancellationToken = default(CancellationToken));
6464

6565
/// <summary>
6666
/// Drops an index by its name.

0 commit comments

Comments
 (0)