How to call store procedure in Hibernate?

Here’s a MySQL store procedure, which accept a stock code parameter and return the related stock data.

CREATE PROCEDURE `GetStocks`(int_stockcode varchar(20))
BEGIN
SELECT * FROM stock WHERE stock_code = int_stockcode;
END $$

In Hibernate, there are three approaches to call a database store procedure.

1. Native SQL – createSQLQuery

You can use createSQLQuery() to call a store procedure directly.

Query query = session.createSQLQuery(

 "CALL GetStocks(:stockCode)")
 .addEntity(Stock.class)
 .setParameter("stockCode", "7277");

 
List result = query.list();
for(int i=0; i<result.size(); i++){

 Stock stock = (Stock)result.get(i);
 System.out.println(stock.getStockCode());

}

2. NamedNativeQuery in annotation

Declare your store procedure inside the @NamedNativeQueries annotation.

//Stock.java
...
@NamedNativeQueries({
 @NamedNativeQuery(

 name = "callStockStoreProcedure",
 query = "CALL GetStocks(:stockCode)",
 resultClass = Stock.class
 )

})
@Entity
@Table(name = "stock")
public class Stock implements java.io.Serializable {

...

Call it with getNamedQuery().

Query query = session.getNamedQuery("callStockStoreProcedure")
 .setParameter("stockCode", "7277");

List result = query.list();
for(int i=0; i<result.size(); i++){

 Stock stock = (Stock)result.get(i);
 System.out.println(stock.getStockCode());

}

3. sql-query in XML mapping file

Declare your store procedure inside the “sql-query” tag.

<!-- Stock.hbm.xml -->
...
<hibernate-mapping>
    <class name="com.mkyong.common.Stock" table="stock" ...>

        <id name="stockId" type="java.lang.Integer">
            <column name="STOCK_ID" />

            <generator class="identity" />
        </id>
        <property name="stockCode" type="string">

            <column name="STOCK_CODE" length="10" not-null="true" unique="true" />

        </property>
        ...
    </class>
 
    <sql-query name="callStockStoreProcedure">
 <return alias="stock" class="com.mkyong.common.Stock"/>

 <![CDATA[CALL GetStocks(:stockCode)]]>
    </sql-query>
 
</hibernate-mapping>

Call it with getNamedQuery().

Query query = session.getNamedQuery("callStockStoreProcedure")

 .setParameter("stockCode", "7277");
List result = query.list();

for(int i=0; i<result.size(); i++){
 Stock stock = (Stock)result.get(i);

 System.out.println(stock.getStockCode());
}