Package io.github.fupacat.ast

Class VectorSearchTableReference

java.lang.Object

io.github.fupacat.ast.TSqlFragment

io.github.fupacat.ast.TableReference

io.github.fupacat.ast.TableReferenceWithAlias

io.github.fupacat.ast.VectorSearchTableReference

All Implemented Interfaces:

Serializable

public class VectorSearchTableReference
extends TableReferenceWithAlias

Represents the VECTOR_SEARCH table-valued function call.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
ColumnReferenceExpression	Column	The vector column in which search is performed.
boolean	ForceAnnOnly	Whether the WITH (FORCE_ANN_ONLY) hint is specified.
StringLiteral	Metric	The distance metric to use for the search.
ScalarExpression	SimilarTo	The vector used for search.
TableReferenceWithAlias	Table	Table on which perform the search.
ScalarExpression	TopN	The maximum number of similar vectors that must be returned.

Fields inherited from class io.github.fupacat.ast.TableReferenceWithAlias

Alias, ForPath

Fields inherited from class io.github.fupacat.ast.TSqlFragment

firstTokenIndex, lastTokenIndex, ScriptTokenStream, Value

Constructor Summary

Constructors

Constructor	Description
VectorSearchTableReference()

Method Summary

Modifier and Type	Method	Description
void	accept(TSqlFragmentVisitor visitor)
void	acceptChildren(TSqlFragmentVisitor visitor)

Methods inherited from class io.github.fupacat.ast.TSqlFragment

SetIdentifier, SetUnquotedIdentifier, UpdateTokenInfo, UpdateTokenInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

Table

public TableReferenceWithAlias Table

Table on which perform the search.

Column

public ColumnReferenceExpression Column

The vector column in which search is performed.

SimilarTo

public ScalarExpression SimilarTo

The vector used for search.

Metric

public StringLiteral Metric

The distance metric to use for the search.

TopN

public ScalarExpression TopN

The maximum number of similar vectors that must be returned.

ForceAnnOnly

public boolean ForceAnnOnly

Whether the WITH (FORCE_ANN_ONLY) hint is specified.

Constructor Details

VectorSearchTableReference

public VectorSearchTableReference()

Method Details

accept

public void accept(TSqlFragmentVisitor visitor)

Overrides:

accept in class TableReferenceWithAlias

acceptChildren

public void acceptChildren(TSqlFragmentVisitor visitor)

Overrides:

acceptChildren in class TableReferenceWithAlias