/// <summary>
/// Key String
/// </summary>
/// <param name="keys"></param>
/// <returns></returns>
public static string GetKeyString(IndexKeysDocument keys)
{
String KeyString = string.Empty;
foreach (BsonElement key in keys.Elements)
{
KeyString += key.Name + ":";
switch (key.Value.ToString())
{
case "1":
KeyString += MongoDBHelper.IndexType.Ascending.ToString();
break;
case "-1":
KeyString += MongoDBHelper.IndexType.Descending.ToString();
break;
case "2d":
KeyString += MongoDBHelper.IndexType.GeoSpatial.ToString();
break;
case "text":
KeyString += MongoDBHelper.IndexType.Text.ToString();
break;
default:
break;
}
KeyString += ";";
}
KeyString = "[" + KeyString.TrimEnd(";".ToArray()) + "]";
return KeyString;
}
internal static void InitializeDB()
{
var keys = new IndexKeysDocument();
keys.Add(new BsonElement("User", 1));
keys.Add(new BsonElement("Day", -1));
Entries.EnsureIndex(keys);
}
private IndexKeysDocument ToDoc(List<KeyModel> keys)
{
var doc = new IndexKeysDocument();
if (keys != null && keys.Count > 0)
{
foreach (var key in keys)
{
doc.Add(key.Field, key.Order);
}
}
return doc;
}
public void EnsureGetIndex()
{
queue.EnsureGetIndex(new IndexKeysDocument("type", 1), new IndexKeysDocument("boo", -1));
queue.EnsureGetIndex(new IndexKeysDocument("another.sub", 1));
Assert.AreEqual(4, collection.GetIndexes().Count);
var expectedOne = new IndexKeysDocument { { "running", 1 }, { "payload.type", 1 }, { "priority", 1 }, { "created", 1 }, { "payload.boo", -1 }, { "earliestGet", 1 } };
Assert.AreEqual(expectedOne, collection.GetIndexes()[1].Key);
var expectedTwo = new IndexKeysDocument { { "running", 1 }, { "resetTimestamp", 1 } };
Assert.AreEqual(expectedTwo, collection.GetIndexes()[2].Key);
var expectedThree = new IndexKeysDocument { { "running", 1 }, { "payload.another.sub", 1 }, { "priority", 1 }, { "created", 1 }, { "earliestGet", 1 } };
Assert.AreEqual(expectedThree, collection.GetIndexes()[3].Key);
}
public void TestIndexKeysDocumentConstructor()
{
var document1 = new IndexKeysDocument(dictionary);
var document2 = new IndexKeysDocument(hashtable);
var document3 = new IndexKeysDocument(idictionaryNonGeneric);
var document4 = new IndexKeysDocument(idictionary);
Assert.AreEqual("Dictionary<string, object>", document1["type"].AsString);
Assert.AreEqual("Hashtable", document2["type"].AsString);
Assert.AreEqual("IDictionary", document3["type"].AsString);
Assert.AreEqual("IDictionary<string, object>", document4["type"].AsString);
}
/// <summary>
/// Key String
/// </summary>
/// <param name="keys"></param>
/// <returns></returns>
public static string GetKeyString(IndexKeysDocument keys)
{
var keyString = string.Empty;
foreach (var key in keys.Elements)
{
keyString += key.Name + ":";
switch (key.Value.ToString())
{
case "1":
keyString += IndexType.Ascending.ToString();
break;
case "-1":
keyString += IndexType.Descending.ToString();
break;
case "2d":
keyString += IndexType.GeoSpatial.ToString();
break;
case "2dsphere":
keyString += IndexType.GeoSpatialSpherical.ToString();
break;
case "geoHaystack":
keyString += IndexType.GeoSpatialHaystack.ToString();
break;
case "hashed":
keyString += IndexType.Hashed.ToString();
break;
case "text":
keyString += IndexType.Text.ToString();
break;
}
keyString += ";";
}
keyString = "[" + keyString.TrimEnd(";".ToArray()) + "]";
return keyString;
}
/// <summary>
/// 增加索引
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void cmdAddIndex_Click(object sender, EventArgs e)
{
var AscendingKey = new List<String>();
var DescendingKey = new List<String>();
String GeoSpatialKey = string.Empty;
String FirstKey = string.Empty;
String TextKey = String.Empty;
for (int i = 0; i < 5; i++)
{
var ctl = (ctlIndexCreate) Controls.Find("ctlIndexCreate" + (i + 1), true)[0];
if (ctl.KeyName == String.Empty) continue;
FirstKey = ctl.KeyName.Trim();
switch (ctl.IndexKeyType)
{
case MongoDbHelper.IndexType.Ascending:
AscendingKey.Add(ctl.KeyName.Trim());
break;
case MongoDbHelper.IndexType.Descending:
DescendingKey.Add(ctl.KeyName.Trim());
break;
case MongoDbHelper.IndexType.GeoSpatial:
GeoSpatialKey = ctl.KeyName.Trim();
break;
case MongoDbHelper.IndexType.Text:
TextKey = ctl.KeyName.Trim();
break;
default:
break;
}
}
var option = new IndexOptionsBuilder();
option.SetBackground(chkIsBackground.Checked);
option.SetDropDups(chkIsDroppedDups.Checked);
option.SetSparse(chkIsSparse.Checked);
option.SetUnique(chkIsUnique.Checked);
if (chkExpireData.Checked)
{
//TTL的限制条件很多
//http://docs.mongodb.org/manual/tutorial/expire-data/
//不能是组合键
Boolean CanUseTTL = true;
if ((AscendingKey.Count + DescendingKey.Count + (String.IsNullOrEmpty(GeoSpatialKey) ? 0 : 1)) != 1)
{
MyMessageBox.ShowMessage("Can't Set TTL",
"the TTL index may not be compound (may not have multiple fields).");
CanUseTTL = false;
}
else
{
//不能是_id
if (FirstKey == MongoDbHelper.KEY_ID)
{
MyMessageBox.ShowMessage("Can't Set TTL",
"you cannot create this index on the _id field, or a field that already has an index.");
CanUseTTL = false;
}
}
if (SystemManager.GetCurrentCollection().IsCapped())
{
MyMessageBox.ShowMessage("Can't Set TTL",
"you cannot use a TTL index on a capped collection, because MongoDB cannot remove documents from a capped collection.");
CanUseTTL = false;
}
if (CanUseTTL)
{
MyMessageBox.ShowMessage("Constraints", "Constraints Of TimeToLive",
"the indexed field must be a date BSON type. If the field does not have a date type, the data will not expire." +
Environment.NewLine +
"if the field holds an array, and there are multiple date-typed data in the index, the document will expire when the lowest (i.e. earliest) matches the expiration threshold.",
true);
option.SetTimeToLive(new TimeSpan(0, 0, (int) numTTL.Value));
}
}
if (txtIndexName.Text != String.Empty &&
!SystemManager.GetCurrentCollection().IndexExists(txtIndexName.Text) &&
(AscendingKey.Count + DescendingKey.Count +
(String.IsNullOrEmpty(GeoSpatialKey) ? 0 : 1) +
(String.IsNullOrEmpty(TextKey) ? 0 : 1)) != 0)
{
option.SetName(txtIndexName.Text);
try
{
//暂时要求只能一个TextKey
if (!string.IsNullOrEmpty(TextKey))
{
var TextKeysDoc = new IndexKeysDocument {{TextKey, "text"}};
SystemManager.GetCurrentCollection().CreateIndex(TextKeysDoc, option);
}
else
{
MongoDbHelper.CreateMongoIndex(AscendingKey.ToArray(), DescendingKey.ToArray(), GeoSpatialKey,
option);
}
MyMessageBox.ShowMessage("Index Add Completed!",
"IndexName:" + txtIndexName.Text + " is add to collection.");
}
catch (Exception ex)
{
SystemManager.ExceptionDeal(ex, "Index Add Failed!", "IndexName:" + txtIndexName.Text);
}
RefreshList();
}
else
{
MyMessageBox.ShowMessage("Index Add Failed!", "Please Check the index information.");
}
}
private void EnsureIndex(IndexKeysDocument index)
{
for (var i = 0; i < 5; ++i)
{
for (var name = Guid.NewGuid().ToString(); name.Length > 0; name = name.Substring(0, name.Length - 1))
{
//creating an index with the same name and different spec does nothing.
//creating an index with same spec and different name does nothing.
//so we use any generated name, and then find the right spec after we have called, and just go with that name.
try
{
collection.EnsureIndex(index, new IndexOptionsDocument("name", name));
}
catch (MongoCommandException)
{
//this happens when the name was too long
continue;
}
foreach (var existingIndex in collection.GetIndexes())
{
if (existingIndex.Key == index)
return;
}
}
}
throw new Exception("couldnt create index after 100 attempts");
}
/// <summary>
/// Ensure index for Get() method
/// </summary>
/// <param name="beforeSort">fields in Get() call that should be before the sort fields in the index</param>
/// <param name="afterSort">fields in Get() call that should be after the sort fields in the index</param>
/// <exception cref="ArgumentNullException">beforeSort or afterSort is null</exception>
/// <exception cref="ArgumentException">beforeSort or afterSort field value is not 1 or -1</exception>
public void EnsureGetIndex(IndexKeysDocument beforeSort, IndexKeysDocument afterSort)
{
if (beforeSort == null) throw new ArgumentNullException("beforeSort");
if (afterSort == null) throw new ArgumentNullException("afterSort");
//using general rule: equality, sort, range or more equality tests in that order for index
var completeIndex = new IndexKeysDocument("running", 1);
foreach (var field in beforeSort)
{
if (field.Value != 1 && field.Value != -1) throw new ArgumentException("field values must be 1 or -1 for ascending or descending", "beforeSort");
completeIndex.Add("payload." + field.Name, field.Value);
}
completeIndex.Add("priority", 1);
completeIndex.Add("created", 1);
foreach (var field in afterSort)
{
if (field.Value != 1 && field.Value != -1) throw new ArgumentException("field values must be 1 or -1 for ascending or descending", "afterSort");
completeIndex.Add("payload." + field.Name, field.Value);
}
completeIndex.Add("earliestGet", 1);
EnsureIndex(completeIndex);//main query in Get()
EnsureIndex(new IndexKeysDocument { { "running", 1 }, { "resetTimestamp", 1 } });//for the stuck messages query in Get()
}
/// <summary>
/// Ensure index for Get() method with no fields after sort fields
/// </summary>
/// <param name="beforeSort">fields in Get() call that should be before the sort fields in the index</param>
/// <exception cref="ArgumentNullException">beforeSort is null</exception>
/// <exception cref="ArgumentException">beforeSort field value is not 1 or -1</exception>
public void EnsureGetIndex(IndexKeysDocument beforeSort)
{
EnsureGetIndex(beforeSort, new IndexKeysDocument());
}
/// <summary>
/// Ensure index for Count() method
/// </summary>
/// <param name="index">fields in Count() call</param>
/// <param name="includeRunning">whether running was given to Count() or not</param>
/// <exception cref="ArgumentNullException">index was null</exception>
/// <exception cref="ArgumentException">index field value is not 1 or -1</exception>
public void EnsureCountIndex(IndexKeysDocument index, bool includeRunning)
{
if (index == null) throw new ArgumentNullException("index");
var completeFields = new IndexKeysDocument();
if (includeRunning)
completeFields.Add("running", 1);
foreach (var field in index)
{
if (field.Value != 1 && field.Value != -1) throw new ArgumentException("field values must be 1 or -1 for ascending or descending", "index");
completeFields.Add("payload." + field.Name, field.Value);
}
EnsureIndex(completeFields);
}
public void EnsureCountIndex()
{
queue.EnsureCountIndex(new IndexKeysDocument { { "type", 1 }, { "boo", -1 } }, false);
queue.EnsureCountIndex(new IndexKeysDocument { { "another.sub", 1 } }, true);
Assert.AreEqual(3, collection.GetIndexes().Count);
var expectedOne = new IndexKeysDocument { { "payload.type", 1 }, { "payload.boo", -1 } };
Assert.AreEqual(expectedOne, collection.GetIndexes()[1].Key);
var expectedTwo = new IndexKeysDocument { { "running", 1 }, { "payload.another.sub", 1 } };
Assert.AreEqual(expectedTwo, collection.GetIndexes()[2].Key);
}
/// <summary>
///
/// </summary>
/// <param name="uiOption"></param>
/// <param name="strMessageTitle"></param>
/// <param name="strMessageContent"></param>
/// <returns></returns>
public static bool CreateIndex(IndexOption uiOption, ref string strMessageTitle, ref string strMessageContent)
{
var result = true;
var option = new IndexOptionsBuilder();
option.SetBackground(uiOption.IsBackground);
option.SetDropDups(uiOption.IsDropDups);
option.SetSparse(uiOption.IsSparse);
option.SetUnique(uiOption.IsUnique);
if (uiOption.IsPartial)
{
IMongoQuery query = (QueryDocument) BsonDocument.Parse(uiOption.PartialCondition);
option.SetPartialFilterExpression(query);
}
if (uiOption.IsExpireData)
{
//TTL的限制条件很多
//http://docs.mongodb.org/manual/tutorial/expire-data/
//不能是组合键
var canUseTtl = true;
if (uiOption.AscendingKey.Count + uiOption.DescendingKey.Count +
(string.IsNullOrEmpty(uiOption.GeoSpatialKey) ? 0 : 1) != 1)
{
strMessageTitle = "Can't Set TTL";
strMessageContent = "the TTL index may not be compound (may not have multiple fields).";
canUseTtl = false;
}
else
{
//不能是_id
if (uiOption.FirstKey == ConstMgr.KeyId)
{
strMessageTitle = "Can't Set TTL";
strMessageContent =
"you cannot create this index on the _id field, or a field that already has an index.";
canUseTtl = false;
}
}
if (RuntimeMongoDbContext.GetCurrentCollection().IsCapped())
{
strMessageTitle = "Can't Set TTL";
strMessageContent =
"you cannot use a TTL index on a capped collection, because MongoDB cannot remove documents from a capped collection.";
canUseTtl = false;
}
if (canUseTtl)
{
strMessageTitle = "Constraints Of TimeToLive";
strMessageContent =
"the indexed field must be a date BSON type. If the field does not have a date type, the data will not expire." +
Environment.NewLine +
"if the field holds an array, and there are multiple date-typed data in the index, the document will expire when the lowest (i.e. earliest) matches the expiration threshold.";
option.SetTimeToLive(new TimeSpan(0, 0, uiOption.Ttl));
}
}
var totalIndex = uiOption.AscendingKey.Count + uiOption.DescendingKey.Count +
(string.IsNullOrEmpty(uiOption.GeoSpatialKey) ? 0 : 1) +
(string.IsNullOrEmpty(uiOption.TextKey) ? 0 : 1);
if (uiOption.IndexName != string.Empty &&
!RuntimeMongoDbContext.GetCurrentCollection().IndexExists(uiOption.IndexName) && totalIndex != 0)
{
option.SetName(uiOption.IndexName);
try
{
//暂时要求只能一个TextKey
if (!string.IsNullOrEmpty(uiOption.TextKey))
{
var textKeysDoc = new IndexKeysDocument {{uiOption.TextKey, "text"}};
RuntimeMongoDbContext.GetCurrentCollection().CreateIndex(textKeysDoc, option);
}
else
{
CreateMongoIndex(uiOption.AscendingKey.ToArray(), uiOption.DescendingKey.ToArray(),
uiOption.GeoSpatialKey,
option, RuntimeMongoDbContext.GetCurrentCollection());
}
strMessageTitle = "Index Add Completed!";
strMessageContent = "IndexName:" + uiOption.IndexName + " is add to collection.";
}
catch
{
strMessageTitle = "Index Add Failed!";
strMessageContent = "IndexName:" + uiOption.IndexName;
result = false;
}
}
else
{
strMessageTitle = "Index Add Failed!";
strMessageContent = "Please Check the index information.";
result = false;
}
return result;
}
public void EnsureGetIndexWithNoArgs()
{
queue.EnsureGetIndex();
Assert.AreEqual(3, collection.GetIndexes().Count);
var expectedOne = new IndexKeysDocument { { "running", 1 }, { "priority", 1 }, { "created", 1 }, { "earliestGet", 1 } };
Assert.AreEqual(expectedOne, collection.GetIndexes()[1].Key);
var expectedTwo = new IndexKeysDocument { { "running", 1 }, { "resetTimestamp", 1 } };
Assert.AreEqual(expectedTwo, collection.GetIndexes()[2].Key);
}
public void EnsureCountIndexWithPrefixOfPrevious()
{
queue.EnsureCountIndex(new IndexKeysDocument { { "type", 1 }, { "boo", -1 } }, false);
queue.EnsureCountIndex(new IndexKeysDocument { { "type", 1 } }, false);
Assert.AreEqual(2, collection.GetIndexes().Count);
var expectedOne = new IndexKeysDocument { { "payload.type", 1 }, { "payload.boo", -1 } };
Assert.AreEqual(expectedOne, collection.GetIndexes()[1].Key);
}
private void EnsureIndex(IndexKeysDocument index)
{
//if index is a prefix of any existing index we are good
foreach (var existingIndex in collection.GetIndexes())
{
var names = index.Names;
var values = index.Values;
var existingNamesPrefix = existingIndex.Key.Names.Take(names.Count());
var existingValuesPrefix = existingIndex.Key.Values.Take(values.Count());
if (Enumerable.SequenceEqual(names, existingNamesPrefix) && Enumerable.SequenceEqual(values, existingValuesPrefix))
return;
}
for (var i = 0; i < 5; ++i)
{
for (var name = Guid.NewGuid().ToString(); name.Length > 0; name = name.Substring(0, name.Length - 1))
{
//creating an index with the same name and different spec does nothing.
//creating an index with same spec and different name does nothing.
//so we use any generated name, and then find the right spec after we have called, and just go with that name.
try
{
collection.CreateIndex(index, new IndexOptionsDocument { {"name", name }, { "background", true } });
}
catch (MongoCommandException)
{
//this happens when the name was too long
}
foreach (var existingIndex in collection.GetIndexes())
{
if (existingIndex.Key == index)
return;
}
}
}
throw new Exception("couldnt create index after 5 attempts");
}
