Custom query methods by naming convention in Spring Boot - Step-by-Step Execution

Concept Flow - Custom query methods by naming convention

Define method name in repository

↓

Spring Data parses method name

↓

Generate query based on keywords

↓

Execute query when method called

↓

Return results to caller

Spring Data reads the method name, builds a query from it, runs the query, and returns the results.

Execution Sample

Spring Boot

interface UserRepository extends JpaRepository<User, Long> {
  List<User> findByLastName(String lastName);
}

Defines a method to find users by their last name using naming convention.

Execution Table

Step	Action	Method Name Parsed	Query Generated	Result
1	Method declared: findByLastName	findByLastName	SELECT * FROM user WHERE last_name = ?	Ready to execute
2	Method called with lastName='Smith'	findByLastName	SELECT * FROM user WHERE last_name = 'Smith'	Query executed
3	Database returns matching users	N/A	N/A	List of users with lastName 'Smith' returned
4	Method returns results to caller	N/A	N/A	Caller receives List<User>

💡 Method execution completes after returning matching users from database

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
methodName	null	findByLastName	findByLastName	findByLastName
query	null	SELECT * FROM user WHERE last_name = 'Smith'	Executed query	Executed query
result	null	null	List<User> with lastName 'Smith'	List<User> with lastName 'Smith'

Key Moments - 3 Insights

How does Spring know what query to run from the method name?

Spring parses the method name (see Step 1 in execution_table) and converts keywords like 'findByLastName' into SQL conditions automatically.

What happens if the method name does not follow naming rules?

Spring cannot parse the method name into a query, so it will throw an error at startup or runtime (not shown in this trace).

Can the method return types vary?

Yes, return types like List<User>, Optional<User>, or User are supported depending on the query and method signature.

Visual Quiz - 3 Questions

Look at the execution_table, what query is generated when calling findByLastName with 'Smith'?

A SELECT * FROM user WHERE last_name = 'Smith'

B SELECT * FROM user WHERE first_name = 'Smith'

C SELECT * FROM user WHERE name = 'Smith'

D SELECT * FROM user

💡 Hint

Check Step 2 in execution_table for the generated query.

At which step does the database return the matching users?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the 'Result' column in execution_table rows.

If the method was named findByAge, what would change in the execution_table?

A The method would not be parsed

B The query would filter by age instead of last_name

C The query would remain the same

D The result would be empty

💡 Hint

Naming convention changes the query generated as shown in Step 1 and 2.

Concept Snapshot

Custom query methods use method names to build queries.
Method names start with findBy, readBy, getBy, etc.
Keywords after 'By' map to entity fields.
Spring Data parses method name and creates SQL automatically.
Call method with parameters to run query and get results.

Full Transcript

In Spring Boot, you can create custom queries by simply naming methods in your repository interface. For example, a method named findByLastName will be parsed by Spring Data to generate a query that selects users where the last_name matches the given parameter. When you call this method with a value like 'Smith', Spring runs the query and returns the matching users. This process involves Spring reading the method name, converting it into a SQL query, executing it, and returning the results. If the method name does not follow the naming rules, Spring will not be able to generate the query and will throw an error. This feature lets you write queries without writing SQL, just by naming methods clearly.