apache / apache/grails-core

Datasource documentation still references Tomcat JDBC Pool properties while using HikariDataSource

Open
#15,761 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Groovy
Stars
2.9k
Forks
975
Avg merge
1d 22h
Merged PRs (30d)
92

Description

### Expected Behavior

While reviewing the Grails 7 datasource configuration documentation, I noticed that the examples configure:
`type = "com.zaxxer.hikari.HikariDataSource"`

However, the documented properties and references below still appear to be Tomcat JDBC Pool specific, for example:

* maxActive
* maxIdle
* minIdle
* maxWait
* jdbcInterceptors

The documentation also links to Tomcat JDBC Pool documentation.

Is this intentional?

* If Grails still maps these properties to HikariCP equivalents for backward compatibility, it might be helpful to document that behavior explicitly.
* If not, the examples may be outdated and should probably use HikariCP property names such as maximumPoolSize, minimumIdle, connectionTimeout, etc.

I checked the current Grails 7 documentation page and was unsure whether these settings are expected to work with com.zaxxer.hikari.HikariDataSource or are remnants from the previous Tomcat JDBC Pool configuration examples.

Thanks.

### Actual Behaviour

_No response_

### Steps To Reproduce

_No response_

### Environment Information

_No response_

### Example Application

_No response_

### Version

7

Contributor guide

Open the contributing guide

Research direction

Start with the Grails 7 datasource configuration documentation page referenced in the issue, then verify whether maxActive, maxIdle, minIdle, maxWait, and jdbcInterceptors are mapped for HikariDataSource or remain Tomcat JDBC Pool settings. Done means the examples, property names, compatibility explanation, and external links accurately match the supported configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.