MongoDB的C#驱动基本使用
MongoDB的官方C#驱动可以通过这个链接得到。链接提供了.msi和.zip两种方式获取驱动dll文件。
通过这篇文章来介绍C#驱动的基本数据库连接,增删改查操作。
在使用C#驱动的时候,要在工程中添加"MongoDB.Bson.dll"和"MongoDB.Driver.dll"的引用。同时要在代码中加入下面两个using语句。
using MongoDB.Bson; using MongoDB.Driver;
数据库连接
要建立数据库连接,就一定要知道服务器的地址、端口等信息。所有的这些信息,我们都使用连接字符串表示。MongoDB的连接字符串格式如下:
mongodb://[username:password@]host1[:port1][,host2[:port2],…[,hostN[:portN]]][/[database][?options]]
下面看看连接字符串中的各个字段的含义:
- mongodb://:这个是MongoDB连接字符串的前缀
- username:password(Optional):可选项,表示登录用户名和密码,用于完成用户安全验证
- hostN: 必须的指定至少一个host,表示连接到的MongoDB实例
- portN(Optional):可选项,默认连接到27017
- database(Optional):如果指定username:password@,连接并验证登陆指定数据库。若不指定,默认打开admin数据库。
- options(Optional):可选项,如果不使用/database,则前面需要加上/。所有连接选项都是键值对name=value,键值对之间通过&或;(分号)隔开
在这里,使用文章"MongoDB管理"中的例子,test1和test2有各自的用户。当使用下面的连接字符串访问的时候,可以得到正确的验证,因为"Will1:Will1"对test1有读写权限。如果换成访问test2数据库,则会得到一个"Invalid credentials for database ‘test2‘"的异常输出。
string connectionStr = "mongodb://Will1:Will1@localhost"; MongoClient client = new MongoClient(connectionStr); MongoServer server = client.GetServer(); MongoDatabase db = server.GetDatabase("test2"); MongoCollection<BsonDocument> collection = db.GetCollection("student"); try { Console.WriteLine("db name is: " + db.Name); Console.WriteLine("collections name is: " + collection.Name); Console.WriteLine("{0} items in this collection", collection.Count()); } catch (Exception e) { Console.WriteLine(e.Message); }
从上面的代码中可以看到:
-
如何获取client和server对象
string connectionStr = "mongodb://Will1:Will1@localhost"; MongoClient client = new MongoClient(connectionStr); MongoServer server = client.GetServer();
-
如何获得数据库和collection对象
MongoDatabase db = server.GetDatabase("test2"); MongoCollection<BsonDocument> collection = db.GetCollection("student");
BsonDocument对象模型
在开始增删改查的介绍之前,要介绍一下BsonDocument对象模型。
在MongoDB collection中,每个文档都可以看作一个Bson(Binary JSON)对象,所以在驱动中有个一个BsonDocument类型,可以通过下面的方式生成一个文档,并且通过Add方法添加键/值对。通过这种方式生成的BsonDocument对象可以直接插入collection中。
BsonDocument student1 = new BsonDocument(); student1.Add("sid", 10); student1.Add("name", "Will10"); student1.Add("gender", "Male"); student1.Add("age", 26);
在MongoDB中,当用户对collection进行操作的时候可以有两种方式:
- 通过BsonDocument对象模型
- 通过自定义类型
上面已经介绍过了BsonDocument对象,在这里我们也可以使用自己自定义的类型。比如,我们可以定义一个Student类型,将该类型的对象插入到collection中。
public class Student { public ObjectId _id; public int sid; public string name; public string gender; public int age; }
注意:当是用自定义类型的时候一定要有Id字段。
上面两种方式都可以使用,而且各有好处,通过自定义类型的方式,可以使得collection中的文档有比较统一的模式;使用BsonDocument方式则可以支持更多的文档模式,也就是说如果一个collection中的文档拥有各种各样的模式,那么BsonDocument方式就会更灵活。
插入数据
关于数据的插入,我们可以使用collection中的"Insert()"方法。下面插入了两条记录。可以通过BsonDocument对象方式插入,也可以通过自定义类型方式插入。
通过BsonDocument的方式,用户可以自由的定义文档的格式。例如,增加了一个“hobby”字段(Ps:不建议这么做,这样会对文档查询带来麻烦)。
BsonDocument student1 = new BsonDocument(); student1.Add("sid", 10); student1.Add("name", "Will10"); student1.Add("gender", "Male"); student1.Add("age", 26); student1.Add("hobby", new BsonArray() { "swimming","reading"}); collection.Insert(student1); Student student2 = new Student(); student2.age = 27; student2.name = "Wilber"; student2.gender = "Male"; collection.Insert(student2);
查询数据
通过MongoDB driver,可以支持三种查询方法。
QueryDocument
这种方式的查询,类似我们在MongoDB shell中的条件查询。例如,查询年龄大于20的学生
QueryDocument queryDocument = new QueryDocument("age", new QueryDocument("$gt",20)); foreach (var student in collection.Find(queryDocument)) { Console.WriteLine(student); }
当查询条件为多个的时候,例如,查询年龄大于20的男学生
QueryDocument queryDocument = new QueryDocument(new BsonElement("age", new QueryDocument("$gt", 20)), new BsonElement("gender","Male"));
Query Builder
Query Builder是一种更简洁的方式,当通过这种方式查询的时候,我们需要使用driver中的builder来生成query。所以,要引用下面using语句
using MongoDB.Driver.Builders;
通过下面的语句,可以查询年龄大于20的学生
var query = Query.GT("age", 20); foreach (var student in collection.Find(query)) { Console.WriteLine(student); }
查询年龄大于20的男学生
var query = Query.And(Query.GT("age", 20), Query.EQ("gender", "Male"));
当然,我们也可以进行强类型查询,但是这种查询是有前提条件的,"要求文档中的字段必须是自定义类型字段的子集,也就是要求文档可以转化为特定类型"。例如,我们前面插入了一个文档还有"hobby"这个key,如果使用下面的方法,就会产生一个异常,提示Student类型没有hobby这个字段。
var query = Query<Student>.GT(e => e.age, 20); foreach (var student in collection.FindAs<Student>(query)) { Console.WriteLine(student); }
在这种情况下,可以使用BsonDocument类型进行查询。有一点不明白的就是Query使用Student强类型为什么不报错。
var query = Query<Student>.GT(e => e.age, 20); foreach (var student in collection.FindAs<BsonDocument>(query)) { Console.WriteLine(student); }
LINQ支持
在driver的1.8 release之后,官方驱动就可以支持LINQ操作了。我们只需要通过下面的using语句,就可以支持LINQ的方式进行查询了。
using MongoDB.Driver.Linq;
所以,可以查询年龄大于20的学生,也可以通过下面方式实现(注意,同样要保证所有的document都可以转化为Student类型)
var linquery = from e in collection.AsQueryable<Student>() where e.age > 20 select e; var linquery1 = collection.AsQueryable<Student>().Where(e => e.age > 20);
MongoDB文档中有很多的LINQ查询操作,请参阅MongoDB文档的LINQ部分
更新数据
文档更新的方法有两种,通过Save方法进行整个文档替换,或者通过Update方法进行文档的部分更新。
例如,找到sid为9,并且name为Will9的这个文档,把age字段更新为27
Save方法
var query = Query.And(Query.EQ("sid", 9), Query.EQ("name", "Will9")); BsonDocument Will9 = collection.FindOne(query); if (Will9 != null) { Will9["age"] = 27; collection.Save(Will9); }
Update方法
var query = Query.And(Query.EQ("sid", 9), Query.EQ("name", "Will9")); var update = Update.Set("age", 27); collection.Update(query, update);
删除数据
删除数据的操作相对比较简单。
删除特定条件的文档:
var query = Query.EQ("sid", 9); collection.Remove(query);
删除所有文档:
collection.RemoveAll();
总结
通过这篇文章学习了MongoDB官方C# driver的基本操作。
三种查询方式中,Query Builder最灵活,使用LINQ方式查询是,最好所有的文档都有统一的模式,这样就可以方便的使用自定义类型。
郑重声明:本站内容如果来自互联网及其他传播媒体,其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享,并不代表本站赞同其观点和对其真实性负责,也不构成任何其他建议。