Package org.elasticsearch.xpack.esql.expression.function.scalar.spatial

Class StDistance

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

org.elasticsearch.xpack.esql.expression.function.scalar.spatial.BinarySpatialFunction

org.elasticsearch.xpack.esql.expression.function.scalar.spatial.StDistance

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper

public class StDistance
extends BinarySpatialFunction
implements EvaluatorMapper

Computes the distance between two points. For cartesian geometries, this is the pythagorean distance in the same units as the original coordinates. For geographic geometries, this is the circular distance along the great circle in meters. The function `st_distance` is defined in the OGC Simple Feature Access standard. Alternatively it is described in PostGIS documentation at PostGIS:ST_Distance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	StDistance.CartesianDistanceCalculator
static class	StDistance.DistanceCalculator	This class is a CRS specific interface for generalizing distance calculations for the various possible ways that the geometries can be provided, from source, from evals, from literals and from doc values.
protected static class	StDistance.GeoDistanceCalculator

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.spatial.BinarySpatialFunction

BinarySpatialFunction.BinarySpatialComparator<T>, BinarySpatialFunction.SpatialCrsType, BinarySpatialFunction.SpatialTypeResolver

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final StDistance.DistanceCalculator	CARTESIAN
static final NamedWriteableRegistry.Entry	ENTRY
static final StDistance.DistanceCalculator	GEO

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.spatial.BinarySpatialFunction

leftDocValues, rightDocValues, spatialTypeResolver

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

MAX_BYTES_REF_RESULT_SIZE

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
	StDistance(Source source, Expression left, Expression right)
protected	StDistance(Source source, Expression left, Expression right, boolean leftDocValues, boolean rightDocValues)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
protected Object	fold(org.elasticsearch.geometry.Geometry leftGeom, org.elasticsearch.geometry.Geometry rightGeom)
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	left()
protected StDistance	replaceChildren(Expression newLeft, Expression newRight)
Expression	right()
Source	source()
EvalOperator.ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an EvalOperator.ExpressionEvaluator.
StDistance	withDocValues(boolean foundLeft, boolean foundRight)	Mark the function as expecting the specified fields to arrive as doc-values.

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.spatial.BinarySpatialFunction

crsType, equals, fold, hashCode, leftDocValues, resolveType, rightDocValues, setCrsType, spatialCRSCompatible, translatable, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

foldable, left, replaceChildren, right

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

fold

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

GEO

public static final StDistance.DistanceCalculator GEO

CARTESIAN

public static final StDistance.DistanceCalculator CARTESIAN

Constructor Details

StDistance

public StDistance(Source source,
 Expression left,
 Expression right)

StDistance

protected StDistance(Source source,
 Expression left,
 Expression right,
 boolean leftDocValues,
 boolean rightDocValues)

Method Details

withDocValues

public StDistance withDocValues(boolean foundLeft,
 boolean foundRight)

Description copied from class: BinarySpatialFunction

Mark the function as expecting the specified fields to arrive as doc-values.

Specified by:

withDocValues in class BinarySpatialFunction

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Specified by:

dataType in class Expression

replaceChildren

protected StDistance replaceChildren(Expression newLeft,
 Expression newRight)

Specified by:

replaceChildren in class BinaryScalarFunction

info

protected NodeInfo<? extends Expression> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<Expression>

fold

protected Object fold(org.elasticsearch.geometry.Geometry leftGeom,
 org.elasticsearch.geometry.Geometry rightGeom)

Specified by:

fold in class BinarySpatialFunction

toEvaluator

public EvalOperator.ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Description copied from interface: EvaluatorMapper

Convert this into an EvalOperator.ExpressionEvaluator.

Note for implementors: If you are implementing this function, you should call the passed-in lambda on your children, after doing any other manipulation (casting, etc.) necessary.

Note for Callers: If you are attempting to call this method, and you have an Expression and a Layout, you likely want to call EvalMapper.toEvaluator(org.elasticsearch.xpack.esql.core.expression.FoldContext, org.elasticsearch.xpack.esql.core.expression.Expression, org.elasticsearch.xpack.esql.planner.Layout) instead. On the other hand, if you already have something that looks like the parameter for this method, you should call this method with that function.

Build an EvalOperator.ExpressionEvaluator.Factory for the tree of expressions rooted at this node. This is only guaranteed to return a sensible evaluator if this node has a valid type. If this node is a subclass of Expression then "valid type" means that Expression.typeResolved() returns a non-error resolution. If Expression.typeResolved() returns an error then this method may throw. Or return an evaluator that produces garbage. Or return an evaluator that throws when run.

Specified by:

toEvaluator in interface EvaluatorMapper

source

Source source()

left

Expression left()

right

Expression right()