跳轉至

腳本開發 / 連接器對象 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 官方文檔。