Skip to content

Script Development / Connector Object DFF.CONN / MongoDB

The MongoDB Connector operation object mainly provides some methods for operating MongoDB.

The DFF.CONN(...) parameters are as follows:

Parameter Type Required / Default Description
connector_id str Required Connector ID
database str None Specify the database

.db(...)

Get the database operation object, parameters are as follows:

Parameter Type Required / Default Description
db_name str None Database name. If no name is passed, the default database operation object is returned.
Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Get the default database object
db = helper.db()
# Get the specified database object
db = helper.db('some_db')
# Get the collection object
collection = db['some_collection']
# Query processing
data = collection.find_one()
# Written in one line
data = helper.db('some_db')['some_collection'].find_one()

When db_name is not passed, the default database configured in the Connector is used; if the Connector does not have a default database configured, the database name should be explicitly passed.

.list_databases(...)

Returns a list of database names accessible to the current connection.

Example
1
database_names = helper.list_databases()

.list_collections(...)

Returns a list of collection names in the specified database.

Parameter Type Required / Default Description
db_name str None Database name; if omitted, the default database configured in the Connector is used
Example
1
collection_names = helper.list_collections('some_db')

.run_method(...)

.run_method(...) is a legacy compatibility method used to obtain a list of databases or collections. New code should prefer .list_databases(...) and .list_collections(...).

Parameter Type Required / Default Description
method str Required Execution method, enumeration:
list_database_names: List databases
list_collection_names: List collections
db_name str None Can be passed when executing list_collection_names to specify the database;
if not passed, the default database is used
Must be passed as a named parameter
Example
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')

For specific query syntax and format, please refer to the official MongoDB documentation.