Skip to content

Bases: DataNode

Data Node stored in a Mongo collection.


Name Type Description
config_id str

Identifier of the data node configuration. It must be a valid Python identifier.

scope Scope

The scope of this data node.

id str

The unique identifier of this data node.

owner_id str

The identifier of the owner (sequence_id, scenario_id, cycle_id) or None.

parent_ids Optional[Set[str]]

The identifiers of the parent tasks or None.

last_edit_date datetime

The date and time of the last modification.

edits List[Edit]

The ordered list of edits for that job.

version str

The string indicates the application version of the data node to instantiate. If not provided, the current version is used.

validity_period Optional[timedelta]

The duration implemented as a timedelta since the last edit date for which the data node can be considered up-to-date. Once the validity period has passed, the data node is considered stale and relevant tasks will run even if they are skippable (see the Task management page for more details). If validity_period is set to None, the data node is always up-to-date.

edit_in_progress bool

True if a task computing the data node has been submitted and not completed yet. False otherwise.

editor_id Optional[str]

The identifier of the user who is currently editing the data node.

editor_expiration_date Optional[datetime]

The expiration date of the editor lock.

properties dict[str, Any]

A dictionary of additional properties. Note that the properties parameter must at least contain an entry for "db_name" and "collection_name":

  • "db_name" (str): The database name.

  • "collection_name" (str): The collection in the database to read from and to write the data to.

  • "custom_document" (Any): The custom document class to store, encode, and decode data when reading and writing to a Mongo collection.

  • "db_username" (str): The database username.

  • "db_password" (str): The database password.

  • "db_host" (str): The database host. The default value is "localhost".

  • "db_port" (int): The database port. The default value is 27017.

  • "db_driver" (str): The database driver.

  • "db_extra_args" (Dict[str, Any]): A dictionary of additional arguments to be passed into database connection string.