Mdbc 技术文档

1. 安装指南

1.1 安装 Mdbc 模块

Mdbc 是一个基于 MongoDB C# 驱动程序的 PowerShell 模块，适用于 PowerShell Core 7.4。你可以通过以下步骤安装 Mdbc 模块：

1. 打开 PowerShell 终端。

2. 运行以下命令从 PowerShell Gallery 安装 Mdbc 模块：

   Install-Module Mdbc
   

1.2 导入模块

安装完成后，你需要导入 Mdbc 模块以使用其功能：

Import-Module Mdbc

1.3 验证安装

导入模块后，你可以通过以下命令查看帮助文档和可用命令：

help about_Mdbc
help Connect-Mdbc
Get-Command -Module Mdbc

2. 项目使用说明

2.1 快速开始

在安装并导入 Mdbc 模块后，你可以按照以下步骤快速开始使用：

1. 确保 MongoDB 服务正在运行。

2. 使用 Connect-Mdbc 命令连接到 MongoDB 数据库和集合：

   Connect-Mdbc . test test -NewCollection
   

3. 添加文档到集合中：

   @{_id = 1; value = 42}, @{_id = 2; value = 3.14} | Add-MdbcData
   

4. 获取文档并显示：

   Get-MdbcData -As PS | Format-Table
   

5. 根据 _id 获取特定文档：

   Get-MdbcData @{_id = 1}
   

6. 更新文档中的字段：

   Update-MdbcData @{_id = 1} @{'$set' = @{value = 100}}
   

7. 删除文档：

   $doc = Get-MdbcData @{_id = 1}
   $doc | Remove-MdbcData
   

8. 统计文档数量：

   Get-MdbcData -Count
   

2.2 高级功能

Mdbc 模块还提供了一些高级功能，如参数补全、文件更新跟踪等：

• 参数补全：使用 Mdbc.ArgumentCompleters.ps1 脚本可以实现数据库和集合名称的自动补全。你可以通过以下命令安装该脚本：

  Install-Script Mdbc.ArgumentCompleters
  

• 文件更新跟踪：使用 Update-MongoFiles.ps1 脚本可以创建测试数据或跟踪文件的变化。

3. 项目 API 使用文档

3.1 驱动方法与模块命令对照表

驱动方法	模块命令	输出
Client
MongoClient	Connect-Mdbc	$Client $Database $Collection
GetDatabase	Get-MdbcDatabase	database(s)
DropDatabase	Remove-MdbcDatabase	none
Transactions	Use-MdbcTransaction	-
Watch	Watch-MdbcChange -Client	cursor
Database
RunCommand	Invoke-MdbcCommand	document
GetCollection	Get-MdbcCollection	collection(s)
CreateCollection	Add-MdbcCollection	none
RenameCollection	Rename-MdbcCollection	none
DropCollection	Remove-MdbcCollection	none
Watch	Watch-MdbcChange -Database	cursor
Collection
InsertOne	Add-MdbcData	none
InsertMany	Add-MdbcData -Many	none
Find	Get-MdbcData	documents
CountDocuments	Get-MdbcData -Count	count
Distinct	Get-MdbcData -Distinct	values
FindOneAndDelete	Get-MdbcData -Remove	old document
FindOneAndReplace	Get-MdbcData -Set	old or new document
FindOneAndUpdate	Get-MdbcData -Update	old or new document
DeleteOne	Remove-MdbcData	none or info (-Result)
DeleteMany	Remove-MdbcData -Many	none or info (-Result)
ReplaceOne	Set-MdbcData	none or info (-Result)
UpdateOne	Update-MdbcData	none or info (-Result)
UpdateMany	Update-MdbcData -Many	none or info (-Result)
Aggregate	Invoke-MdbcAggregate	documents
Watch	Watch-MdbcChange -Collection	cursor

3.2 常用命令示例

• 连接数据库和集合：

  Connect-Mdbc . test test -NewCollection
  

• 添加文档：

  @{_id = 1; value = 42} | Add-MdbcData
  

• 获取文档：

  Get-MdbcData @{_id = 1}
  

• 更新文档：

  Update-MdbcData @{_id = 1} @{'$set' = @{value = 100}}
  

• 删除文档：

  $doc = Get-MdbcData @{_id = 1}
  $doc | Remove-MdbcData
  

4. 项目安装方式

Mdbc 模块可以通过 PowerShell Gallery 进行安装。以下是安装步骤：

1. 打开 PowerShell 终端。

2. 运行以下命令安装 Mdbc 模块：

   Install-Module Mdbc
   

3. 安装完成后，导入模块：

   Import-Module Mdbc
   

通过以上步骤，你就可以成功安装并使用 Mdbc 模块了。