Spring Named Parameters examples in SimpleJdbcTemplate

In JdbcTemplate, SQL parameters are represented by a special placeholder “?” symbol and bind it by position. The problem is whenever the order of parameter is changed, you have to change the parameters bindings as well, it’s error prone and cumbersome to maintain it.

To fix it, you can use “Named Parameter“, whereas SQL parameters are defined by a starting colon follow by a name, rather than by position. In additional, the named parameters are only support in SimpleJdbcTemplate and NamedParameterJdbcTemplate.

See following three examples to use named parameters in Spring.

Example 1

Example to show you how to use named parameters in a single insert statement.


	//insert with named parameter
	public void insertNamedParameter(Customer customer){
			
		String sql = "INSERT INTO CUSTOMER " +
			"(CUST_ID, NAME, AGE) VALUES (:custId, :name, :age)";
			
		Map<String, Object> parameters = new HashMap<String, Object>();
		parameters.put("custId", customer.getCustId());
		parameters.put("name", customer.getName());
		parameters.put("age", customer.getAge());
			
		getSimpleJdbcTemplate().update(sql, parameters);
				
	}

Example 2

Examples to show how to use named parameters in a batch operation statement.


	public void insertBatchNamedParameter(final List<Customer> customers){
			
		String sql = "INSERT INTO CUSTOMER " +
		"(CUST_ID, NAME, AGE) VALUES (:custId, :name, :age)";
				
		List<SqlParameterSource> parameters = new ArrayList<SqlParameterSource>();
		for (Customer cust : customers) {
			parameters.add(new BeanPropertySqlParameterSource(cust)); 
		}
		
		getSimpleJdbcTemplate().batchUpdate(sql,
			parameters.toArray(new SqlParameterSource[0]));
	}

Example 3

Another examples to use named parameters in a batch operation statement.


	public void insertBatchNamedParameter2(final List<Customer> customers){
			
	   SqlParameterSource[] params = 
		SqlParameterSourceUtils.createBatch(customers.toArray());
		
	   getSimpleJdbcTemplate().batchUpdate(
		"INSERT INTO CUSTOMER (CUST_ID, NAME, AGE) VALUES (:custId, :name, :age)",
		params);
		
	}

Download Source Code

Download it – Spring-JDBC-Named-Parameter-Example.zip (15 KB)

mkyong

Founder of Mkyong.com, passionate Java and open-source technologies. If you enjoy my tutorials, consider making a donation to these charities.

10 Comments
Most Voted
Newest Oldest
Inline Feedbacks
View all comments
Greesh
5 years ago

Hi Mk,

Is it possible to run batches of smaller sizes (since im having bulk no of records) with named jdbc template?

Javier
7 years ago

i, what would it be like to add in an Oracle table that has a sequence?

Bharat
8 years ago

Hi mkyong, i have a question regarding batch update:

.batchUpdate(
“INSERT INTO CUSTOMER (CUST_ID, NAME, AGE) VALUES (:custId, :name, :age)”,

Is the above method transactional? Will all inserts rollback if one insert fails due to some data constraiant?

Yogeeta Arora
10 years ago

Hi mkyong, I am facing a problem with NamedParameterJdbcTemplate.Whenever I deploy the build with NamedParameterJdbcTemplate and query starts hitting the Database, database CPU usage reaches 100% and when I am using simpleJdbcTemplate it remains between 30-40%. Is this a know issue? Please help me to solve this problem and let me know if you want more information from me.

Pradeep
11 years ago

I am trying to use the following sql with the batchUpdate and doesn’t work. Any ideas?

UPDATE Role set Name=replace(Name, :name, :targetGroupName) where Name like %:name

Pmt
12 years ago

I’m getting this exception when I try to do this:

“java.sql.SQLException: Invalid column type”

Any idea??

Thanks!

Priyanka Patil
12 years ago

Hi MK,
Have you ever tried a NamedParameterJdbcTemplate with more than 20000 records where you need to set the fetch Size?

Anand
14 years ago

Mr. Yong

Your tutorials are awesome for any novice on JAVA related topics. Keep up the good work and BIG THANKS

micahli123
14 years ago

Thanks!

Dilshat
14 years ago

Awesome site! Superb tutorials! Greate work MK!