Skip to main content
Version: 8.1

system.mongodb.insertOne

New in 8.1.28

This function is used in Python Scripting.

note

Project Library scripts will not provide hints for MongoDB system functions unless the Script Hint Scope is set to Gateway. See the Scripting in Ignition page for more details on scripting hints.

Description​

Inserts a single PyDictionary into a specified collection.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.mongodb.insertOne(connector, collection, document, [options])

Parameters​

TypeParameterDescription
StringconnectorThe name of connector (case-insensitive).
StringcollectionThe name of collection (case-sensitive).
PyDictionarydocumentA PyDictionary of specified fields that will represent a record being added to the collection. See MongoDB documentation for more details about documents.
PyDictionaryoptionsA PyDictionary for including additional insert configurations. [optional].

Returns​

PyObject objectId - Key of inserted document. This will usually be BSON document ObjectId, unless a different key type is specified.

Scope​

Gateway, Perspective Session

Importing Classes​

You can import classes from system.mongodb.types like you would other Python classes:

Example​

from system.mongodb.types import ObjectId
 
newObjectId = ObjectId.get()

You can also iterate those system.mongodb.types packages to see all available classes:

Example​

for d in dir(system.mongodb.types):
    print d

API Docs​

MongoDB-specific data types come from the org.bson.types package of the Mongo Java Driver API. The library of classes available for import can be accessed at this link: Mongo Java Driver 3.6.0 API Docs for Package org.bson.types.

Types References​

The following values can be referenced for the types parameter at system.mongodb.types:

Binary
Code
CodeWScope
CodeWithScope
Decimal128
INSTANCE
MaxKey
MinKey
ObjectId
Symbol
Timestamp

Code Examples​

Example #1
# Import required BSON types.

from system.mongodb.types import ObjectId
from system.mongodb.types import Timestamp

# Specify required document fields in a PyDictionary format for BSON document.
document = {
                "_id": ObjectId(),
                "transaction_count": 0,
                "bucket_start_date": Timestamp(),
                "bucket_end_date": '',
                "transactions": []
                
            }
  
# Apply parameters for function call.
print system.mongodb.insertOne("MongoDB", "transactions", document)