ProtoDB Writer
Introduction
The ProtoDB Writer module allows you to store, edit, and remove entries in a ProtoDB. It exposes two dedicated input connectors to control each of the basic ProtoDB operations: upsert and delete. To alter its contents, select a ProtoDB in the Property Panel and connect an entryset to the "Set Upsert Entryset" or "Set Delete Entryset" input connector. Entrysets that arrive at these input connectors specify modifications to be made to the ProtoDB, but no edits are actually enacted on the ProtoDB until an operation's corresponding "Do" input connector receives a message.
Matching Attributes
Matching attributes are attributes whose values are used to determine entry identity during ProtoDB operations. They are defined on the ProtoDB itself. Every valid ProtoDB must have at least one or more matching attributes specified. If an incoming entry has the same values in the matching attributes as an entry already in the ProtoDB, then that entry "matches"; otherwise, it does not. The exact use of matching depends on the operations as described below. Null values and duplicates are not allowed in matching attributes.
Upsert Operation
Any entries in the incoming entryset that match entries in the ProtoDB perform an update of those entries. Otherwise, non-matching entries in the incoming entryset are inserted into the ProtoDB.
Delete Operation
Any entries in the incoming entryset that match entries in the ProtoDB perform a delete of those entries. Otherwise, non-matching entries in the incoming entryset are ignored.
Property Panel:
ProtoDB Writer
- Create New Database...
- Opens a window to create a new ProtoDB.
- Select Database
- Specify the target ProtoDB in which information is stored.
- View
- Filters which ProtoDBs are displayed in the "Select Database" list according to their permissions.
- Description
- A description of the currently selected ProtoDB.
- Manage Databases...
- Opens a window that allows you to manage your ProtoDBs.
See Also:
Input Menu:
Set Upsert Entryset
Updates the value of entries in the incoming entryset that match ones in the specified ProtoDB; otherwise inserts entries that do not match. This upsert operation occurs only when the "Do Upsert" input connector receives a message.
Accepted Datatypes:
- Entryset
- Must match or contain a subset of the selected ProtoDB's attribute schema.
Set Delete Entryset
Deletes the entries in the incoming entryset that match ones in the specified ProtoDB. This delete operation occurs only when the "Do Delete" input connector receives a message.
Accepted Datatypes:
- Entryset
- Must match or contain a subset of the selected ProtoDB's attribute schema.
Set Proto Database
Sets which ProtoDB the data is written to.
Accepted Datatypes:
- Text
- The name of a currently accessible ProtoDB.
Triggered Outputs:
- Output Message:
- Get ProtoDB Name
Trigger Connectors → Do Trigger Upsert
Triggers an upsert operation on the entries sent to the "Set Upsert Entryset" input connector.
Accepted Datatypes:
- True/false
Trigger Connectors → Do Trigger Delete
Triggers a delete operation on the entries sent to the "Set Delete Entryset" input connector.
Accepted Datatypes:
- True/false
Output Menu:
Get Database Name
Gets the name of the currently selected database.
Output Datatype:
- Text
Triggered By:
- Input Message:
- Set ProtoDB
Get Updated Rows Count
Gets the number of rows updated in the last ProtoDB transaction.
Output Datatype:
- Number
Triggered By:
Get Inserted Rows Count
Gets the number of rows inserted in the last ProtoDB transaction.
Output Datatype:
- Number
Triggered By:
Get Deleted Rows Count
Gets the number of rows deleted in the last ProtoDB transaction.
Output Datatype:
- Number