RELATIONSHIP

Parameters

OrderNameTypeDesc
1queryConstThe relationship name/ID/phrase to search for

Returns

Places an asset list on the stack, and may conditionally also add a const to the stack describing direction.

Description

This function returns a single relationship by searching for the best match to the passed query value.

Unlike some other functions, RELATIONSHIP also does deeper searching.

If the function is unable to find a literal match to either the relationship name or id number, it will instead search the phrases (ie. the upstream name or downstream name).

If the command gets a name or id match, it will only add a relationship list containing that relationship.

However, if it gets a phrase match (ie. “part of”), it will also include the direction of the relationship described by that phrase.

Eg. 'Location' RELATIONSHIP will place a list containing a single relationship on the stack.

'Inside' RELATIONSHIP will add a list of relationships, then the const 'down'.

Macros

You can also access this function through the R macro.

See Also