Skip to content

Commit 20c39dc

Browse files
committed
Document missing keys mapped on third party types
Closes gh-15980
1 parent 3370d65 commit 20c39dc

File tree

2 files changed

+459
-40
lines changed

2 files changed

+459
-40
lines changed

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

Lines changed: 38 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -806,27 +806,27 @@ content into your application. Rather, pick only the properties that you need.
806806
spring.jta.atomikos.connectionfactory.borrow-connection-timeout=30 # Timeout, in seconds, for borrowing connections from the pool.
807807
spring.jta.atomikos.connectionfactory.ignore-session-transacted-flag=true # Whether to ignore the transacted flag when creating session.
808808
spring.jta.atomikos.connectionfactory.local-transaction-mode=false # Whether local transactions are desired.
809-
spring.jta.atomikos.connectionfactory.maintenance-interval=60 # The time, in seconds, between runs of the pool's maintenance thread.
810-
spring.jta.atomikos.connectionfactory.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool.
811-
spring.jta.atomikos.connectionfactory.max-lifetime=0 # The time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit.
812-
spring.jta.atomikos.connectionfactory.max-pool-size=1 # The maximum size of the pool.
813-
spring.jta.atomikos.connectionfactory.min-pool-size=1 # The minimum size of the pool.
814-
spring.jta.atomikos.connectionfactory.reap-timeout=0 # The reap timeout, in seconds, for borrowed connections. 0 denotes no limit.
815-
spring.jta.atomikos.connectionfactory.unique-resource-name=jmsConnectionFactory # The unique name used to identify the resource during recovery.
809+
spring.jta.atomikos.connectionfactory.maintenance-interval=60 # Time, in seconds, between runs of the pool's maintenance thread.
810+
spring.jta.atomikos.connectionfactory.max-idle-time=60 # Time, in seconds, after which connections are cleaned up from the pool.
811+
spring.jta.atomikos.connectionfactory.max-lifetime=0 # Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit.
812+
spring.jta.atomikos.connectionfactory.max-pool-size=1 # Maximum size of the pool.
813+
spring.jta.atomikos.connectionfactory.min-pool-size=1 # Minimum size of the pool.
814+
spring.jta.atomikos.connectionfactory.reap-timeout=0 # Reap timeout, in seconds, for borrowed connections. 0 denotes no limit.
815+
spring.jta.atomikos.connectionfactory.unique-resource-name=jmsConnectionFactory # Unique name used to identify the resource during recovery.
816816
spring.jta.atomikos.connectionfactory.xa-connection-factory-class-name= # Vendor-specific implementation of XAConnectionFactory.
817817
spring.jta.atomikos.connectionfactory.xa-properties= # Vendor-specific XA properties.
818818
spring.jta.atomikos.datasource.borrow-connection-timeout=30 # Timeout, in seconds, for borrowing connections from the pool.
819-
spring.jta.atomikos.datasource.concurrent-connection-validation= # Whether to use concurrent connection validation.
819+
spring.jta.atomikos.datasource.concurrent-connection-validation=true # Whether to use concurrent connection validation.
820820
spring.jta.atomikos.datasource.default-isolation-level= # Default isolation level of connections provided by the pool.
821-
spring.jta.atomikos.datasource.login-timeout= # Timeout, in seconds, for establishing a database connection.
822-
spring.jta.atomikos.datasource.maintenance-interval=60 # The time, in seconds, between runs of the pool's maintenance thread.
823-
spring.jta.atomikos.datasource.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool.
824-
spring.jta.atomikos.datasource.max-lifetime=0 # The time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit.
825-
spring.jta.atomikos.datasource.max-pool-size=1 # The maximum size of the pool.
826-
spring.jta.atomikos.datasource.min-pool-size=1 # The minimum size of the pool.
827-
spring.jta.atomikos.datasource.reap-timeout=0 # The reap timeout, in seconds, for borrowed connections. 0 denotes no limit.
821+
spring.jta.atomikos.datasource.login-timeout=0 # Timeout, in seconds, for establishing a database connection.
822+
spring.jta.atomikos.datasource.maintenance-interval=60 # Time, in seconds, between runs of the pool's maintenance thread.
823+
spring.jta.atomikos.datasource.max-idle-time=60 # Time, in seconds, after which connections are cleaned up from the pool.
824+
spring.jta.atomikos.datasource.max-lifetime=0 # Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit.
825+
spring.jta.atomikos.datasource.max-pool-size=1 # Maximum size of the pool.
826+
spring.jta.atomikos.datasource.min-pool-size=1 # Minimum size of the pool.
827+
spring.jta.atomikos.datasource.reap-timeout=0 # Reap timeout, in seconds, for borrowed connections. 0 denotes no limit.
828828
spring.jta.atomikos.datasource.test-query= # SQL query or statement used to validate a connection before returning it.
829-
spring.jta.atomikos.datasource.unique-resource-name=dataSource # The unique name used to identify the resource during recovery.
829+
spring.jta.atomikos.datasource.unique-resource-name=dataSource # Unique name used to identify the resource during recovery.
830830
spring.jta.atomikos.datasource.xa-data-source-class-name= # Vendor-specific implementation of XAConnectionFactory.
831831
spring.jta.atomikos.datasource.xa-properties= # Vendor-specific XA properties.
832832
spring.jta.atomikos.properties.allow-sub-transactions=true # Specify whether sub-transactions are allowed.
@@ -852,51 +852,49 @@ content into your application. Rather, pick only the properties that you need.
852852
spring.jta.bitronix.connectionfactory.acquire-increment=1 # Number of connections to create when growing the pool.
853853
spring.jta.bitronix.connectionfactory.acquisition-interval=1 # Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired.
854854
spring.jta.bitronix.connectionfactory.acquisition-timeout=30 # Timeout, in seconds, for acquiring connections from the pool.
855-
spring.jta.bitronix.connectionfactory.allow-local-transactions=true # Whether the transaction manager should allow mixing XA and non-XA transactions.
855+
spring.jta.bitronix.connectionfactory.allow-local-transactions=false # Whether the transaction manager should allow mixing XA and non-XA transactions.
856856
spring.jta.bitronix.connectionfactory.apply-transaction-timeout=false # Whether the transaction timeout should be set on the XAResource when it is enlisted.
857857
spring.jta.bitronix.connectionfactory.automatic-enlisting-enabled=true # Whether resources should be enlisted and delisted automatically.
858858
spring.jta.bitronix.connectionfactory.cache-producers-consumers=true # Whether producers and consumers should be cached.
859859
spring.jta.bitronix.connectionfactory.class-name= # Underlying implementation class name of the XA resource.
860860
spring.jta.bitronix.connectionfactory.defer-connection-release=true # Whether the provider can run many transactions on the same connection and supports transaction interleaving.
861-
spring.jta.bitronix.connectionfactory.disabled= # Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool.
861+
spring.jta.bitronix.connectionfactory.disabled=false # Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool.
862862
spring.jta.bitronix.connectionfactory.driver-properties= # Properties that should be set on the underlying implementation.
863-
spring.jta.bitronix.connectionfactory.failed= # Mark this resource producer as failed.
864863
spring.jta.bitronix.connectionfactory.ignore-recovery-failures=false # Whether recovery failures should be ignored.
865-
spring.jta.bitronix.connectionfactory.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool.
866-
spring.jta.bitronix.connectionfactory.max-pool-size=10 # The maximum size of the pool. 0 denotes no limit.
867-
spring.jta.bitronix.connectionfactory.min-pool-size=0 # The minimum size of the pool.
868-
spring.jta.bitronix.connectionfactory.password= # The password to use to connect to the JMS provider.
864+
spring.jta.bitronix.connectionfactory.max-idle-time=60 # Time, in seconds, after which connections are cleaned up from the pool.
865+
spring.jta.bitronix.connectionfactory.max-pool-size=0 # Maximum size of the pool. 0 denotes no limit.
866+
spring.jta.bitronix.connectionfactory.min-pool-size=0 # Minimum size of the pool.
867+
spring.jta.bitronix.connectionfactory.password= # Password to use to connect to the JMS provider.
869868
spring.jta.bitronix.connectionfactory.share-transaction-connections=false # Whether connections in the ACCESSIBLE state can be shared within the context of a transaction.
870-
spring.jta.bitronix.connectionfactory.test-connections=true # Whether connections should be tested when acquired from the pool.
871-
spring.jta.bitronix.connectionfactory.two-pc-ordering-position=1 # The position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE).
872-
spring.jta.bitronix.connectionfactory.unique-name=jmsConnectionFactory # The unique name used to identify the resource during recovery.
869+
spring.jta.bitronix.connectionfactory.test-connections=false # Whether connections should be tested when acquired from the pool.
870+
spring.jta.bitronix.connectionfactory.two-pc-ordering-position=1 # Position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE).
871+
spring.jta.bitronix.connectionfactory.unique-name=jmsConnectionFactory # Unique name used to identify the resource during recovery.
873872
spring.jta.bitronix.connectionfactory.use-tm-join=true # Whether TMJOIN should be used when starting XAResources.
874-
spring.jta.bitronix.connectionfactory.user= # The user to use to connect to the JMS provider.
873+
spring.jta.bitronix.connectionfactory.user= # User to use to connect to the JMS provider.
875874
spring.jta.bitronix.datasource.acquire-increment=1 # Number of connections to create when growing the pool.
876875
spring.jta.bitronix.datasource.acquisition-interval=1 # Time, in seconds, to wait before trying to acquire a connection again after an invalid connection was acquired.
877876
spring.jta.bitronix.datasource.acquisition-timeout=30 # Timeout, in seconds, for acquiring connections from the pool.
878-
spring.jta.bitronix.datasource.allow-local-transactions=true # Whether the transaction manager should allow mixing XA and non-XA transactions.
877+
spring.jta.bitronix.datasource.allow-local-transactions=false # Whether the transaction manager should allow mixing XA and non-XA transactions.
879878
spring.jta.bitronix.datasource.apply-transaction-timeout=false # Whether the transaction timeout should be set on the XAResource when it is enlisted.
880879
spring.jta.bitronix.datasource.automatic-enlisting-enabled=true # Whether resources should be enlisted and delisted automatically.
881880
spring.jta.bitronix.datasource.class-name= # Underlying implementation class name of the XA resource.
882-
spring.jta.bitronix.datasource.cursor-holdability= # The default cursor holdability for connections.
881+
spring.jta.bitronix.datasource.cursor-holdability= # Default cursor holdability for connections.
883882
spring.jta.bitronix.datasource.defer-connection-release=true # Whether the database can run many transactions on the same connection and supports transaction interleaving.
884-
spring.jta.bitronix.datasource.disabled= # Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool.
883+
spring.jta.bitronix.datasource.disabled=false # Whether this resource is disabled, meaning it's temporarily forbidden to acquire a connection from its pool.
885884
spring.jta.bitronix.datasource.driver-properties= # Properties that should be set on the underlying implementation.
886-
spring.jta.bitronix.datasource.enable-jdbc4-connection-test= # Whether Connection.isValid() is called when acquiring a connection from the pool.
887-
spring.jta.bitronix.datasource.failed= # Mark this resource producer as failed.
885+
spring.jta.bitronix.datasource.enable-jdbc4-connection-test=false # Whether Connection.isValid() is called when acquiring a connection from the pool.
888886
spring.jta.bitronix.datasource.ignore-recovery-failures=false # Whether recovery failures should be ignored.
889-
spring.jta.bitronix.datasource.isolation-level= # The default isolation level for connections.
890-
spring.jta.bitronix.datasource.local-auto-commit= # The default auto-commit mode for local transactions.
887+
spring.jta.bitronix.datasource.isolation-level= # Default isolation level for connections.
888+
spring.jta.bitronix.datasource.local-auto-commit= # Default auto-commit mode for local transactions.
891889
spring.jta.bitronix.datasource.login-timeout= # Timeout, in seconds, for establishing a database connection.
892-
spring.jta.bitronix.datasource.max-idle-time=60 # The time, in seconds, after which connections are cleaned up from the pool.
893-
spring.jta.bitronix.datasource.max-pool-size=10 # The maximum size of the pool. 0 denotes no limit.
894-
spring.jta.bitronix.datasource.min-pool-size=0 # The minimum size of the pool.
895-
spring.jta.bitronix.datasource.prepared-statement-cache-size=0 # The target size of the prepared statement cache. 0 disables the cache.
890+
spring.jta.bitronix.datasource.max-idle-time=60 # Time, in seconds, after which connections are cleaned up from the pool.
891+
spring.jta.bitronix.datasource.max-pool-size=0 # Maximum size of the pool. 0 denotes no limit.
892+
spring.jta.bitronix.datasource.min-pool-size=0 # Minimum size of the pool.
893+
spring.jta.bitronix.datasource.prepared-statement-cache-size=0 # Target size of the prepared statement cache. 0 disables the cache.
896894
spring.jta.bitronix.datasource.share-transaction-connections=false # Whether connections in the ACCESSIBLE state can be shared within the context of a transaction.
897895
spring.jta.bitronix.datasource.test-query= # SQL query or statement used to validate a connection before returning it.
898-
spring.jta.bitronix.datasource.two-pc-ordering-position=1 # The position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, and always last is Integer.MAX_VALUE).
899-
spring.jta.bitronix.datasource.unique-name=dataSource # The unique name used to identify the resource during recovery.
896+
spring.jta.bitronix.datasource.two-pc-ordering-position=1 # Position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, and always last is Integer.MAX_VALUE).
897+
spring.jta.bitronix.datasource.unique-name=dataSource # Unique name used to identify the resource during recovery.
900898
spring.jta.bitronix.datasource.use-tm-join=true # Whether TMJOIN should be used when starting XAResources.
901899
spring.jta.bitronix.properties.allow-multiple-lrc=false # Whether to allow multiple LRC resources to be enlisted into the same transaction.
902900
spring.jta.bitronix.properties.asynchronous2-pc=false # Whether to enable asynchronously execution of two phase commit.

0 commit comments

Comments
 (0)