CTE.Ecto (Closure Table v2.0.6)

View Source

Most of the functions provided will accept the following options:

  • :limit, to limit the total number of nodes returned, when finding the ancestors or the descendants for nodes
  • :itself, accepting a boolean value. When true, the node used for finding its neighbors are returned as part of the results. Default: true
  • :nodes, accepting a boolean value. When true, the results are containing additional information about the nodes. Default: false

Summary

Functions

ancestors(descendant, opts, config)

Retrieve the ancestors of a node

delete(leaf, opts, config)

Delete a leaf or a subtree.

descendants(ancestor, opts, config)

Retrieve the descendants of a node

insert(leaf, ancestor, opts, config)

Insert a node under an existing ancestor

move(leaf, ancestor, opts, config)

Move a subtree from one location to another.

tree(leaf, opts, config)

Calculate and return a "tree" structure containing the paths and the nodes under the given leaf/node

Functions

ancestors(descendant, opts, config)

Retrieve the ancestors of a node

delete(leaf, opts, config)

Delete a leaf or a subtree.

To delete a leaf node set the limit option to: 1, and in this particular case all the nodes that reference the leaf will be assigned to the leaf's immediate ancestor

If limit is 0, then the leaf and its descendants will be deleted

descendants(ancestor, opts, config)

Retrieve the descendants of a node

insert(leaf, ancestor, opts, config)

Insert a node under an existing ancestor

move(leaf, ancestor, opts, config)

Move a subtree from one location to another.

First, the subtree and its descendants are disconnected from its ancestors. And second, the subtree is inserted under the new parent (ancestor) and the subtree, including its descendants, is declared as descendants of all the new ancestors.

tree(leaf, opts, config)

Calculate and return a "tree" structure containing the paths and the nodes under the given leaf/node