docs: connection pool options for Oracle state store#5221
Open
nelson-parente wants to merge 3 commits into
Open
docs: connection pool options for Oracle state store#5221nelson-parente wants to merge 3 commits into
nelson-parente wants to merge 3 commits into
Conversation
Signed-off-by: nelson.parente <nelson_parente@live.com.pt>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for new database/sql connection-pool metadata options supported by the Oracle Database state store component (targeting Dapr 1.19), aligning the Oracle state store docs with the recently introduced component capabilities.
Changes:
- Documented four optional connection pool settings:
maxOpenConns,maxIdleConns,connMaxLifetime, andconnMaxIdleTime. - Linked duration-based settings to Go’s
time.ParseDurationdocumentation for formatting guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+50
to
+53
| | `maxOpenConns` | N | Maximum number of open connections to the database. Defaults to unlimited (Go default: `0`) | `"10"` | | ||
| | `maxIdleConns` | N | Maximum number of idle connections in the connection pool. Defaults to Go default (`2`) | `"5"` | | ||
| | `connMaxLifetime` | N | Maximum lifetime of a connection as a [Go duration](https://pkg.go.dev/time#ParseDuration). Defaults to connections being reused forever | `"30s"`, `"5m"` | | ||
| | `connMaxIdleTime` | N | Maximum idle time for a connection before it is closed, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Defaults to no limit | `"5m"` | |
…(Copilot review) Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
Comment on lines
+50
to
+53
| | `maxOpenConns` | N | Maximum number of open connections to the database. Defaults to unlimited (Go default: `0`) | `"10"` | ||
| | `maxIdleConns` | N | Maximum number of idle connections in the connection pool. Defaults to Go default (`2`) | `"5"` | ||
| | `connMaxLifetime` | N | Maximum lifetime of a connection as a [Go duration](https://pkg.go.dev/time#ParseDuration). Defaults to connections being reused forever | `"30s"`, `"5m"` | ||
| | `connMaxIdleTime` | N | Maximum idle time for a connection before it is closed, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Defaults to no limit | `"5m"` |
… review) Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the four
database/sqlconnection-pool metadata options now available in the Oracle state store component (introduced in dapr/components-contrib#4411):maxOpenConns— max open connections (maps toSetMaxOpenConns; default: unlimited)maxIdleConns— max idle connections (maps toSetMaxIdleConns; default: Go default of 2)connMaxLifetime— max connection lifetime as a Go duration string (maps toSetConnMaxLifetime; default: reused forever)connMaxIdleTime— max idle time before connection is closed as a Go duration string (maps toSetConnMaxIdleTime; default: no limit)All four fields are optional. No existing content was modified.
Targets Dapr 1.19.
Code: dapr/components-contrib#4411
Relates to: dapr/components-contrib#4276