Skip to main content

How to enable SQL logs in Spring Boot application?

Image
By

This tutorial will demonstrate how to enable and disable SQL log statements in a Spring Boot application in order to debug SQL flow.


Problem

You will frequently need to debug the SQL statement while developing a Spring Boot application with a SQL database.

SQL debug logs can assist you figure out what's wrong with JPA statements and whether or not there's a problem with database connectivity.

Example 

If you've built custom Spring data JPA methods and need to know what SQL statement is being utilized behind them,

return repository.findByUsernameIn(usernames);

Then you can enable Hibernet debug mode to log SQL statements.

Solution

Update the application.yml file with the Hibernet configuration as

logging:
  level:
    org:
      hibernate: DEBUG

or application.properties as

logging.level.org.hibernate=DEBUG


The SQL statement will appear in the application logs after modifying the configuration file and restarting the application.

2022-04-07 08:41:45.118 DEBUG 14561 --- [nio-8080-exec-1] org.hibernate.SQL                        : 
select user0_.id as id1_0_, user0_.password as password2_0_, user0_.username as username3_0_ from user user0_ where user0_.username in (?)


Spring Boot Profiles

This setup is great for debugging and testing your application while you are building or improving its features, but it's not appropriate for staging or production situations.

To turn off the debugging logs in the production environment, you should prefer to use Spring boot profiles.

  • application.properties :            Local machine
  • application-dev.properties:      Development environment.
  • application-stage.properties:   Stage/Test environment
  • application-prod.properties:    Production environment 

Inside application-prod.properties, specifically turn off SQL debug logs, like

logging.level.org.hibernate=OFF

Note: It is not a rule to name your application properties file as mentioned in this tutorial. You are free to give it whatever name you like.

Conclusion

SQL debugging can be activated or deactivated by application configuration. The production environment should explicitly disable this configuration.

You can access tutorial code from Github page.

Labels:

Comments

Post a Comment

Subscribe for latest tutorial updates

* indicates required

Popular posts from this blog

AJAX - How To Retrieve JSON Response from PHP script

By
Hello Friends, This is my first tutorial post. Today I'll explain you how to retrieve JSON response via Ajax call. First we build a PHP script to send response in JSON format, then we will gather this response from an Ajax call through jQuery script. Let’s first create a PHP script  Create a PHP script, I’ll name it as “json_response.php” And add following code in it json_response.php <?php //set header for JSON response header("Content-Type: application/json"); //render array in JSON format echo json_encode(array('status' => 200, 'message' => 'Response from PHP script in JSON format.')); This is a basic example to send JSON response. PHP script will send response with status code and message. Now create a HTML file to fetch JSON response and add it in header tag. Create a HTML file, I’ll name it as “json_response.html” And add following code. json_response.html <html>           ...
Post a Comment
Read more

JSON Tutorials : Getting Started

By
JSON is widely accepted text formatted structured data. JSON stands for " JavaScript Object Notation ". In general JSON can represent 1. Object of database record. 2. Object to represent a list of HTML elements. 3. Result of search query. 4. Response of an Ajax call. Here you can see JSON is used in many different areas and for many different scenarios. This means it has simple data structure. most of programming languages adopt it and it can flow easily from one connection to another. You can find JSON office definition here JSON Official Site . JSON is represented by two structural types, which includes two primitive types. Structural types Array : A sequential list of primitive data types between square brackets [ ] Object : Collection of key, value pair stored inside curly braces { }, where value would be primitive data type Primitive types : There are two primitive types key and value. " key " should be string and " value (data type)...
Post a Comment
Read more

Twig Tutorials: Install and Configure

By
In this tutorial, we'll look at how to install Twig within your PHP project and thereafter configure it so that we can create and use a Twig template inside our PHP web application. Later on, we'll see a simple Twig template example that displays a "Welcome to Twig template" message. Let's take it one step at a time. Install The Twig template can be installed using Composer, Git, or PEAR. In this tutorial, we will use Composer to install Twig. To do so, we'll need to make a "composer.json" file. { "require" : { "twig/twig" : "1.*" } } From the console, run the following command . $ php composer.phar install This command will install Twig library. Configuration To use the Twig template, we should first configure it. To achieve this, we will write an index.php file which will configure the Twig autoloader and generate the Twig environment. We will render the Twig temp...
Post a Comment
Read more