Package tech.ydb.yoj.repository.ydb.yql

Class YqlPredicate

java.lang.Object

tech.ydb.yoj.repository.ydb.yql.YqlPredicate

All Implemented Interfaces:

YqlStatementPart<YqlPredicate>

public abstract class YqlPredicate
extends Object
implements YqlStatementPart<YqlPredicate>

Represents a predicate: a boolean expression that can appear in the WHERE YQL clause.

To return valid YQL template for the predicate, including references to statement parameters (as ?) and entity fields (as {field.subfield}), call toYql().

To construct simple predicates, use static methods of this class, e.g., in() and eq(String, Object).

To invert your predicate, call negate() (instance method) or not(pred) (static method).
To combine predicates, use the and() and or() (both static and instance methods are available).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	YqlPredicate.FieldPredicateBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
YqlPredicate()

Method Summary

Modifier and Type	Method	Description
static YqlPredicate	alwaysFalse()
static YqlPredicate	alwaysTrue()
YqlPredicate.FieldPredicateBuilder	and(@NonNull String fieldPath)
static YqlPredicate	and(@NonNull Collection<YqlPredicate> predicates)
YqlPredicate	and(@NonNull YqlPredicate other)
static YqlPredicate	and(@NonNull YqlPredicate first, @NonNull YqlPredicate... rest)
final List<? extends YqlStatementPart<?>>	combine(@NonNull List<? extends YqlPredicate> others)
static <T> YqlPredicate	eq(@NonNull String fieldPath, T value)
final int	getPriority()
final String	getType()
final String	getYqlPrefix()
static <T> YqlPredicate	gt(@NonNull String fieldPath, T value)
static <T> YqlPredicate	gte(@NonNull String fieldPath, T value)
static <T> YqlPredicate	in(@NonNull String fieldPath, @NonNull Collection<@NonNull ? extends T> values)
static <T> YqlPredicate	in(@NonNull String fieldPath, T possibleValue, @NonNull T... restOfPossibleValues)
static YqlPredicate	like(@NonNull String fieldPath, @NonNull String value)
static YqlPredicate	like(@NonNull String fieldPath, @NonNull String value, Character escape)
static <T> YqlPredicate	lt(@NonNull String fieldPath, T value)
static <T> YqlPredicate	lte(@NonNull String fieldPath, T value)
YqlPredicate	negate()
static <T> YqlPredicate	neq(@NonNull String fieldPath, T value)
static YqlPredicate	not(@NonNull YqlPredicate pred)
static YqlPredicate	notLike(@NonNull String fieldPath, @NonNull String value)
static YqlPredicate	notLike(@NonNull String fieldPath, @NonNull String value, Character escape)
YqlPredicate.FieldPredicateBuilder	or(@NonNull String fieldPath)
static YqlPredicate	or(@NonNull Collection<YqlPredicate> predicates)
YqlPredicate	or(@NonNull YqlPredicate other)
static YqlPredicate	or(@NonNull YqlPredicate first, @NonNull YqlPredicate... rest)
YqlPredicateParam<?>	paramAt(int index)
List<YqlPredicateParam<?>>	paramList()
Stream<YqlPredicateParam<?>>	paramStream()
static void	setUseLegacyIn(boolean useLegacyIn)
static void	setUseLegacyRel(boolean useLegacyRel)
abstract <T extends tech.ydb.yoj.repository.db.Entity<T>> String	toYql(@NonNull tech.ydb.yoj.repository.db.EntitySchema<T> schema)
static YqlPredicate.FieldPredicateBuilder	where(@NonNull String fieldPath)

Methods inherited from class java.lang.Object

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

Methods inherited from interface tech.ydb.yoj.repository.ydb.yql.YqlStatementPart

toFullYql

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

YqlPredicate

public YqlPredicate()

Method Details

setUseLegacyIn

public static void setUseLegacyIn(boolean useLegacyIn)

setUseLegacyRel

public static void setUseLegacyRel(boolean useLegacyRel)

where

public static YqlPredicate.FieldPredicateBuilder where(@NonNull
 @NonNull String fieldPath)

not

public static YqlPredicate not(@NonNull
 @NonNull YqlPredicate pred)

and

public static YqlPredicate and(@NonNull
 @NonNull YqlPredicate first,
 @NonNull
 @NonNull YqlPredicate... rest)

and

public static YqlPredicate and(@NonNull
 @NonNull Collection<YqlPredicate> predicates)

or

public static YqlPredicate or(@NonNull
 @NonNull YqlPredicate first,
 @NonNull
 @NonNull YqlPredicate... rest)

or

public static YqlPredicate or(@NonNull
 @NonNull Collection<YqlPredicate> predicates)

in

@SafeVarargs
public static <T> YqlPredicate in(@NonNull
 @NonNull String fieldPath,
 @NonNull
 T possibleValue,
 @NonNull
 @NonNull T... restOfPossibleValues)

in

public static <T> YqlPredicate in(@NonNull
 @NonNull String fieldPath,
 @NonNull
 @NonNull Collection<@NonNull ? extends T> values)

eq

public static <T> YqlPredicate eq(@NonNull
 @NonNull String fieldPath,
 @Nullable
 T value)

neq

public static <T> YqlPredicate neq(@NonNull
 @NonNull String fieldPath,
 @Nullable
 T value)

lt

public static <T> YqlPredicate lt(@NonNull
 @NonNull String fieldPath,
 @NonNull
 T value)

lte

public static <T> YqlPredicate lte(@NonNull
 @NonNull String fieldPath,
 @NonNull
 T value)

gt

public static <T> YqlPredicate gt(@NonNull
 @NonNull String fieldPath,
 @NonNull
 T value)

gte

public static <T> YqlPredicate gte(@NonNull
 @NonNull String fieldPath,
 @NonNull
 T value)

like

public static YqlPredicate like(@NonNull
 @NonNull String fieldPath,
 @NonNull
 @NonNull String value)

like

public static YqlPredicate like(@NonNull
 @NonNull String fieldPath,
 @NonNull
 @NonNull String value,
 @Nullable
 Character escape)

notLike

public static YqlPredicate notLike(@NonNull
 @NonNull String fieldPath,
 @NonNull
 @NonNull String value)

notLike

public static YqlPredicate notLike(@NonNull
 @NonNull String fieldPath,
 @NonNull
 @NonNull String value,
 @Nullable
 Character escape)

alwaysTrue

public static YqlPredicate alwaysTrue()

alwaysFalse

public static YqlPredicate alwaysFalse()

toYql

public abstract <T extends tech.ydb.yoj.repository.db.Entity<T>>
String toYql(@NonNull
 @NonNull tech.ydb.yoj.repository.db.EntitySchema<T> schema)

Specified by:

toYql in interface YqlStatementPart<YqlPredicate>

Parameters:

schema - entity schema

Returns:

non-null, valid YQL for the predicate, possibly including reference to some positional statement parameters as ? and entity field references as {field.path}

getType

public final String getType()

Specified by:

getType in interface YqlStatementPart<YqlPredicate>

getYqlPrefix

public final String getYqlPrefix()

Specified by:

getYqlPrefix in interface YqlStatementPart<YqlPredicate>

getPriority

public final int getPriority()

Specified by:

getPriority in interface YqlStatementPart<YqlPredicate>

combine

public final List<? extends YqlStatementPart<?>> combine(@NonNull
 @NonNull List<? extends YqlPredicate> others)

Specified by:

combine in interface YqlStatementPart<YqlPredicate>

paramStream

public Stream<YqlPredicateParam<?>> paramStream()

Returns:

stream of statement parameter specifications, if this YQL predicate uses parameters

paramAt

public YqlPredicateParam<?> paramAt(int index)

paramList

public List<YqlPredicateParam<?>> paramList()

Returns:

list of statement parameter specification, in the same order as paramStream()

negate

public YqlPredicate negate()

and

public YqlPredicate and(@NonNull
 @NonNull YqlPredicate other)

or

public YqlPredicate or(@NonNull
 @NonNull YqlPredicate other)

and

public YqlPredicate.FieldPredicateBuilder and(@NonNull
 @NonNull String fieldPath)

or

public YqlPredicate.FieldPredicateBuilder or(@NonNull
 @NonNull String fieldPath)