Module org.neo4j.cypherdsl.core
Package org.neo4j.cypherdsl.core

Class Functions

java.lang.Object
org.neo4j.cypherdsl.core.Functions
@API(status=DEPRECATED, since="2023.9.0") @Deprecated(since="2023.9.0") public final class Functions extends Object
Deprecated.
use Cypher instead. This class will become package private in the next major release and no longer be accessible.
Factory methods for creating instances of functions.
Since:
1.0
Author:
Michael J. Simons, Gerrit Meier, Romain Rossi

  • Method Details

    • id

      @NotNull @Contract(pure=true) @Deprecated(since="2023.3.0") public static @NotNull FunctionInvocation id(@NotNull @NotNull Node node)
      Deprecated.
      see elementId(Node) for a replacement. Neo4j the database will remove support for id(n) at some point.
      Creates a function invocation for id{}. See id.
      Parameters:
      node - The node for which the internal id should be retrieved
      Returns:
      A function call for id() on a node.

    • id

      @NotNull @Contract(pure=true) @Deprecated(since="2023.3.0") public static @NotNull FunctionInvocation id(@NotNull @NotNull Relationship relationship)
      Deprecated.
      see elementId(Relationship) for a replacement. Neo4j the database will remove support for id(n) at some point.
      Creates a function invocation for id{}. See id.
      Parameters:
      relationship - The relationship for which the internal id should be retrieved
      Returns:
      A function call for id() on a relationship.

    • elementId

      @NotNull @Contract(pure=true) @Neo4jVersion(minimum="5.0.0") public static @NotNull FunctionInvocation elementId(@NotNull @NotNull Node node)
      Deprecated.
      Creates a function invocation for elementId{}.
      Parameters:
      node - The node for which the element id should be retrieved
      Returns:
      A function call for elementId() on a node.

    • elementId

      @NotNull @Contract(pure=true) @Neo4jVersion(minimum="5.0.0") public static @NotNull FunctionInvocation elementId(@NotNull @NotNull Relationship relationship)
      Deprecated.
      Creates a function invocation for elementId{}.
      Parameters:
      relationship - The relationship for which the element id should be retrieved
      Returns:
      A function call for elementId() on a relationship.

    • keys

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation keys(@NotNull @NotNull Node node)
      Deprecated.
      Creates a function invocation for keys{}. See keys.
      Parameters:
      node - The node which keys should be returned.
      Returns:
      A function call for keys() on an expression.
      Since:
      2021.0.2

    • keys

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation keys(@NotNull @NotNull Relationship relationship)
      Deprecated.
      Creates a function invocation for keys{}. See keys.
      Parameters:
      relationship - The relationship which keys should be returned.
      Returns:
      A function call for keys() on an expression.
      Since:
      2021.0.2

    • keys

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation keys(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for keys{}. See keys.
      Parameters:
      expression - The expressions which keys should be returned. Must resolve to a node, relationship or map.
      Returns:
      A function call for keys() on an expression.
      Since:
      2021.0.2

    • labels

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation labels(@NotNull @NotNull Node node)
      Deprecated.
      Creates a function invocation for labels{}. See labels.
      Parameters:
      node - The node for which the labels should be retrieved
      Returns:
      A function call for labels() on a node.

    • labels

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation labels(@NotNull @NotNull SymbolicName node)
      Deprecated.
      Creates a function invocation for labels{}. The symbolic name node must point to a node. This can't be checked during compile time, so please make sure of that.

      See labels.

      Parameters:
      node - The node for which the labels should be retrieved
      Returns:
      A function call for labels() on a node.
      Since:
      2023.2.0

    • type

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation type(@NotNull @NotNull Relationship relationship)
      Deprecated.
      Creates a function invocation for type{}. See type.
      Parameters:
      relationship - The relationship for which the type should be retrieved
      Returns:
      A function call for type() on a relationship.

    • type

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation type(@NotNull @NotNull SymbolicName relationship)
      Deprecated.
      Creates a function invocation for type{}. The symbolic name relationship must point to a relationship. This can't be checked during compile time, so please make sure of that.

      See type.

      Parameters:
      relationship - The relationship for which the type should be retrieved
      Returns:
      A function call for type() on a relationship.
      Since:
      2023.2.0

    • count

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation count(@NotNull @NotNull Node node)
      Deprecated.
      Parameters:
      node - The named node to be counted
      Returns:
      A function call for count() for one named node
      See Also:

    • count

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation count(Expression expression)
      Deprecated.
      Creates a function invocation for the count() function. See count.
      Parameters:
      expression - An expression describing the things to count.
      Returns:
      A function call for count() for an expression like Cypher.asterisk() etc.

    • countDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation countDistinct(@NotNull @NotNull Node node)
      Deprecated.
      Creates a function invocation for a count() function with DISTINCT added.
      Parameters:
      node - The named node to be counted
      Returns:
      A function call for count() for one named node
      See Also:

    • countDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation countDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for a count() function with DISTINCT added. See count.
      Parameters:
      expression - An expression describing the things to count.
      Returns:
      A function call for count() for an expression like Cypher.asterisk() etc.

    • properties

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation properties(Node node)
      Deprecated.
      Creates a function invocation for properties()) on nodes.
      Parameters:
      node - The node who's properties should be returned.
      Returns:
      A function call for properties())

    • properties

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation properties(Relationship relationship)
      Deprecated.
      Creates a function invocation for properties()) on relationships.
      Parameters:
      relationship - The relationship who's properties should be returned.
      Returns:
      A function call for properties())

    • properties

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation properties(MapExpression map)
      Deprecated.
      Creates a function invocation for properties()) on maps.
      Parameters:
      map - The map who's properties should be returned.
      Returns:
      A function call for properties())

    • coalesce

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation coalesce(Expression... expressions)
      Deprecated.
      Creates a function invocation for the coalesce() function. See coalesce.
      Parameters:
      expressions - One or more expressions to be coalesced
      Returns:
      A function call for coalesce.

    • left

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation left(Expression expression, Expression length)
      Deprecated.
      Creates a function invocation for the left() function. See left.
      Parameters:
      expression - An expression resolving to a string
      length - desired length
      Returns:
      A function call for left()
      Since:
      2023.0.2

    • ltrim

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation ltrim(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for the ltrim() function. See ltrim.
      Parameters:
      expression - An expression resolving to a string
      Returns:
      A function call for ltrim()
      Since:
      2023.0.2

    • replace

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation replace(Expression original, Expression search, Expression replace)
      Deprecated.
      Creates a function invocation for the replace() function. See replace.
      Parameters:
      original - An expression that returns a string
      search - An expression that specifies the string to be replaced in original.
      replace - An expression that specifies the replacement string.
      Returns:
      A function call for replace()
      Since:
      2023.0.2

    • reverse

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation reverse(@NotNull @NotNull Expression original)
      Deprecated.
      Creates a function invocation for the reverse() function. See reverse.
      Parameters:
      original - An expression that returns a string
      Returns:
      A function call for reverse()
      Since:
      2023.0.2

    • right

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation right(Expression expression, Expression length)
      Deprecated.
      Creates a function invocation for the right() function. See right.
      Parameters:
      expression - An expression resolving to a string
      length - desired length
      Returns:
      A function call for right()
      Since:
      2023.0.2

    • rtrim

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation rtrim(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for the rtrim() function. See rtrim.
      Parameters:
      expression - An expression resolving to a string
      Returns:
      A function call for rtrim()
      Since:
      2023.0.2

    • substring

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation substring(Expression original, Expression start, Expression length)
      Deprecated.
      Creates a function invocation for the substring() function. See rtrim.
      Parameters:
      original - An expression resolving to a string
      start - An expression that returns a positive integer, denoting the position at which the substring will begin.
      length - An expression that returns a positive integer, denoting how many characters of original will be returned.
      Returns:
      A function call for substring()
      Since:
      2023.0.2

    • toLower

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation toLower(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for the toLower() function. See toLower.
      Parameters:
      expression - An expression resolving to a string
      Returns:
      A function call for toLower() for one expression

    • toUpper

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation toUpper(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for the toUpper() function. See toUpper.
      Parameters:
      expression - An expression resolving to a string
      Returns:
      A function call for toLower() for one expression
      Since:
      2023.0.2

    • trim

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation trim(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for the trim() function. See trim.
      Parameters:
      expression - An expression resolving to a string
      Returns:
      A function call for trim() for one expression
      Since:
      2021.2.1

    • split

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation split(@NotNull @NotNull Expression expression, @NotNull @NotNull Expression delimiter)
      Deprecated.
      Creates a function invocation for the split() function. See split.
      Parameters:
      expression - An expression resolving to a string that should be split
      delimiter - The delimiter on which to split
      Returns:
      A function call for split()
      Since:
      2021.2.1

    • split

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation split(@NotNull @NotNull Expression expression, @NotNull @NotNull String delimiter)
      Deprecated.
      Creates a function invocation for the split() function. See split.
      Parameters:
      expression - An expression resolving to a string that should be split
      delimiter - The delimiter on which to split
      Returns:
      A function call for split()
      Since:
      2021.2.1

    • size

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation size(Expression expression)
      Deprecated.
      Creates a function invocation for the size() function. size can be applied to
      Parameters:
      expression - The expression who's size is to be returned
      Returns:
      A function call for size() for one expression

    • size

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation size(RelationshipPattern pattern)
      Deprecated.
      Creates a function invocation for the size() function. size can be applied to
      Parameters:
      pattern - The pattern for which size() should be invoked.
      Returns:
      A function call for size() for a pattern

    • exists

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation exists(Expression expression)
      Deprecated.
      Creates a function invocation for the exists() function. See exists.
      Parameters:
      expression - The expression who's existence is to be evaluated
      Returns:
      A function call for exists() for one expression

    • distance

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation distance(@NotNull @NotNull Expression point1, @NotNull @NotNull Expression point2)
      Deprecated.
      Creates a function invocation for the distance() function. See exists. Both points need to be in the same coordinate system.
      Parameters:
      point1 - Point 1
      point2 - Point 2
      Returns:
      A function call for distance()

    • point

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation point(MapExpression parameterMap)
      Deprecated.
      Creates a function invocation for the point() function. See point.
      Parameters:
      parameterMap - The map of parameters for point()
      Returns:
      A function call for point()

    • point

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation point(Expression expression)
      Deprecated.
      Creates a function invocation for the point() function. See point.

      This generic expression variant is useful for referencing a point inside a parameter or another map.

      Parameters:
      expression - An expression resolving to a valid map of parameters for point()
      Returns:
      A function call for point()
      Since:
      2021.0.0

    • point

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation point(Parameter<?> parameter)
      Deprecated.
      Creates a function invocation for the point() function. See point.
      Parameters:
      parameter - A parameter referencing a point()
      Returns:
      A function call for point()
      Since:
      2022.7.3

    • cartesian

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation cartesian(double x, double y)
      Deprecated.
      Convenience method for creating a 2d cartesian point
      Parameters:
      x - The x coordinate
      y - The y coordinate
      Returns:
      A function call for point()
      Since:
      2022.7.3

    • coordinate

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation coordinate(double longitude, double latitude)
      Deprecated.
      Convenience method for creating a 2d coordinate in the WGS 84 coordinate system
      Parameters:
      longitude - The longitude
      latitude - The latitude
      Returns:
      A function call for point()
      Since:
      2022.7.3

    • withinBBox

      public static FunctionInvocation withinBBox(Expression point, Expression lowerLeft, Expression upperRight)
      Deprecated.
      Creates a function invocation for the point.withinBBox function. See point.withinBBox.
      Parameters:
      point - The point to check
      lowerLeft - The lower left point of the bounding box (south-west coordinate)
      upperRight - The upper right point of the bounding box (north-east coordinate)
      Returns:
      A function call for point.withinBBox
      Since:
      2022.7.3

    • avg

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation avg(Expression expression)
      Deprecated.
      Creates a function invocation for the avg() function. See avg.
      Parameters:
      expression - The things to average
      Returns:
      A function call for avg()

    • avgDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation avgDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for the avg() function with DISTINCT added. See avg.
      Parameters:
      expression - The things to average
      Returns:
      A function call for avg()

    • collect

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation collect(@NotNull @NotNull Named variable)
      Deprecated.
      Creates a function invocation for the collect() function.
      Parameters:
      variable - The named thing to collect
      Returns:
      A function call for collect()
      See Also:

    • collectDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation collectDistinct(@NotNull @NotNull Named variable)
      Deprecated.
      Creates a function invocation for the collect() function with DISTINCT added.
      Parameters:
      variable - The named thing to collect
      Returns:
      A function call for collect()
      See Also:

    • collect

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation collect(Expression expression)
      Deprecated.
      Creates a function invocation for the collect() function. See collect.
      Parameters:
      expression - The things to collect
      Returns:
      A function call for collect()

    • collectDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation collectDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for the collect() function with DISTINCT added. See collect.
      Parameters:
      expression - The things to collect
      Returns:
      A function call for collect()

    • max

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation max(Expression expression)
      Deprecated.
      Creates a function invocation for the max() function. See max.
      Parameters:
      expression - A list from which the maximum element value is returned
      Returns:
      A function call for max()

    • maxDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation maxDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for the max() function with DISTINCT added. See max.
      Parameters:
      expression - A list from which the maximum element value is returned
      Returns:
      A function call for max()

    • min

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation min(Expression expression)
      Deprecated.
      Creates a function invocation for the min() function. See min.
      Parameters:
      expression - A list from which the minimum element value is returned
      Returns:
      A function call for min()

    • minDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation minDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for the min() function with DISTINCT added. See min.
      Parameters:
      expression - A list from which the minimum element value is returned
      Returns:
      A function call for min()

    • percentileCont

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation percentileCont(Expression expression, Number percentile)
      Deprecated.
      Creates a function invocation for the percentileCont() function. See percentileCont.
      Parameters:
      expression - A numeric expression
      percentile - A numeric value between 0.0 and 1.0
      Returns:
      A function call for percentileCont()

    • percentileContDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation percentileContDistinct(Expression expression, Number percentile)
      Deprecated.
      Creates a function invocation for the percentileCont() function with DISTINCT added. See percentileCont.
      Parameters:
      expression - A numeric expression
      percentile - A numeric value between 0.0 and 1.0
      Returns:
      A function call for percentileCont()

    • percentileDisc

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation percentileDisc(Expression expression, Number percentile)
      Deprecated.
      Creates a function invocation for the percentileDisc() function. See percentileDisc.
      Parameters:
      expression - A numeric expression
      percentile - A numeric value between 0.0 and 1.0
      Returns:
      A function call for percentileDisc()

    • percentileDiscDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation percentileDiscDistinct(Expression expression, Number percentile)
      Deprecated.
      Creates a function invocation for the percentileDisc() function with DISTINCT added. See percentileDisc.
      Parameters:
      expression - A numeric expression
      percentile - A numeric value between 0.0 and 1.0
      Returns:
      A function call for percentileDisc()

    • stDev

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation stDev(Expression expression)
      Deprecated.
      Creates a function invocation for the stDev() function. See stDev.
      Parameters:
      expression - A numeric expression
      Returns:
      A function call for stDev()

    • stDevDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation stDevDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for the stDev() function with DISTINCT added. See stDev.
      Parameters:
      expression - A numeric expression
      Returns:
      A function call for stDev()

    • stDevP

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation stDevP(Expression expression)
      Deprecated.
      Creates a function invocation for the stDevP() function. See stDevP.
      Parameters:
      expression - A numeric expression
      Returns:
      A function call for stDevP()

    • stDevPDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation stDevPDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for the stDevP() function with DISTINCT added. See stDevP.
      Parameters:
      expression - A numeric expression
      Returns:
      A function call for stDevP()

    • sum

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation sum(Expression expression)
      Deprecated.
      Creates a function invocation for the sum() function. See sum.
      Parameters:
      expression - An expression returning a set of numeric values
      Returns:
      A function call for sum()

    • sumDistinct

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation sumDistinct(Expression expression)
      Deprecated.
      Creates a function invocation for the sum() function with DISTINCT added. See sum.
      Parameters:
      expression - An expression returning a set of numeric values
      Returns:
      A function call for sum()

    • range

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation range(Integer start, Integer end)
      Deprecated.
      Parameters:
      start - the range's start
      end - the range's end
      Returns:
      A function call for range()
      See Also:

    • range

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation range(@NotNull @NotNull Expression start, @NotNull @NotNull Expression end)
      Deprecated.
      Parameters:
      start - the range's start
      end - the range's end
      Returns:
      A function call for range()
      See Also:

    • range

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation range(@NotNull @NotNull Integer start, @NotNull @NotNull Integer end, Integer step)
      Deprecated.
      Creates a function invocation for the range() function. See range.
      Parameters:
      start - the range's start
      end - the range's end
      step - the range's step
      Returns:
      A function call for range()
      See Also:

    • range

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation range(@NotNull @NotNull Expression start, @NotNull @NotNull Expression end, Expression step)
      Deprecated.
      Creates a function invocation for the range() function. See range.
      Parameters:
      start - the range's start
      end - the range's end
      step - the range's step
      Returns:
      A function call for range()

    • head

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation head(Expression expression)
      Deprecated.
      Creates a function invocation for the head() function. See head.
      Parameters:
      expression - A list from which the head element is returned
      Returns:
      A function call for head()

    • last

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation last(Expression expression)
      Deprecated.
      Creates a function invocation for the last() function. See last.
      Parameters:
      expression - A list from which the last element is returned
      Returns:
      A function call for last()

    • nodes

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation nodes(@NotNull @NotNull NamedPath path)
      Deprecated.
      Creates a function invocation for nodes{}. See nodes.
      Parameters:
      path - The path for which the number of nodes should be retrieved
      Returns:
      A function call for nodes() on a path.
      Since:
      1.1

    • nodes

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation nodes(@NotNull @NotNull SymbolicName symbolicName)
      Deprecated.
      Creates a function invocation for nodes{}. See nodes.
      Parameters:
      symbolicName - The symbolic name of a path for which the number of nodes should be retrieved
      Returns:
      A function call for nodes{} on a path represented by a symbolic name.
      Since:
      2020.1.5

    • relationships

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation relationships(@NotNull @NotNull NamedPath path)
      Deprecated.
      Creates a function invocation for relationships{}. See relationships.
      Parameters:
      path - The path for which the relationships should be retrieved
      Returns:
      A function call for relationships() on a path.
      Since:
      2020.0.2

    • relationships

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation relationships(@NotNull @NotNull SymbolicName symbolicName)
      Deprecated.
      Creates a function invocation for relationships{}. See relationships.
      Parameters:
      symbolicName - The symbolic name of a path for which the relationships should be retrieved
      Returns:
      A function call for relationships() on a path represented by a symbolic name.
      Since:
      2020.1.5

    • startNode

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation startNode(@NotNull @NotNull Relationship relationship)
      Deprecated.
      Creates a function invocation for startNode{}. See startNode.
      Parameters:
      relationship - The relationship for which the start node be retrieved
      Returns:
      A function call for startNode() on a path.
      Since:
      2020.0.2

    • endNode

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation endNode(@NotNull @NotNull Relationship relationship)
      Deprecated.
      Creates a function invocation for endNode{}. See endNode.
      Parameters:
      relationship - The relationship for which the end node be retrieved
      Returns:
      A function call for endNode() on a path.
      Since:
      2020.0.2

    • date

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation date()
      Deprecated.
      Creates a function invocation for date(). See date. This is the most simple form.
      Returns:
      A function call for date().
      Since:
      2020.1.0

    • calendarDate

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation calendarDate(Integer year, Integer month, Integer day)
      Deprecated.
      Creates a function invocation for date({}). See date.
      Parameters:
      year - The year
      month - The month
      day - The day
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • weekDate

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation weekDate(Integer year, Integer week, Integer dayOfWeek)
      Deprecated.
      Creates a function invocation for date({}). See date.
      Parameters:
      year - The year
      week - The optional week
      dayOfWeek - The optional day of the week
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • quarterDate

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation quarterDate(Integer year, Integer quarter, Integer dayOfQuarter)
      Deprecated.
      Creates a function invocation for date({}). See date.
      Parameters:
      year - The year
      quarter - The optional week
      dayOfQuarter - The optional day of the week
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • ordinalDate

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation ordinalDate(Integer year, Integer ordinalDay)
      Deprecated.
      Creates a function invocation for date({}). See date.
      Parameters:
      year - The year
      ordinalDay - The ordinal day of the year.
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • date

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation date(@NotNull @NotNull MapExpression components)
      Deprecated.
      Creates a function invocation for date({}). See date. This is the most generic form.
      Parameters:
      components - The map to pass to date({})
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • date

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation date(@NotNull @NotNull String temporalValue)
      Deprecated.
      Creates a function invocation for date({}). See date. This creates a date from a string.
      Parameters:
      temporalValue - A string representing a temporal value.
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • date

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation date(@NotNull @NotNull Expression temporalValue)
      Deprecated.
      Creates a function invocation for date({}). See date. This creates a date from a string.
      Parameters:
      temporalValue - An expression representing a temporal value.
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • datetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation datetime()
      Deprecated.
      Creates a function invocation for datetime({}). See datetime.
      Returns:
      A function call for datetime({}).
      Since:
      2020.1.0

    • datetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation datetime(@NotNull @NotNull TimeZone timeZone)
      Deprecated.
      Creates a function invocation for datetime({}). See datetime.
      Parameters:
      timeZone - The timezone to use when creating the temporal instance
      Returns:
      A function call for datetime({}).
      Since:
      2020.1.0

    • datetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation datetime(@NotNull @NotNull MapExpression components)
      Deprecated.
      Creates a function invocation for datetime({}). See datetime. This is the most generic form.
      Parameters:
      components - The map to pass to datetime({})
      Returns:
      A function call for datetime({}).
      Since:
      2020.1.0

    • datetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation datetime(@NotNull @NotNull String temporalValue)
      Deprecated.
      Creates a function invocation for datetime({}). See datetime. This creates a datetime from a string.
      Parameters:
      temporalValue - A string representing a temporal value.
      Returns:
      A function call for datetime({}).
      Since:
      2020.1.0

    • datetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation datetime(@NotNull @NotNull Expression temporalValue)
      Deprecated.
      Creates a function invocation for datetime({}). See datetime. This creates a datetime from a string.
      Parameters:
      temporalValue - An expression representing a temporal value.
      Returns:
      A function call for date({}).
      Since:
      2020.1.0

    • localdatetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localdatetime()
      Deprecated.
      Creates a function invocation for localdatetime({}). See localdatetime.
      Returns:
      A function call for localdatetime({}).
      Since:
      2020.1.0

    • localdatetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localdatetime(@NotNull @NotNull TimeZone timeZone)
      Deprecated.
      Creates a function invocation for localdatetime({}). See localdatetime.
      Parameters:
      timeZone - The timezone to use when creating the temporal instance
      Returns:
      A function call for localdatetime({}).
      Since:
      2020.1.0

    • localdatetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localdatetime(@NotNull @NotNull MapExpression components)
      Deprecated.
      Creates a function invocation for localdatetime({}). See localdatetime. This is the most generic form.
      Parameters:
      components - The map to pass to localdatetime({})
      Returns:
      A function call for localdatetime({}).
      Since:
      2020.1.0

    • localdatetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localdatetime(@NotNull @NotNull String temporalValue)
      Deprecated.
      Creates a function invocation for localdatetime({}). See localdatetime. This creates a localdatetime from a string.
      Parameters:
      temporalValue - A string representing a temporal value.
      Returns:
      A function call for localdatetime({}).
      Since:
      2020.1.0

    • localdatetime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localdatetime(@NotNull @NotNull Expression temporalValue)
      Deprecated.
      Creates a function invocation for localdatetime({}). See localdatetime. This creates a localdatetime from a string.
      Parameters:
      temporalValue - An expression representing a temporal value.
      Returns:
      A function call for localdatetime({}).
      Since:
      2020.1.0

    • localtime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localtime()
      Deprecated.
      Creates a function invocation for localtime({}). See localtime.
      Returns:
      A function call for localtime({}).
      Since:
      2020.1.0

    • localtime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localtime(@NotNull @NotNull TimeZone timeZone)
      Deprecated.
      Creates a function invocation for localtime({}). See localtime.
      Parameters:
      timeZone - The timezone to use when creating the temporal instance
      Returns:
      A function call for localtime({}).
      Since:
      2020.1.0

    • localtime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localtime(@NotNull @NotNull MapExpression components)
      Deprecated.
      Creates a function invocation for localtime({}). See localtime. This is the most generic form.
      Parameters:
      components - The map to pass to localtime({})
      Returns:
      A function call for localtime({}).
      Since:
      2020.1.0

    • localtime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localtime(@NotNull @NotNull String temporalValue)
      Deprecated.
      Creates a function invocation for localtime({}). See localtime. This creates a localtime from a string.
      Parameters:
      temporalValue - A string representing a temporal value.
      Returns:
      A function call for localtime({}).
      Since:
      2020.1.0

    • localtime

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation localtime(@NotNull @NotNull Expression temporalValue)
      Deprecated.
      Creates a function invocation for localtime({}). See localtime. This creates a localtime from a string.
      Parameters:
      temporalValue - An expression representing a temporal value.
      Returns:
      A function call for localtime({}).
      Since:
      2020.1.0

    • time

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation time()
      Deprecated.
      Creates a function invocation for time({}). See time.
      Returns:
      A function call for time({}).
      Since:
      2020.1.0

    • time

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation time(@NotNull @NotNull TimeZone timeZone)
      Deprecated.
      Creates a function invocation for time({}). See time.
      Parameters:
      timeZone - The timezone to use when creating the temporal instance
      Returns:
      A function call for time({}).
      Since:
      2020.1.0

    • time

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation time(@NotNull @NotNull MapExpression components)
      Deprecated.
      Creates a function invocation for time({}). See time. This is the most generic form.
      Parameters:
      components - The map to pass to time({})
      Returns:
      A function call for time({}).
      Since:
      2020.1.0

    • time

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation time(@NotNull @NotNull String temporalValue)
      Deprecated.
      Creates a function invocation for time({}). See time. This creates a time from a string.
      Parameters:
      temporalValue - A string representing a temporal value.
      Returns:
      A function call for time({}).
      Since:
      2020.1.0

    • time

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation time(@NotNull @NotNull Expression temporalValue)
      Deprecated.
      Creates a function invocation for time({}). See time. This creates a time from a string.
      Parameters:
      temporalValue - An expression representing a temporal value.
      Returns:
      A function call for time({}).
      Since:
      2020.1.0

    • duration

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation duration(@NotNull @NotNull MapExpression components)
      Deprecated.
      Creates a function invocation for duration({}). See duration. This is the most generic form.
      Parameters:
      components - The map to pass to duration({})
      Returns:
      A function call for duration({}).
      Since:
      2020.1.0

    • duration

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation duration(@NotNull @NotNull String temporalAmount)
      Deprecated.
      Creates a function invocation for duration({}). See duration. This creates a duration from a string.
      Parameters:
      temporalAmount - A string representing a temporal amount.
      Returns:
      A function call for duration({}).
      Since:
      2020.1.0

    • duration

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation duration(@NotNull @NotNull Expression temporalAmount)
      Deprecated.
      Creates a function invocation for duration({}). See duration. This creates a duration from a string.
      Parameters:
      temporalAmount - An expression representing a temporal amount.
      Returns:
      A function call for duration({}).
      Since:
      2020.1.0

    • shortestPath

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation shortestPath(Relationship relationship)
      Deprecated.
      Creates a function invocation for shortestPath({}).
      Parameters:
      relationship - The relationship to be passed to shortestPath.
      Returns:
      A function call for shortestPath({}).
      Since:
      2020.0.0

    • reduce

      @NotNull @Contract(pure=true) public static Reduction.OngoingDefinitionWithVariable reduce(@NotNull @NotNull SymbolicName variable)
      Deprecated.
      Starts building a function invocation for reduce({}).
      Parameters:
      variable - The closure will have a variable introduced in its context. We decide here which variable to use.
      Returns:
      An ongoing definition for a function call to reduce({}).
      Since:
      2020.1.5

    • abs

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation abs(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for abs({}). See abs.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for abs({}).
      Since:
      2021.0.0

    • ceil

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation ceil(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for ceil({}). See ceil.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for ceil({}).
      Since:
      2021.0.0

    • floor

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation floor(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for floor({}). See floor.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for floor({}).
      Since:
      2021.0.0

    • rand

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation rand()
      Deprecated.
      Creates a function invocation for rand({}). See rand.
      Returns:
      A function call for rand({}).
      Since:
      2021.0.0

    • round

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation round(Expression value, Expression... expression)
      Deprecated.
      Creates a function invocation for round({}). See round.
      Parameters:
      value - The value to round
      expression - Additional parameters, length must be 0, 1 or 2: First entry is the precision, second is the rounding mode
      Returns:
      A function call for round({}).
      Since:
      2021.0.0

    • sign

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation sign(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for sign({}). See sign.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for sign({}).
      Since:
      2021.0.0

    • e

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation e()
      Deprecated.
      Creates a function invocation for e({}). See e.
      Returns:
      A function call for e({}).
      Since:
      2021.0.0

    • exp

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation exp(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for exp({}). See exp.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for exp({}).
      Since:
      2021.0.0

    • log

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation log(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for log({}). See log.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for log({}).
      Since:
      2021.0.0

    • log10

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation log10(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for log10({}). See log10.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for log10({}).
      Since:
      2021.0.0

    • sqrt

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation sqrt(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for sqrt({}). See sqrt.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for sqrt({}).
      Since:
      2021.0.0

    • acos

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation acos(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for acos({}). See acos.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for acos({}).
      Since:
      2021.0.0

    • asin

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation asin(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for asin({}). See asin.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for asin({}).
      Since:
      2021.0.0

    • atan

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation atan(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for atan({}). See atan.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for atan({}).
      Since:
      2021.0.0

    • atan2

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation atan2(@NotNull @NotNull Expression y, @NotNull @NotNull Expression x)
      Deprecated.
      Creates a function invocation for atan2({}). See atan2.
      Parameters:
      y - the y value of a point
      x - the x value of a point
      Returns:
      A function call for atan2({}).
      Since:
      2021.0.0

    • cos

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation cos(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for cos({}). See cos.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for cos({}).
      Since:
      2021.0.0

    • cot

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation cot(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for cot({}). See cot.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for cot({}).
      Since:
      2021.0.0

    • degrees

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation degrees(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for degrees({}). See degrees.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for degrees({}).
      Since:
      2021.0.0

    • haversin

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation haversin(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for haversin({}). See haversin.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for haversin({}).
      Since:
      2021.0.0

    • pi

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation pi()
      Deprecated.
      Creates a function invocation for pi({}). See pi.
      Returns:
      A function call for pi({}).
      Since:
      2021.0.0

    • radians

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation radians(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for radians({}). See radians.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for radians({}).
      Since:
      2021.0.0

    • sin

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation sin(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for sin({}). See sin.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for sin({}).
      Since:
      2021.0.0

    • tan

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation tan(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for tan({}). See tan.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for tan({}).
      Since:
      2021.0.0

    • toInteger

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation toInteger(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for toInteger({}). See toInteger.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for toInteger({}).
      Since:
      2021.2.1

    • toString

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation toString(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for toString({}). See toString.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for toString({}).
      Since:
      2022.3.0

    • toStringOrNull

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation toStringOrNull(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for toStringOrNull({}). See toStringOrNull.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for toStringOrNull({}).
      Since:
      2023.0.2

    • toFloat

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation toFloat(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for toFloat({}). See toFloat.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for toFloat({}).
      Since:
      2021.2.1

    • toBoolean

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation toBoolean(@NotNull @NotNull Expression expression)
      Deprecated.
      Creates a function invocation for toBoolean({}). See toBoolean.
      Parameters:
      expression - The value to pass to the function.
      Returns:
      A function call for toBoolean({}).
      Since:
      2021.2.1

    • linenumber

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation linenumber()
      Deprecated.
      Creates a function invocation for linenumber({}). Only applicable inside an LOAD CSV clause.
      Returns:
      A function call for linenumber({}).
      Since:
      2021.2.1

    • file

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation file()
      Deprecated.
      Creates a function invocation for file({}). Only applicable inside an LOAD CSV clause.
      Returns:
      A function call for file({}).
      Since:
      2021.2.1

    • randomUUID

      public static FunctionInvocation randomUUID()
      Deprecated.
      Creates a function invocation for randomUUID({}). Only applicable inside an LOAD CSV clause.
      Returns:
      A function call for randomUUID({}).
      Since:
      2022.2.1

    • length

      @NotNull @Contract(pure=true) public static @NotNull FunctionInvocation length(@NotNull @NotNull NamedPath path)
      Deprecated.
      Creates a function invocation for length(). See length.
      Parameters:
      path - The path for which the length should be retrieved
      Returns:
      A function call for length() on a path.
      Since:
      2023.0.1

    • graphNames

      @NotNull @Contract(pure=true) @Neo4jVersion(minimum="5.0.0") public static @NotNull FunctionInvocation graphNames()
      Deprecated.
      Creates a function invocation for graph.names(). See graph.names.
      Returns:
      A function call for graph.names().
      Since:
      2023.4.0

    • graphPropertiesByName

      @NotNull @Contract(pure=true) @Neo4jVersion(minimum="5.0.0") public static @NotNull FunctionInvocation graphPropertiesByName(Expression name)
      Deprecated.
      Creates a function invocation for graph.propertiesByName(). See graph.propertiesByName.
      Parameters:
      name - The name of the graph
      Returns:
      A function call for graph.propertiesByName().
      Since:
      2023.4.0

    • graphByName

      @NotNull @Contract(pure=true) @Neo4jVersion(minimum="5.0.0") public static @NotNull FunctionInvocation graphByName(Expression name)
      Deprecated.
      Creates a function invocation for graph.byName(). See graph.byName.
      Parameters:
      name - The name of the graph
      Returns:
      A function call for graph.byName().
      Since:
      2023.4.0