Package org.apache.calcite.sql.util

Class SqlString

java.lang.Object

org.apache.calcite.sql.util.SqlString

public class SqlString
extends 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.

Constructor Summary

Constructors

Constructor	Description
SqlString(SqlDialect dialect, String sql)	Creates a SqlString.
SqlString(SqlDialect dialect, String sql, @Nullable com.google.common.collect.ImmutableList<Integer> dynamicParameters)	Creates a SqlString.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

SqlString

public SqlString(SqlDialect dialect,
 String sql)

Creates a SqlString.

SqlString

public SqlString(SqlDialect dialect,
 String sql,
 @Nullable com.google.common.collect.ImmutableList<Integer> dynamicParameters)

Creates a SqlString. The SQL might contain dynamic parameters, dynamicParameters designate the order of the parameters.

Parameters:

sql - text

dynamicParameters - indices

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns the SQL string.

Overrides:

toString in class Object

Returns:

SQL string

See Also:

• getSql()

getSql

public String getSql()

Returns the SQL string.

Returns:

SQL string

getDynamicParameters

@Pure
public @Nullable com.google.common.collect.ImmutableList<Integer> getDynamicParameters()

Returns indices of dynamic parameters.

Returns:

indices of dynamic parameters

getDialect

public SqlDialect getDialect()

Returns the dialect.