Package tech.ydb.yoj.repository.ydb.statement

Class YqlStatement<PARAMS,ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>,RESULT>

java.lang.Object
tech.ydb.yoj.repository.ydb.statement.YqlStatement<PARAMS,ENTITY,RESULT>
All Implemented Interfaces:
Statement<PARAMS,RESULT>
Direct Known Subclasses:
DeleteAllStatement, FindAllYqlStatement, FindRangeStatement, FindYqlStatement, MultipleVarsYqlStatement, PredicateStatement, UpdateByIdStatement, UpdateInStatement
public abstract class YqlStatement<PARAMS,ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>,RESULT> extends Object implements Statement<PARAMS,RESULT>

  • Field Details

    • itemsCollector

      protected static final Collector<tech.ydb.proto.ValueProtos.Value.Builder,tech.ydb.proto.ValueProtos.Value.Builder,tech.ydb.proto.ValueProtos.Value.Builder> itemsCollector

    • ORDER_BY_ID_ASCENDING

      protected static final YqlOrderBy ORDER_BY_ID_ASCENDING

    • schema

      protected final tech.ydb.yoj.repository.db.EntitySchema<ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>> schema

    • resultSchema

      protected final Schema<RESULT> resultSchema

    • resultSetReader

      protected final ResultSetReader<RESULT> resultSetReader

    • tableDescriptor

      protected final tech.ydb.yoj.repository.db.TableDescriptor<ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>> tableDescriptor

  • Constructor Details

    • YqlStatement

      @Deprecated(forRemoval=true) public YqlStatement(tech.ydb.yoj.repository.db.EntitySchema<ENTITY> schema, Schema<RESULT> resultSchema)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use constructor with TableDescriptor for selecting correct entity table

    • YqlStatement

      public YqlStatement(tech.ydb.yoj.repository.db.TableDescriptor<ENTITY> tableDescriptor, tech.ydb.yoj.repository.db.EntitySchema<ENTITY> schema, Schema<RESULT> resultSchema)

  • Method Details

    • storeToCache

      public void storeToCache(PARAMS params, List<RESULT> result, tech.ydb.yoj.repository.db.cache.RepositoryCache cache)
      Description copied from interface: Statement
      Writes the query result to first-level cache.
      Specified by:
      storeToCache in interface Statement<PARAMS,ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>>
      Parameters:
      params - parameter values Might be null depending on the statement type, e.g. for DELETE statements.
      result - result to save; if null, nothing will be saved to cache
      cache - first-level cache

    • getDeclaration

      public String getDeclaration(String name, String type)

    • mergeParts

      @Deprecated(forRemoval=true) protected static Stream<? extends YqlStatementPart<?>> mergeParts(Stream<? extends YqlStatementPart<?>> origParts)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method is deprecated and will be removed in YOJ 3.0.0. Please use mergeParts(Collection) instead.
      Tries to combine/simplify the specified statement parts into a potentially smaller number of statement parts, e.g., joining multiple YqlPredicates into a single AND clause (AndPredicate).
      Note that this method does not attempt to sort statement parts by priority or perform any YQL code generation at all.

      Warning: A closed/consumed or a partially consumed Stream could have potentially been passed to this method. But in all cases that we know of (both standard and custom YqlStatements), this method was always fed a fresh stream, obtained by calling someCollection.stream(). This method is now replaced by the less error-prone mergeParts(Collection).

    • mergeParts

      protected static Stream<? extends YqlStatementPart<?>> mergeParts(Collection<? extends YqlStatementPart<?>> origParts)
      Tries to combine/simplify the specified statement parts into a potentially smaller number of statement parts, e.g., joining multiple YqlPredicates into a single AND clause (AndPredicate).
      Note that this method does not attempt to sort statement parts by priority or perform any YQL code generation at all.
      Parameters:
      origParts - original collection of statement parts
      Returns:
      a fresh stream containing potentially combined statement parts

    • isPreparable

      public boolean isPreparable()
      Description copied from interface: Statement
      Tells whether the statement should be prepared, that is, parsed once and then cached for subsequent queries during the same session.
      Prepared statements offer better query performance, but consume additional memory.

      You should not blindly prepare all statements, especially non-parameterized ones; so by default this method returns false.

      Specified by:
      isPreparable in interface Statement<PARAMS,ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>>
      Returns:
      true if the statement should be prepared; false otherwise

    • toQueryParameters

      public Map<String,tech.ydb.proto.ValueProtos.TypedValue> toQueryParameters(PARAMS params)
      Description copied from interface: Statement
      Returns the query's parameter values as YDB protobuf structures.
      Specified by:
      toQueryParameters in interface Statement<PARAMS,ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>>
      Parameters:
      params - parameter values Might be null depending on the statement type, e.g. for DELETE statements.
      Returns:
      map: parameter name -> value as protobuf

    • createTQueryParameter

      protected tech.ydb.proto.ValueProtos.TypedValue createTQueryParameter(YqlType type, Object o, boolean optional)

    • getYqlType

      protected tech.ydb.proto.ValueProtos.Type.Builder getYqlType(YqlType yqlType, boolean optional)

    • getYqlValue

      protected tech.ydb.proto.ValueProtos.Value.Builder getYqlValue(YqlType type, Object value)

    • readResult

      public RESULT readResult(List<tech.ydb.proto.ValueProtos.Column> columns, tech.ydb.proto.ValueProtos.Value value)
      Description copied from interface: Statement
      Converts YDB result set into the query result.
      Specified by:
      readResult in interface Statement<PARAMS,ENTITY extends tech.ydb.yoj.repository.db.Entity<ENTITY>>
      Parameters:
      columns - result set as a YDB protobuf structure
      value - result set as a YDB protobuf structure
      Returns:
      query result

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getInSchemaType

      public Class<ENTITY> getInSchemaType()

    • getParams

      protected Collection<YqlStatementParam> getParams()

    • declarations

      protected String declarations()

    • outNames

      protected String outNames()

    • nameEqVars

      protected String nameEqVars()

    • table

      protected String table(String tablespace)

    • escape

      protected String escape(String value)

    • resolveParamNames

      protected String resolveParamNames(String yql)
      Resolves ? placeholders to respective statement parameters' names, and {entity.java.field} placeholders to DB field names.
      Parameters:
      yql - YQL with parameter and field name placeholders (? and {field.name}, respectively)
      Returns:
      YQL with real parameter names