hydra-0.8.0: Type-aware transformations for data and programs
Safe HaskellSafe-Inferred
LanguageHaskell2010

Hydra.Ext.Cypher.Features

Description

A model for characterizing OpenCypher queries and implementations in terms of included features.Based on the OpenCypher grammar and the list of standard Cypher functions at https://neo4j.com/docs/cypher-manual/current/functions. Current as of August 2024.

Synopsis

Documentation

data CypherFeatures Source #

A set of features which characterize an OpenCypher query or implementation. Any features which are omitted from the set are assumed to be unsupported or nonrequired.

Constructors

CypherFeatures 

Fields

data ArithmeticFeatures Source #

Arithmetic operations

Constructors

ArithmeticFeatures 

Fields

data AtomFeatures Source #

Various kinds of atomic expressions

Constructors

AtomFeatures 

Fields

data ComparisonFeatures Source #

Comparison operators and functions

Constructors

ComparisonFeatures 

Fields

data FunctionFeatures Source #

Standard Cypher functions

data AggregateFunctionFeatures Source #

Aggregate functions

Constructors

AggregateFunctionFeatures 

Fields

data DatabaseFunctionFeatures Source #

Database functions

Constructors

DatabaseFunctionFeatures 

Fields

data GenAIFunctionFeatures Source #

GenAI functions

Constructors

GenAIFunctionFeatures 

Fields

data GraphFunctionFeatures Source #

Graph functions

Constructors

GraphFunctionFeatures 

Fields

data ListFunctionFeatures Source #

List functions

Constructors

ListFunctionFeatures 

Fields

data LoadCSVFunctionFeatures Source #

Load CSV functions

Constructors

LoadCSVFunctionFeatures 

Fields

data LogarithmicFunctionFeatures Source #

Logarithmic functions

Constructors

LogarithmicFunctionFeatures 

Fields

Instances

Instances details
Read LogarithmicFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Show LogarithmicFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Eq LogarithmicFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Ord LogarithmicFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

data NumericFunctionFeatures Source #

Numeric functions

Constructors

NumericFunctionFeatures 

Fields

  • numericFunctionFeaturesAbs :: Bool

    The abs() function. Returns the absolute value of a FLOAT.; Returns the absolute value of an INTEGER.

  • numericFunctionFeaturesCeil :: Bool

    The ceil() function. Returns the smallest FLOAT that is greater than or equal to a number and equal to an INTEGER.

  • numericFunctionFeaturesFloor :: Bool

    The floor() function. Returns the largest FLOAT that is less than or equal to a number and equal to an INTEGER.

  • numericFunctionFeaturesIsNaN :: Bool

    The isNaN() function. Returns true if the floating point number is NaN.; Returns true if the integer number is NaN.

  • numericFunctionFeaturesRand :: Bool

    The rand() function. Returns a random FLOAT in the range from 0 (inclusive) to 1 (exclusive).

  • numericFunctionFeaturesRound :: Bool

    The round() function. Returns the value of a number rounded to the nearest INTEGER.; Returns the value of a number rounded to the specified precision using rounding mode HALF_UP.; Returns the value of a number rounded to the specified precision with the specified rounding mode.

  • numericFunctionFeaturesSign :: Bool

    The sign() function. Returns the signum of a FLOAT: 0 if the number is 0, -1 for any negative number, and 1 for any positive number.; Returns the signum of an INTEGER: 0 if the number is 0, -1 for any negative number, and 1 for any positive number.

data PredicateFunctionFeatures Source #

Predicate functions

Constructors

PredicateFunctionFeatures 

Fields

data ScalarFunctionFeatures Source #

Scalar functions

Constructors

ScalarFunctionFeatures 

Fields

data SpatialFunctionFeatures Source #

Spatial functions

Constructors

SpatialFunctionFeatures 

Fields

  • spatialFunctionFeaturesPoint_distance :: Bool

    The point.distance() function. Returns a FLOAT representing the geodesic distance between any two points in the same CRS.

  • spatialFunctionFeaturesPoint :: Bool

    The point() function. Returns a 2D point object, given two coordinate values in the Cartesian coordinate system.; Returns a 3D point object, given three coordinate values in the Cartesian coordinate system.; Returns a 2D point object, given two coordinate values in the WGS 84 geographic coordinate system.; Returns a 3D point object, given three coordinate values in the WGS 84 geographic coordinate system.

  • spatialFunctionFeaturesPoint_withinBBox :: Bool

    The point.withinBBox() function. Returns true if the provided point is within the bounding box defined by the two provided points, lowerLeft and upperRight.

data StringFunctionFeatures Source #

String functions

Constructors

StringFunctionFeatures 

Fields

  • stringFunctionFeaturesBtrim :: Bool

    The btrim() function. Returns the given STRING with leading and trailing whitespace removed.; Returns the given STRING with leading and trailing trimCharacterString characters removed. Introduced in 5.20.

  • stringFunctionFeaturesLeft :: Bool

    The left() function. Returns a STRING containing the specified number (INTEGER) of leftmost characters in the given STRING.

  • stringFunctionFeaturesLower :: Bool

    The lower() function. Returns the given STRING in lowercase. This function is an alias to the toLower() function, and it was introduced as part of Cypher's GQL conformance. Introduced in 5.21.

  • stringFunctionFeaturesLtrim :: Bool

    The ltrim() function. Returns the given STRING with leading whitespace removed.; Returns the given STRING with leading trimCharacterString characters removed. Introduced in 5.20.

  • stringFunctionFeaturesNormalize :: Bool

    The normalize() function. Returns the given STRING normalized according to the normalization CypherFunctionForm NFC. Introduced in 5.17.; Returns the given STRING normalized according to the specified normalization CypherFunctionForm. Introduced in 5.17.

  • stringFunctionFeaturesReplace :: Bool

    The replace() function. Returns a STRING in which all occurrences of a specified search STRING in the given STRING have been replaced by another (specified) replacement STRING.

  • stringFunctionFeaturesReverse :: Bool

    The reverse() function. Returns a STRING in which the order of all characters in the given STRING have been reversed.

  • stringFunctionFeaturesRight :: Bool

    The right() function. Returns a STRING containing the specified number of rightmost characters in the given STRING.

  • stringFunctionFeaturesRtrim :: Bool

    The rtrim() function. Returns the given STRING with trailing whitespace removed.; Returns the given STRING with trailing trimCharacterString characters removed. Introduced in 5.20.

  • stringFunctionFeaturesSplit :: Bool

    The split() function. Returns a LISTSTRING resulting from the splitting of the given STRING around matches of the given delimiter.; Returns a LISTSTRING resulting from the splitting of the given STRING around matches of any of the given delimiters.

  • stringFunctionFeaturesSubstring :: Bool

    The substring() function. Returns a substring of the given STRING, beginning with a 0-based index start.; Returns a substring of a given length from the given STRING, beginning with a 0-based index start.

  • stringFunctionFeaturesToLower :: Bool

    The toLower() function. Returns the given STRING in lowercase.

  • stringFunctionFeaturesToString :: Bool

    The toString() function. Converts an INTEGER, FLOAT, BOOLEAN, POINT or temporal type (i.e. DATE, ZONED TIME, LOCAL TIME, ZONED DATETIME, LOCAL DATETIME or DURATION) value to a STRING.

  • stringFunctionFeaturesToStringOrNull :: Bool

    The toStringOrNull() function. Converts an INTEGER, FLOAT, BOOLEAN, POINT or temporal type (i.e. DATE, ZONED TIME, LOCAL TIME, ZONED DATETIME, LOCAL DATETIME or DURATION) value to a STRING, or null if the value cannot be converted.

  • stringFunctionFeaturesToUpper :: Bool

    The toUpper() function. Returns the given STRING in uppercase.

  • stringFunctionFeaturesTrim :: Bool

    The trim() function. Returns the given STRING with leading and trailing whitespace removed.; Returns the given STRING with the leading and/or trailing trimCharacterString character removed. Introduced in 5.20.

  • stringFunctionFeaturesUpper :: Bool

    The upper() function. Returns the given STRING in uppercase. This function is an alias to the toUpper() function, and it was introduced as part of Cypher's GQL conformance. Introduced in 5.21.

data TemporalDurationFunctionFeatures Source #

Temporal duration functions

Constructors

TemporalDurationFunctionFeatures 

Fields

Instances

Instances details
Read TemporalDurationFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Show TemporalDurationFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Eq TemporalDurationFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Ord TemporalDurationFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

data TemporalInstantFunctionFeatures Source #

Temporal instant functions

Constructors

TemporalInstantFunctionFeatures 

Fields

Instances

Instances details
Read TemporalInstantFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Show TemporalInstantFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Eq TemporalInstantFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Ord TemporalInstantFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

data TrigonometricFunctionFeatures Source #

Trigonometric functions

Constructors

TrigonometricFunctionFeatures 

Fields

Instances

Instances details
Read TrigonometricFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Show TrigonometricFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Eq TrigonometricFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Ord TrigonometricFunctionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

data VectorFunctionFeatures Source #

Vector functions

Constructors

VectorFunctionFeatures 

Fields

data LiteralFeatures Source #

Various types of literal values

Constructors

LiteralFeatures 

Fields

data NodePatternFeatures Source #

Node patterns

Constructors

NodePatternFeatures 

Fields

data ProcedureCallFeatures Source #

Procedure calls

Constructors

ProcedureCallFeatures 

Fields

data ProjectionFeatures Source #

Projections

Constructors

ProjectionFeatures 

Fields

data QuantifierFeatures Source #

Quantifier expressions

Constructors

QuantifierFeatures 

Fields

data RangeLiteralFeatures Source #

Range literals within relationship patterns

Constructors

RangeLiteralFeatures 

Fields

data RelationshipDirectionFeatures Source #

Relationship directions / arrow patterns

Constructors

RelationshipDirectionFeatures 

Fields

Instances

Instances details
Read RelationshipDirectionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Show RelationshipDirectionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Eq RelationshipDirectionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Ord RelationshipDirectionFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

data RelationshipPatternFeatures Source #

Relationship patterns

Constructors

RelationshipPatternFeatures 

Fields

Instances

Instances details
Read RelationshipPatternFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Show RelationshipPatternFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Eq RelationshipPatternFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

Ord RelationshipPatternFeatures Source # 
Instance details

Defined in Hydra.Ext.Cypher.Features

data SetFeatures Source #

Set definitions

Constructors

SetFeatures 

Fields