跳转至

脚本开发 / 连接器对象 DFF.CONN / MongoDB

MongoDB 连接器操作对象主要提供一些操作 MongoDB 的方法。

DFF.CONN(...) 参数如下:

参数 类型 必须 / 默认值 说明
connector_id str 必须 连接器 ID
database str None 指定数据库

.db(...)

获取数据库操作对象,参数如下:

参数 类型 必须 / 默认值 说明
db_name str None 数据库名。未传递名称时,返回默认数据库操作对象。
示例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# 获取默认数据库对象
db = helper.db()
# 获取指定数据库对象
db = helper.db('some_db')
# 获取集合对象
collection = db['some_collection']
# 查询处理
data = collection.find_one()
# 写成一行
data = helper.db('some_db')['some_collection'].find_one()

未传入 db_name 时使用连接器配置的默认数据库;如果连接器没有配置默认数据库,应显式传入数据库名。

.list_databases(...)

返回当前连接可访问的数据库名称列表。

示例
1
database_names = helper.list_databases()

.list_collections(...)

返回指定数据库中的集合名称列表。

参数 类型 必须 / 默认值 说明
db_name str None 数据库名;省略时使用连接器配置的默认数据库
示例
1
collection_names = helper.list_collections('some_db')

.run_method(...)

.run_method(...) 是旧版兼容方法,用于获取数据库列表或集合列表。新代码应优先使用 .list_databases(...).list_collections(...)

参数 类型 必须 / 默认值 说明
method str 必须 执行方法,枚举:
"list_database_names":列出数据库
"list_collection_names":列出集合
db_name str None 执行 "list_collection_names" 时可传递,指定数据库;
不传递则为默认数据库
必须以命名参数方式传递
示例
1
2
3
db_list = helper.run_method('list_database_names')
collection_list = helper.run_method('list_collection_names')
collection_list = helper.run_method('list_collection_names', db_name='some_db')

具体查询语法和格式请参考 MongoDB 官方文档。