public interface RawSqlBuilder
Note that RawSql can also be defined in ebean-orm.xml files and be used as a named query.
RawSql
Modifier and Type | Method and Description |
---|---|
RawSqlBuilder |
columnMapping(String dbColumn,
String propertyName)
Set the mapping of a DB Column to a bean property.
|
RawSqlBuilder |
columnMappingIgnore(String dbColumn)
Ignore this DB column.
|
RawSql |
create()
Create the immutable RawSql object.
|
static RawSqlBuilder |
parse(String sql)
Return a RawSqlBuilder parsing the sql.
|
static RawSql |
resultSet(ResultSet resultSet,
String... propertyNames)
Create and return a RawSql object based on the resultSet and list of properties the columns in
the resultSet map to.
|
static SqlRow |
sqlRow(ResultSet resultSet,
String dbTrueValue,
boolean binaryOptimizedUUID)
Create and return a SqlRow based on the resultSet with dbTrueValue and binaryOptimizedUUID options.
|
RawSqlBuilder |
tableAliasMapping(String tableAlias,
String path)
Modify any column mappings with the given table alias to have the path prefix.
|
static RawSqlBuilder |
unparsed(String sql)
Return an unparsed RawSqlBuilder.
|
static RawSql resultSet(ResultSet resultSet, String... propertyNames)
The properties listed in the propertyNames must be in the same order as the columns in the resultSet.
static SqlRow sqlRow(ResultSet resultSet, String dbTrueValue, boolean binaryOptimizedUUID) throws SQLException
SQLException
static RawSqlBuilder unparsed(String sql)
static RawSqlBuilder parse(String sql)
The sql statement will be parsed so that Ebean can determine where it can insert additional WHERE or HAVING expressions.
Additionally the selected columns are parsed to determine the column ordering. This also means additional checks can be made with the column mapping - specifically we can check that all columns are mapped and that correct column names are entered into the mapping.
RawSqlBuilder columnMapping(String dbColumn, String propertyName)
For Unparsed SQL the columnMapping MUST be defined in the same order that the columns appear in the SQL statement.
dbColumn
- the DB column that we are mapping to a bean propertypropertyName
- the bean property that we are mapping the DB column to.RawSqlBuilder columnMappingIgnore(String dbColumn)
RawSqlBuilder tableAliasMapping(String tableAlias, String path)
For example modify all mappings with table alias "c" to have the path prefix "customer".
For the "Root type" you don't need to specify a tableAliasMapping.
Copyright © 2019. All rights reserved.