Page History

...

Multiexcerpt

MultiExcerptName	fetch

Name	Type		Direction	Description
handle	MongoDBHandle		in	Handle to a result set that has been created by a find action.
result	String	Resulting document in JSON format.	out	Fetched document. Depending on the type specified on this parameter, the resulting document is either presented in extended JSON format (String), or serialized into model structures (<document class>).
result	<document class>	Objects of an xUML class representing the document structure.	out

Anchor

	aggregate
	aggregate

Action "aggregate"

Multiexcerpt

MultiExcerptName	aggregate

Name

Type

Direction

Description

database

String

in

Multiexcerpt include

MultiExcerptName	database
PageWithExcerpt	MongoDB

collection

String

in

Multiexcerpt include

MultiExcerptName	collection
PageWithExcerpt	MongoDB

pipeline

Array of String

in

Pipeline you want to use with aggregation.

Multiexcerpt

MultiExcerptName	pipeline

Each array element must be a MongDB pipeline step as valid JSON.

handle

MongoDBHandle

out

Handle to a result set. You can use fetch to get documents from this result set.

result

Array of String

Array of all resulting documents in JSON format.

out

Multiexcerpt include

MultiExcerptName	result
PageWithExcerpt	MongoDB

Array of <document class>

Array of objects of an xUML class representing the document structure.

Anchor

	insert
	insert

Action "insert"

Multiexcerpt

MultiExcerptName	insert

Name

Type

Direction

Description

database

String

in

Multiexcerpt include

MultiExcerptName	database
PageWithExcerpt	MongoDB

collection

String

in

Multiexcerpt include

MultiExcerptName	collection
PageWithExcerpt	MongoDB

document

in

A data structure representing the document you want to insert. The data structure will be serialized.

documents

Array of <document class>

in

Array of documents you want to insert. Each array element is treated as a single document parameter and all of them will be inserted.

...

Multiexcerpt

MultiExcerptName	update

Name

Type

Direction

Description

Allowed Values / Examples

database

String

in

Multiexcerpt include

MultiExcerptName	database
PageWithExcerpt	MongoDB

collection

String

in

Multiexcerpt include

MultiExcerptName	collection
PageWithExcerpt	MongoDB

pipeline

Array of String

in

Pipeline you want to use with update.

Multiexcerpt include

MultiExcerptName	pipeline
PageWithExcerpt	MongoDB

options

MongoDBUpdateOptions

in

MongoDB options for update.

nullifications

Array of String

in

An array of database fields to be set to NULL upon update.

The elements of the path to the field within the corresponding document are to be separated by a dot (see examples). You can use arrays with that notation (see example) only if arrayFilters have been provided with the MongoDB update options.

customer.address
customer.address.street
customer.phoneArray.$[elem].number

removals

Array of String

in

An array of database fields to be removed upon update.

The elements of the path to the field within the corresponding document are to be separated by a dot (see examples). You can use arrays with that notation (see example) only if arrayFilters have been provided with the MongoDB update options.

customer.address
customer.address.street
customer.phoneArray.$[elem].number

queryString

String

in

Multiexcerpt include

MultiExcerptName	queryString
PageWithExcerpt	MongoDB

MongoDB query string as valid JSON

document

Any <document class>

in

A data structure representing the document you want to insert. For this, the following rules apply:

unset top-level fields will be skipped
complex fields will be replaced entirely

updateString

String

in

MongoDB JSON update string.

Info
In contrast to the MongoDB shell, the JSON keys must be quoted properly.

Refer to Querying MongoDB for a comprehensive explanation of how to build an update string and the implications.

MongoDB update string as valid JSON

{ "$set": {
      "address": {
            "city": "Dallas"
      }
}

{ "$set": {
      "address.city": "Dallas"
      }
}

rowsAffected

Integer

out

Multiexcerpt

MultiExcerptName	rowsAffected

Returns how many rows have been affected by the action.

Info
This information may be unavailable depending on the acknowledgement settings on the <<MongoDBAlias>>. If the Runtime cannot retrieve this information, rowsAffected will be NULL.

Anchor

	replace
	replace

Action "replace"

Multiexcerpt

MultiExcerptName	update

Name

Type

Direction

Description

Allowed Values / Examples

database

String

in

Multiexcerpt include

MultiExcerptName	database
PageWithExcerpt	MongoDB

collection

String

in

Multiexcerpt include

MultiExcerptName	collection
PageWithExcerpt	MongoDB

options

MongoDBReplaceOptions

in

MongoDB options for replace.

queryString

String

in

Multiexcerpt include

MultiExcerptName	queryString
PageWithExcerpt	MongoDB

MongoDB query string as valid JSON

document

Any <document class>

in

A data structure representing the document you want to replace the selected document with. The old stored document will be replaced by the new one, the MongoDB _id, however, will not change.

rowsAffected

Integer

out

Multiexcerpt include

MultiExcerptName	rowsAffected
PageWithExcerpt	MongoDB

Anchor

	delete
	delete

Action "delete"

Multiexcerpt

MultiExcerptName	update

Name

Type

Direction

Description

Allowed Values / Examples

database

String

in

Multiexcerpt include

MultiExcerptName	database
PageWithExcerpt	MongoDB

collection

String

in

Multiexcerpt include

MultiExcerptName	collection
PageWithExcerpt	MongoDB

queryString

String

in

Multiexcerpt include

MultiExcerptName	queryString
PageWithExcerpt	MongoDB

MongoDB query string as valid JSON

rowsAffected

Integer

out

Multiexcerpt include

MultiExcerptName	rowsAffected
PageWithExcerpt	MongoDB

...

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Action "aggregate"

Action "insert"

Action "replace"

Action "delete"