1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/**
* Tests index creation, index drops, list indexes, hide/unhide index on a time-series collection.
*
* @tags: [
* assumes_no_implicit_collection_creation_after_drop,
* does_not_support_stepdowns,
* requires_fcv_49,
* requires_find_command,
* requires_getmore,
* ]
*/
(function() {
"use strict";
load("jstests/core/timeseries/libs/timeseries.js");
if (!TimeseriesTest.timeseriesCollectionsEnabled(db.getMongo())) {
jsTestLog("Skipping test because the time-series collection feature flag is disabled");
return;
}
const collNamePrefix = 'timeseries_index_';
let collCountPostfix = 0;
const timeFieldName = 'tm';
const metaFieldName = 'mm';
const controlMinTimeFieldName = "control.min." + timeFieldName;
const controlMaxTimeFieldName = "control.max." + timeFieldName;
const doc = {
_id: 0,
[timeFieldName]: ISODate(),
[metaFieldName]: {tag1: 'a', tag2: 'b'}
};
/**
* Tests time-series
* - createIndex
* - queryable index (on time-series and underlying buckets collection using buckets format hint)
* - dropIndex (by index name and key)
* - listIndexes
* - hide/unhide (index by index name and key)
* - createIndex w/ hidden:true
*
* Accepts two index key patterns.
* The first key pattern is for the createIndexes command on the time-series collection.
* The second key pattern is what we can expect to use as a hint when querying the bucket
* collection.
*/
const runTest = function(keyForCreate, hint) {
const coll = db.getCollection(collNamePrefix + collCountPostfix++);
const bucketsColl = db.getCollection('system.buckets.' + coll.getName());
coll.drop(); // implicitly drops bucketsColl.
jsTestLog('Running test: collection: ' + coll.getFullName() +
';\nindex spec key for createIndexes: ' + tojson(keyForCreate) +
';\nindex spec key for query hint: ' + tojson(hint));
assert.commandWorked(db.createCollection(
coll.getName(), {timeseries: {timeField: timeFieldName, metaField: metaFieldName}}));
assert.contains(bucketsColl.getName(), db.getCollectionNames());
// Insert data on the time-series collection and index it.
assert.commandWorked(coll.insert(doc, {ordered: false}),
'failed to insert doc: ' + tojson(doc));
assert.commandWorked(coll.createIndex(keyForCreate),
'failed to create index: ' + tojson(keyForCreate));
// Check that the buckets collection was created, the index on it is usable and the document is
// present in the expected format.
const bucketDocs = bucketsColl.find().hint(hint).toArray();
assert.eq(1, bucketDocs.length, bucketDocs);
const bucketDoc = bucketDocs[0];
assert.eq(doc._id, bucketDoc.control.min._id, bucketDoc);
assert.eq(doc[timeFieldName], bucketDoc.control.min[timeFieldName], bucketDoc);
assert.docEq(doc[metaFieldName], bucketDoc.meta, bucketDoc);
// Check that listIndexes against the time-series collection returns the index just created.
//
// Note: call the listIndexes command directly, rather than use a helper, so that we can inspect
// the result's namespace in addition to the result's index key pattern.
const cursorDoc = assert.commandWorked(db.runCommand({listIndexes: coll.getName()})).cursor;
assert.eq(coll.getFullName(), cursorDoc.ns, tojson(cursorDoc));
assert.eq(1, cursorDoc.firstBatch.length, tojson(cursorDoc));
assert.docEq(keyForCreate, cursorDoc.firstBatch[0].key, tojson(cursorDoc));
// Drop the index on the time-series collection and then check that the underlying buckets
// collection index was dropped properly.
assert.commandWorked(coll.dropIndex(keyForCreate),
'failed to drop index: ' + tojson(keyForCreate));
assert.commandFailedWithCode(assert.throws(() => bucketsColl.find().hint(hint).toArray()),
ErrorCodes.BadValue);
assert.commandFailedWithCode(assert.throws(() => coll.find().hint(hint).toArray()),
ErrorCodes.BadValue);
// Check that we are able to drop the index by name (single name and array of names).
assert.commandWorked(coll.createIndex(keyForCreate, {name: 'myindex1'}),
'failed to create index: ' + tojson(keyForCreate));
assert.commandWorked(coll.dropIndex('myindex1'), 'failed to drop index: myindex1');
assert.commandWorked(coll.createIndex(keyForCreate, {name: 'myindex2'}),
'failed to create index: ' + tojson(keyForCreate));
assert.commandWorked(coll.dropIndexes(['myindex2']), 'failed to drop indexes: [myindex2]');
// Check that we are able to hide and unhide the index by name.
assert.commandWorked(coll.createIndex(keyForCreate, {name: 'hide1'}),
'failed to create index: ' + tojson(keyForCreate));
assert.eq(1, bucketsColl.find().hint(hint).toArray().length);
assert.eq(1, coll.find().hint(hint).toArray().length);
assert.commandWorked(coll.hideIndex('hide1'), 'failed to hide index: hide1');
assert.commandFailedWithCode(assert.throws(() => bucketsColl.find().hint(hint).toArray()),
ErrorCodes.BadValue);
assert.commandFailedWithCode(assert.throws(() => coll.find().hint(keyForCreate).toArray()),
ErrorCodes.BadValue);
assert.commandWorked(coll.unhideIndex('hide1'), 'failed to unhide index: hide1');
assert.eq(1, bucketsColl.find().hint(hint).toArray().length);
assert.eq(1, coll.find().hint(hint).toArray().length);
assert.commandWorked(coll.dropIndex('hide1'), 'failed to drop index: hide1');
// Check that we are able to hide and unhide the index by key.
assert.commandWorked(coll.createIndex(keyForCreate, {name: 'hide2'}),
'failed to create index: ' + tojson(keyForCreate));
assert.eq(1, bucketsColl.find().hint(hint).toArray().length);
assert.eq(1, coll.find().hint(hint).toArray().length);
assert.commandWorked(coll.hideIndex(keyForCreate), 'failed to hide index: hide2');
assert.commandFailedWithCode(assert.throws(() => bucketsColl.find().hint(hint).toArray()),
ErrorCodes.BadValue);
assert.commandFailedWithCode(assert.throws(() => coll.find().hint(hint).toArray()),
ErrorCodes.BadValue);
assert.commandWorked(coll.unhideIndex(keyForCreate), 'failed to unhide index: hide2');
assert.eq(1, bucketsColl.find().hint(hint).toArray().length);
assert.eq(1, coll.find().hint(hint).toArray().length);
assert.commandWorked(coll.dropIndex('hide2'), 'failed to drop index: hide2');
// Check that we are able to create the index as hidden.
// TODO(SERVER-56019): This test case tends to be problematic in the burn_in_tests suite under
// the replica_sets_initsync_jscore_passthrough subtask.
assert.commandWorked(coll.createIndex(keyForCreate, {name: 'hide3', hidden: true}),
'failed to create index: ' + tojson(keyForCreate));
assert.commandFailedWithCode(assert.throws(() => bucketsColl.find().hint(hint).toArray()),
ErrorCodes.BadValue);
assert.commandFailedWithCode(assert.throws(() => coll.find().hint(hint).toArray()),
ErrorCodes.BadValue);
assert.commandWorked(coll.unhideIndex(keyForCreate), 'failed to unhide index: hide3');
assert.eq(1, bucketsColl.find().hint(hint).toArray().length);
assert.eq(1, coll.find().hint(hint).toArray().length);
assert.commandWorked(coll.dropIndex('hide3'), 'failed to drop index: hide3');
};
/**
* Time-series index creation and usage testing.
*/
// metaField ascending and descending indexes.
runTest({[metaFieldName]: 1}, {meta: 1});
runTest({[metaFieldName]: -1}, {meta: -1});
// metaField subfield indexes.
runTest({[metaFieldName + '.tag1']: 1}, {'meta.tag1': 1});
runTest({[metaFieldName + '.tag1']: 1, [metaFieldName + '.tag2']: -1},
{'meta.tag1': 1, 'meta.tag2': -1});
// timeField ascending and descending indexes.
runTest({[timeFieldName]: 1}, {[controlMinTimeFieldName]: 1, [controlMaxTimeFieldName]: 1});
runTest({[timeFieldName]: -1}, {[controlMaxTimeFieldName]: -1, [controlMinTimeFieldName]: -1});
// Compound metaField and timeField.
runTest({[metaFieldName + '.tag1']: 1, [timeFieldName]: 1},
{'meta.tag1': 1, [controlMinTimeFieldName]: 1, [controlMaxTimeFieldName]: 1});
runTest({[metaFieldName + '.tag1']: 1, [timeFieldName]: -1},
{'meta.tag1': 1, [controlMaxTimeFieldName]: -1, [controlMinTimeFieldName]: -1});
// Multi-metaField sub-fields and timeField compound index.
runTest(
{[metaFieldName + '.tag1']: -1, [metaFieldName + '.tag2']: 1, [timeFieldName]: 1},
{'meta.tag1': -1, 'meta.tag2': 1, [controlMinTimeFieldName]: 1, [controlMaxTimeFieldName]: 1});
// metaField hashed index.
runTest({[metaFieldName]: "hashed"}, {'meta': "hashed"});
/*
* Test time-series index creation error handling.
*/
const coll = db.getCollection(collNamePrefix + collCountPostfix++);
coll.drop();
jsTestLog('Checking index creation error handling on collection: ' + coll.getFullName());
assert.commandWorked(db.createCollection(
coll.getName(), {timeseries: {timeField: timeFieldName, metaField: metaFieldName}}));
assert.commandWorked(coll.insert(doc, {ordered: false}), 'failed to insert doc: ' + tojson(doc));
// Reject index keys that do not include the metadata field.
assert.commandFailedWithCode(coll.createIndex({not_metadata: 1}), ErrorCodes.CannotCreateIndex);
assert.commandFailedWithCode(coll.dropIndex({not_metadata: 1}), ErrorCodes.IndexNotFound);
assert.commandFailedWithCode(coll.hideIndex({not_metadata: 1}), ErrorCodes.IndexNotFound);
// Index names are not transformed. dropIndexes passes the request along to the buckets collection,
// which in this case does not possess the index by that name.
assert.commandFailedWithCode(coll.dropIndex('mm_1'), ErrorCodes.IndexNotFound);
// Partial indexes are not supported on time-series bucket collections.
assert.commandFailedWithCode(
coll.createIndex({[metaFieldName]: 1}, {partialFilterExpression: {meta: {$gt: 5}}}),
ErrorCodes.InvalidOptions);
assert.commandFailedWithCode(
coll.createIndex({[metaFieldName]: 1}, {partialFilterExpression: {[metaFieldName]: {$gt: 5}}}),
ErrorCodes.InvalidOptions);
// Unique indexes are not supported on time-series bucket collections.
assert.commandFailedWithCode(coll.createIndex({[metaFieldName]: 1}, {unique: true}),
ErrorCodes.InvalidOptions);
// TTL indexes are not supported on a time-series buckets collection.
assert.commandFailedWithCode(coll.createIndex({[metaFieldName]: 1}, {expireAfterSeconds: 3600}),
ErrorCodes.InvalidOptions);
// Text indexes are not supported on a time-series buckets collection.
assert.commandFailedWithCode(coll.createIndex({[metaFieldName]: 'text'}),
ErrorCodes.InvalidOptions);
// If listIndexes fails to convert a non-conforming index on the bucket collection, it should omit
// that index from the results.
const bucketsColl = db.getCollection('system.buckets.' + coll.getName());
assert.commandWorked(bucketsColl.createIndex({not_metadata: 1}),
'failed to create index: ' + tojson({not_metadata: 1}));
assert.eq(1, bucketsColl.getIndexes().length, tojson(bucketsColl.getIndexes()));
assert.eq(0, coll.getIndexes().length, tojson(coll.getIndexes()));
})();
|
