Package org.apache.calcite.sql.util

Class SqlString

  • public class SqlString
extends java.lang.Object
    String that represents a kocher SQL statement, expression, or fragment.

    A SqlString just contains a regular Java string, but the SqlString wrapper indicates that the string has been created carefully guarding against all SQL dialect and injection issues.

    The easiest way to do build a SqlString is to use a SqlBuilder.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private SqlDialect dialect  
      private com.google.common.collect.ImmutableList<java.lang.Integer> dynamicParameters  
      private java.lang.String sql  

    • Constructor Summary

      Constructors 
      Constructor Description
      SqlString​(SqlDialect dialect, java.lang.String sql)
      Creates a SqlString.
      SqlString​(SqlDialect dialect, java.lang.String sql, com.google.common.collect.ImmutableList<java.lang.Integer> dynamicParameters)
      Creates a SqlString.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      SqlDialect getDialect()
      Returns the dialect.
      com.google.common.collect.ImmutableList<java.lang.Integer> getDynamicParameters()
      Returns indices of dynamic parameters.
      java.lang.String getSql()
      Returns the SQL string.
      int hashCode()  
      java.lang.String toString()

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • sql

        private final java.lang.String sql

      • dynamicParameters

        private com.google.common.collect.ImmutableList<java.lang.Integer> dynamicParameters

    • Constructor Detail

      • SqlString

        public SqlString​(SqlDialect dialect,
                 java.lang.String sql)
        Creates a SqlString.

      • SqlString

        public SqlString​(SqlDialect dialect,
                 java.lang.String sql,
                 com.google.common.collect.ImmutableList<java.lang.Integer> dynamicParameters)
        Creates a SqlString. The SQL might contain dynamic parameters, dynamicParameters designate the order of the parameters.
        Parameters:
        sql - text
        dynamicParameters - indices

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()

        Returns the SQL string.

        Overrides:
        toString in class java.lang.Object
        Returns:
        SQL string
        See Also:
        getSql()

      • getSql

        public java.lang.String getSql()
        Returns the SQL string.
        Returns:
        SQL string

      • getDynamicParameters

        public com.google.common.collect.ImmutableList<java.lang.Integer> getDynamicParameters()
        Returns indices of dynamic parameters.
        Returns:
        indices of dynamic parameters

      • getDialect

        public SqlDialect getDialect()
        Returns the dialect.