スクリプト開発 / コネクターオブジェクト DFF.CONN / MongoDB

MongoDB コネクター操作オブジェクトは、主に MongoDB を操作するためのメソッドを提供します。

DFF.CONN(...) のパラメータは次のとおりです。

パラメータ	型	必須 / デフォルト値	説明
connector_id	str	必須	コネクター ID
database	str	None	データベースを指定

.db(...)

データベース操作オブジェクトを取得します。パラメータは次のとおりです。

パラメータ	型	必須 / デフォルト値	説明
db_name	str	None	データベース名。名前を渡さない場合は、デフォルトのデータベース操作オブジェクトを返します。

# デフォルトのデータベースオブジェクトを取得
db = helper.db()
# 指定したデータベースオブジェクトを取得
db = helper.db('some_db')
# コレクションオブジェクトを取得
collection = db['some_collection']
# クエリ処理
data = collection.find_one()
# 1行で記述
data = helper.db('some_db')['some_collection'].find_one()

db_name を渡さない場合は、コネクターに設定されているデフォルトのデータベースを使用します。コネクターにデフォルトのデータベースが設定されていない場合は、データベース名を明示的に渡す必要があります。

.list_databases(...)

現在の接続でアクセス可能なデータベース名のリストを返します。

database_names = helper.list_databases()

.list_collections(...)

指定したデータベース内のコレクション名のリストを返します。

パラメータ	型	必須 / デフォルト値	説明
db_name	str	None	データベース名。省略時はコネクターに設定されているデフォルトのデータベースを使用します

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 実行時に指定するデータベースを渡せます。 渡さない場合はデフォルトのデータベースです。 名前付き引数として渡す必要があります

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 公式ドキュメントを参照してください。