Document the JdbcAppender truncateStrings attribute - #4320
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
`JdbcAppender.Builder#truncateStrings` is a `@PluginBuilderAttribute` with a default of `true`, so it can be set on the `<Jdbc>` element, but it was the only optional attribute of the appender missing from the attribute table in the manual. Add the missing row.
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.
JdbcAppender.Builder#truncateStringsis a@PluginBuilderAttributewith a default oftrue, soit can be configured on the
<Jdbc>element. It was the only optional attribute of the appenderthat the manual did not document, which makes the attribute undiscoverable even though it changes
what is written to the database: when it is
true, values written to string columns are truncatedto the size reported by the database metadata.
This adds the missing row to the attribute table in
src/site/antora/modules/ROOT/pages/manual/appenders/database.adoc, in the same format as theneighbouring
reconnectIntervalMillisrow.Validation: rendered the page with Asciidoctor and confirmed the table still has four columns per
row and that the new row is emitted with the
JdbcAppender-attr-truncateStringsanchor, the typebooleanand the defaulttrue. The full Antora build was not run locally; it is driven by theshared
apache/logging-parentdeploy-site workflow.Checklist
2.xbranch if you are targeting Log4j 2; usemainotherwise./mvnw verifysucceeds (the build instructions)src/changelog/.2.x.xdirectory