MongoDB Delete Activity¶

Introduction¶

A MongoDB Delete activity, using its MongoDB connection, deletes data from a MongoDB collection and is intended to be used as a target to consume data in an operation.

Create a MongoDB Delete Activity¶

An instance of a MongoDB Delete activity is created from a MongoDB connection using its Delete activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an Activity Instance in Component Reuse.

An existing MongoDB Delete activity can be edited from these locations:

• The design canvas (see Component Actions Menu in Design Canvas).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).

Configure a MongoDB Delete Activity¶

Follow these steps to configure a MongoDB Delete activity:

• Step 1: Enter a Name and Select a Collection
  Provide a name for the activity and select a collection.

• Step 2: Specify Settings
  Specify the Filter, Locale, and Write Document IDs in Response.

• Step 3: Review the Data Schemas
  Any request or response schemas are displayed.

Step 1: Enter a Name and Select a Collection¶

In this step, provide a name for the activity and select a collection. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each MongoDB Delete activity and must not contain forward slashes / or colons :.

• Select an Object: This section displays collections available in the MongoDB endpoint.

  • Selected MongoDB Object: After a collection is selected, it is listed here.

  • Search: Enter any part of the collection name into the search box to filter the list of collections. The search is not case-sensitive. If collections are already displayed within the table, the table results are filtered in real time with each keystroke. To reload collections from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload collections from the MongoDB endpoint. This may be useful if collections have been added to MongoDB. This action refreshes all metadata used to build the table of collections displayed in the configuration.

  • Selecting a Collection: Within the table, click anywhere on a row to select an collection. Only one collection can be selected. The information available for each collection is fetched from the MongoDB endpoint:

    • Name: The name of the collection.

    • Description: The description of the collection.

  Tip

  If the table does not populate with available collections, the MongoDB connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Specify Settings¶

In this step, specify the Filter, Locale, and Write Document IDs in Response. Each user interface element of this step is described below.

• Filter: Enter a filter (in MongoDB Extended JSON format) to use to match the documents to be deleted from the selected collection.

• Locale: Enter a locale to specify a language for the documents in the selected collection. For example, pt specifies Portuguese. If empty, en (English) is used.

• Write Document IDs in Response: Select to specify that the document IDs of deleted documents are written in the response.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the Data Schemas¶

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  Note

  Data supplied in a transformation takes precedence over the activity configuration.

  The MongoDB connector uses the MongoDB Java Driver v4.1. Refer to the driver documentation and the MongoDB reference for information on the schema nodes and fields.

  The Delete activity uses XML in both its request and response schemas.

  The request and response data schemas consist of these nodes and fields:

  • Request:

    Request Schema Field/Node	Description
    deleteRequest	Request to delete documents from the database
    filter	A filter in MongoDB Extended JSON format used to match the documents to be deleted from the selected collection
    locale	Locale to specify a language for the documents in the selected collection
    documentId	Whether to write document IDs in the response

  • Response:

    Response Schema Field/Node	Description
    deleteResponse	Response from deleting documents in the database
    number_of_deleted_documents	Number of documents (records) deleted
    documents	Node representing the documents
    documentId	ID of the deleted document
    error	Node representing any errors
    errorMessage	Error message

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the MongoDB endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring a MongoDB Delete activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

MongoDB Delete activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-transformation Pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.