Interface JdbcFunction
- All Known Implementing Classes:
AbstractDatetimeAddFunction
,AbstractJdbcFunction
,BirthdayQueryFunction
,BoundingboxJdbcFunction
,DateAddFunction
,DatetimeAddFunction
,DistanceHaversineJdbcFunction
,DueDateFunction
,SimilarityFunction
public interface JdbcFunction
This interface can be used to contribute additional query functions that are based on raw SQL.
-
Method Summary
Modifier and TypeMethodDescriptionint
org.hibernate.query.sqm.function.SqmFunctionDescriptor
createFunction
(org.hibernate.type.spi.TypeConfiguration typeConfiguration, SqlWriterBase.SqlWriterConfiguration sqlWriterConfiguration) getName()
Class
<?> void
validateArguments
(jakarta.persistence.criteria.Expression<?>[] arguments)
-
Method Details
-
getName
String getName() -
createFunction
org.hibernate.query.sqm.function.SqmFunctionDescriptor createFunction(org.hibernate.type.spi.TypeConfiguration typeConfiguration, SqlWriterBase.SqlWriterConfiguration sqlWriterConfiguration) - Returns:
- an
SqmFunctionDescriptor
that contains the raw sql statement that is executed on the db.
-
argumentCount
int argumentCount()- Returns:
- the number of expected arguments.
-
getReturnType
Class<?> getReturnType()- Returns:
- the return type of the function
-
validateArguments
void validateArguments(jakarta.persistence.criteria.Expression<?>[] arguments) throws JdbcFunctionException - Throws:
JdbcFunctionException
-