Versions Compared

Old Version 46

changes.mady.by.user Cindy Hall

Saved on

compared with

New Version 47

changes.mady.by.user Cindy Hall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Field Type

Description

Label*

Default value: Sort
Example: Sort input streams

String

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Sort Paths*

Use this field set to provide the list of paths to sort on.

Sort path*

Default Value: None
Example: $person.first_name

String/Suggestion

Paths of values in the document to sort on. For example, if the sort paths are $first_name and $last_name, then the value at first_name is sorted first.

This field supports only scalar values such as string, number, date and so on.

Sort order*

Default value: global
Example: ascending

Dropdown list

Order of sorting. The available options are:

  • global

  • ascending

  • descending

Note

If you select the option global, the Sort order (Global) property becomes functional for the corresponding Sort path.

Sort order (Global)

Default value: ascending
Example: descending

Dropdown list

Sort the specified values in ascending or descending order.

Null greater

Default value: Not Selected
Example: Selected

Checkbox

If selected, null is considered greater than non-null values, and null values will be placed last when sorted in the ascending order.

  • If selected and Sort order is ascending, nulls appear at the end of the list.

  • If selected and Sort order is descending, nulls appear at the beginning of the list.

  • If not selected and Sort order is ascending, nulls appear at the beginning of the list.

  • If not selected and Sort order is descending, nulls appear at the end of the list.

An empty string is not considered as null and is always smaller than non-empty strings.

Null-safe access

Default value: Selected (True)  
Example: Deselected

Checkbox

Select this checkbox if you consider the values of non-existent or incorrect sort paths as null. If unselected, the Snap validates each input document to throw errors for non-existent or incorrect sort paths. Clearing this property will result in a lower performance.

Maximum memory

Default Value: 10
Example: 20

Integer

Specify the maximum memory to compute the size of the internal memory buffer for the external merge sort. The value you choose must be in MB or % , which you can specify in the Maximum memory unit. If its unit is %, the value of this property is the percentage of maximum used memory as compared to the maximum system memory.

  • This Snap uses temporary files to sort the input document streams and has a limitation by the size of the free disk space in a node. The Snap reads input documents and sorts them in a memory buffer. When the buffer size reaches the value specified, the Snap writes the data in the buffer into a temporary file, clears the buffer, and reads/sorts more input documents.

  • The maximum memory used by Sort Snap is 10 MB when the available memory in the node is lower than 500 MB to avoid out-of-memory crash.

  • If multiple instances of Sort Snap are simultaneously executed in the same Snaplex and the system memory size is limited, we recommend you to specify a lower value in this field.

  • On executing the Snap, the pipeline execution statistics display the following memory-related statistics:
    Free disk space, Available memory and Average document size.

Maximum memory unit

Default Value: %

Example: MB

Dropdown

Select the appropriate unit for the Maximum memory property.

  • %

  • MB

The buffer size ranges from 10 MB to 10 GB.

Minimum memory (MB)

Default value: 500 MB
Example: 750 MB

String/Expression

If the available memory is less than this property value while processing input documents, the Snap stops to fetch the next input document until more memory is available. This feature is disabled if this property value is 0.

Minimum free disc space (MB)

Default value: 500 MB
Example: 750 MB

String/Expression

If the free disc space is less than this property value, the Snap stops processing input documents until more free disc space is available. This feature is disabled if this property value is 0.

Out-of-resource timeout (minutes)

Default value: 30 minutes
Example: 40 minutes20

String/Expression

If the Snap pauses longer than this property value while waiting for more memory available, it throws an exception to prevent the system from running out of memory or disk space.

Snap Execution

Dropdown list

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

...