Various properties can be specified inside your application.properties
file, inside your application.yaml
file, or as command line switches. This appendix provides a list of common Spring Boot properties and references to the underlying classes that consume them.
Spring Boot provides various conversion mechanism with advanced value formatting, make sure to review the properties conversion section. |
Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. Also, you can define your own properties. |
1. Core Properties
Name | Description | Default Value |
---|---|---|
|
Enable debug logs. |
|
|
Arbitrary properties to add to the info endpoint. |
|
|
Charset to use for console output. |
|
|
Charset to use for file output. |
|
|
Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback. |
|
|
Conversion word used when logging exceptions. |
|
|
Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory. |
|
|
Location of the log file. For instance, `/var/log`. |
|
|
Log groups to quickly change multiple loggers at the same time. For instance, `logging.group.db=org.hibernate,org.springframework.jdbc`. |
|
|
Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`. |
|
|
Overriding configuration files used to create a composite configuration. |
|
|
Whether to clean the archive log files on startup. |
|
|
Pattern for rolled-over log file names. |
|
|
Maximum log file size. |
|
|
Maximum number of archive log files to keep. |
|
|
Total size of log backups to be kept. |
|
|
Appender pattern for output to the console. Supported only with the default Logback setup. |
|
|
Appender pattern for log date format. Supported only with the default Logback setup. |
|
|
Appender pattern for output to a file. Supported only with the default Logback setup. |
|
|
Appender pattern for log level. Supported only with the default Logback setup. |
|
|
Register a shutdown hook for the logging system when it is initialized. Disabled automatically when deployed as a war file. |
|
|
Log level threshold for console output. |
|
|
Log level threshold for file output. |
|
|
Add @EnableAspectJAutoProxy. |
|
|
Whether subclass-based (CGLIB) proxies are to be created (true), as opposed to standard Java interface-based proxies (false). |
|
|
Whether to enable admin features for the application. |
|
|
JMX name of the application admin MBean. |
|
|
Application name. |
|
|
Auto-configuration classes to exclude. |
|
|
Banner file encoding. |
|
|
Banner text resource location. |
|
|
Whether to skip search of BeanInfo classes. |
|
|
Whether to log form data at DEBUG level, and headers at TRACE level. |
|
|
Limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated. This applies only to the auto-configured WebFlux server and WebClient instances. By default this is not set, in which case individual codec defaults apply. Most codecs are limited to 256K by default. |
|
|
Required cloud platform for the document to be included. |
|
|
Profile expressions that should match for the document to be included. |
|
|
Config file locations used in addition to the defaults. |
|
|
Import additional config data. |
|
|
Config file locations that replace the defaults. |
|
|
Config file name. |
|
|
File encoding. |
|
|
Location of the generated build-info.properties file. |
|
|
File encoding. |
|
|
Location of the generated git.properties file. |
|
|
JMX domain name. |
|
|
Expose management beans to the JMX domain. |
|
|
JMX Registration policy. |
|
|
MBeanServer bean name. |
|
|
Whether unique runtime object names should be ensured. |
|
|
Timeout for the shutdown of any phase (group of SmartLifecycle beans with the same 'phase' value). |
|
|
Whether bean definition overriding, by registering a definition with the same name as an existing definition, is allowed. |
|
|
Whether to allow circular references between beans and automatically try to resolve them. |
|
|
Mode used to display the banner when the application runs. |
|
|
Override the Cloud Platform auto-detection. |
|
|
Whether initialization should be performed lazily. |
|
|
Whether to log information about the application when it starts. |
|
|
Whether the application should have a shutdown hook registered. |
|
|
Sources (class names, package names, or XML resource locations) to include in the ApplicationContext. |
|
|
Flag to explicitly request a specific type of web application. If not set, auto-detected based on the classpath. |
|
|
Expected character encoding the application must use. |
|
|
Whether to always apply the MessageFormat rules, parsing even messages without arguments. |
|
|
Comma-separated list of basenames (essentially a fully-qualified classpath location), each following the ResourceBundle convention with relaxed support for slash based locations. If it doesn't contain a package qualifier (such as "org.mypackage"), it will be resolved from the classpath root. |
|
|
Loaded resource bundle files cache duration. When not set, bundles are cached forever. If a duration suffix is not specified, seconds will be used. |
|
|
Message bundles encoding. |
|
|
Whether to fall back to the system Locale if no files for a specific Locale have been found. if this is turned off, the only fallback will be the default file (e.g. "messages.properties" for basename "messages"). |
|
|
Whether to use the message code as the default message instead of throwing a "NoSuchMessageException". Recommended during development only. |
|
|
Configures the ANSI output. |
|
|
Fails if ApplicationPidFileWriter is used but it cannot write the PID file. |
|
|
Location of the PID file to write (if ApplicationPidFileWriter is used). |
|
|
Comma-separated list of active profiles. Can be overridden by a command line switch. |
|
|
Name of the profile to enable if no profile is active. |
|
|
Profile groups to define a logical name for a related group of profiles. |
|
|
Unconditionally activate the specified comma-separated list of profiles (or list of profiles if using YAML). |
|
|
Whether to automatically start the scheduler after initialization. |
|
|
Prefixes for single-line comments in SQL initialization scripts. |
|
|
Database schema initialization mode. |
|
|
Platform to use in initialization scripts if the @@platform@@ placeholder is used. Auto-detected by default. |
|
|
Path to the SQL file to use to initialize the database schema. |
|
|
Quartz job store type. |
|
|
Whether configured jobs should overwrite existing job definitions. |
|
|
Additional Quartz Scheduler properties. |
|
|
Name of the scheduler. |
|
|
Delay after which the scheduler is started once initialization completes. Setting this property makes sense if no jobs should be run before the entire application has started up. |
|
|
Whether to wait for running jobs to complete on shutdown. |
|
|
Whether the Reactor Debug Agent should be enabled when reactor-tools is present. |
|
|
Amount of time to wait before shutting down resources. |
|
|
Whether core threads are allowed to time out. This enables dynamic growing and shrinking of the pool. |
|
|
Core number of threads. |
|
|
Time limit for which threads may remain idle before being terminated. |
|
|
Maximum allowed number of threads. If tasks are filling up the queue, the pool can expand up to that size to accommodate the load. Ignored if the queue is unbounded. |
|
|
Queue capacity. An unbounded capacity does not increase the pool and therefore ignores the "max-size" property. |
|
|
Whether the executor should wait for scheduled tasks to complete on shutdown. |
|
|
Maximum time the executor should wait for remaining tasks to complete. |
|
|
Prefix to use for the names of newly created threads. |
|
|
Maximum allowed number of threads. |
|
|
Whether the executor should wait for scheduled tasks to complete on shutdown. |
|
|
Maximum time the executor should wait for remaining tasks to complete. |
|
|
Prefix to use for the names of newly created threads. |
|
|
Enable trace logs. |
|
2. Cache Properties
Name | Description | Default Value |
---|---|---|
|
Comma-separated list of cache names to create if supported by the underlying cache manager. Usually, this disables the ability to create additional caches on-the-fly. |
|
|
The spec to use to create caches. See CaffeineSpec for more details on the spec format. |
|
|
Entry expiration. By default the entries never expire. Note that this value is ultimately converted to seconds. |
|
|
The location of the configuration file to use to initialize Infinispan. |
|
|
The location of the configuration file to use to initialize the cache manager. The configuration file is dependent of the underlying cache implementation. |
|
|
Fully qualified name of the CachingProvider implementation to use to retrieve the JSR-107 compliant cache manager. Needed only if more than one JSR-107 implementation is available on the classpath. |
|
|
Allow caching null values. |
|
|
Whether to enable cache statistics. |
|
|
Key prefix. |
|
|
Entry expiration. By default the entries never expire. |
|
|
Whether to use the key prefix when writing to Redis. |
|
|
Cache type. By default, auto-detected according to the environment. |
3. Mail Properties
Name | Description | Default Value |
---|---|---|
|
Default MimeMessage encoding. |
|
|
SMTP server host. For instance, 'smtp.example.com'. |
|
|
Session JNDI name. When set, takes precedence over other Session settings. |
|
|
Login password of the SMTP server. |
|
|
SMTP server port. |
|
|
Additional JavaMail Session properties. |
|
|
Protocol used by the SMTP server. |
|
|
Whether to test that the mail server is available on startup. |
|
|
Login user of the SMTP server. |
|
|
SendGrid API key. |
|
|
SendGrid proxy host. |
|
|
SendGrid proxy port. |
4. JSON Properties
Name | Description | Default Value |
---|---|---|
|
Format to use when serializing Date objects. |
|
|
Whether to disable the escaping of HTML characters such as '<', '>', etc. |
|
|
Whether to exclude inner classes during serialization. |
|
|
Whether to enable serialization of complex map keys (i.e. non-primitives). |
|
|
Whether to exclude all fields from consideration for serialization or deserialization that do not have the "Expose" annotation. |
|
|
Naming policy that should be applied to an object's field during serialization and deserialization. |
|
|
Whether to generate non-executable JSON by prefixing the output with some special text. |
|
|
Whether to be lenient about parsing JSON that doesn't conform to RFC 4627. |
|
|
Serialization policy for Long and long types. |
|
|
Whether to output serialized JSON that fits in a page for pretty printing. |
|
|
Whether to serialize null fields. |
|
|
Strategy to use to auto-detect constructor, and in particular behavior with single-argument constructors. |
|
|
Date format string or a fully-qualified date format class name. For instance, 'yyyy-MM-dd HH:mm:ss'. |
|
|
Global default setting (if any) for leniency. |
|
|
Controls the inclusion of properties during serialization. Configured with one of the values in Jackson's JsonInclude.Include enumeration. |
|
|
Jackson on/off features that affect the way Java objects are deserialized. |
|
|
Jackson on/off features for generators. |
|
|
Locale used for formatting. |
|
|
Jackson general purpose on/off features. |
|
|
Jackson on/off features for parsers. |
|
|
One of the constants on Jackson's PropertyNamingStrategies. Can also be a fully-qualified class name of a PropertyNamingStrategy implementation. |
|
|
Jackson on/off features that affect the way Java objects are serialized. |
|
|
Time zone used when formatting dates. For instance, "America/Los_Angeles" or "GMT+10". |
|
|
Jackson visibility thresholds that can be used to limit which methods (and fields) are auto-detected. |
5. Data Properties
Name | Description | Default Value |
---|---|---|
|
Compression supported by the Cassandra binary protocol. |
|
|
Location of the configuration file to use. |
|
|
Timeout to use when establishing driver connections. |
|
|
Timeout to use for internal queries that run as part of the initialization process, just after a connection is opened. |
|
|
Cluster node addresses in the form 'host:port', or a simple 'host' to use the configured port. |
|
|
Timeout to use for control queries. |
|
|
Keyspace name to use. |
|
|
Datacenter that is considered "local". Contact points should be from this datacenter. |
|
|
Login password of the server. |
|
|
Heartbeat interval after which a message is sent on an idle connection to make sure it's still alive. |
|
|
Idle timeout before an idle connection is removed. |
|
|
Port to use if a contact point does not specify one. |
|
|
Queries consistency level. |
|
|
How many rows will be retrieved simultaneously in a single network round-trip. |
|
|
Queries serial consistency level. |
|
|
How often the throttler attempts to dequeue requests. Set this high enough that each attempt will process multiple entries in the queue, but not delay requests too much. |
|
|
Maximum number of requests that are allowed to execute in parallel. |
|
|
Maximum number of requests that can be enqueued when the throttling threshold is exceeded. |
|
|
Maximum allowed request rate. |
|
|
Request throttling type. |
|
|
How long the driver waits for a request to complete. |
|
|
Schema action to take at startup. |
|
|
Name of the Cassandra session. |
|
|
SSL bundle name. |
|
|
Whether to enable SSL support. |
|
|
Login user of the server. |
|
|
Connection string used to locate the Couchbase cluster. |
|
|
Length of time an HTTP connection may remain idle before it is closed and removed from the pool. |
|
|
Maximum number of sockets per node. |
|
|
Minimum number of sockets per node. |
|
|
SSL bundle name. |
|
|
Whether to enable SSL support. Enabled automatically if a "keyStore" or "bundle" is provided unless specified otherwise. |
|
|
Timeout for the analytics service. |
|
|
Bucket connect timeout. |
|
|
Bucket disconnect timeout. |
|
|
Timeout for operations on a specific key-value. |
|
|
Timeout for operations on a specific key-value with a durability level. |
|
|
Timeout for the management operations. |
|
|
N1QL query operations timeout. |
|
|
Timeout for the search service. |
|
|
Regular and geospatial view operations timeout. |
|
|
Cluster password. |
|
|
Cluster username. |
|
|
Whether to enable the PersistenceExceptionTranslationPostProcessor. |
|
|
Type of Cassandra repositories to enable. |
|
|
Automatically create views and indexes. Use the meta-data provided by "@ViewIndexed", "@N1qlPrimaryIndexed" and "@N1qlSecondaryIndexed". |
|
|
Name of the bucket to connect to. |
|
|
Fully qualified name of the FieldNamingStrategy to use. |
|
|
Type of Couchbase repositories to enable. |
|
|
Name of the scope used for all collection access. |
|
|
Name of the field that stores the type information for complex types when using "MappingCouchbaseConverter". |
|
|
Whether to enable Elasticsearch repositories. |
|
|
Whether to enable JDBC repositories. |
|
|
Bootstrap mode for JPA repositories. |
|
|
Whether to enable JPA repositories. |
|
|
Whether to enable LDAP repositories. |
|
|
Additional server hosts. Cannot be set with URI or if 'host' is not specified. Additional hosts will use the default mongo port of 27017. If you want to use a different port you can use the "host:port" syntax. |
|
|
Authentication database name. |
|
|
Whether to enable auto-index creation. |
|
|
Database name. |
|
|
Fully qualified name of the FieldNamingStrategy to use. |
|
|
GridFS bucket name. |
|
|
GridFS database name. |
|
|
Mongo server host. Cannot be set with URI. |
|
|
Login password of the mongo server. Cannot be set with URI. |
|
|
Mongo server port. Cannot be set with URI. |
|
|
Required replica set name for the cluster. Cannot be set with URI. |
|
|
Type of Mongo repositories to enable. |
|
|
SSL bundle name. |
|
|
Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |
|
|
Mongo database URI. Overrides host, port, username, password, and database. |
|
|
Login user of the mongo server. Cannot be set with URI. |
|
|
Representation to use when converting a UUID to a BSON binary value. |
|
|
Database name to use. By default, the server decides the default database to use. |
|
|
Type of Neo4j repositories to enable. |
|
|
Whether to enable R2DBC repositories. |
|
|
Client name to be set on connections with CLIENT SETNAME. |
|
|
Type of client to use. By default, auto-detected according to the classpath. |
|
|
Maximum number of redirects to follow when executing commands across the cluster. |
|
|
Comma-separated list of "host:port" pairs to bootstrap from. This represents an "initial" list of cluster nodes and is required to have at least one entry. |
|
|
Connection timeout. |
|
|
Database index used by the connection factory. |
|
|
Redis server host. |
|
|
Whether to enable the pool. Enabled automatically if "commons-pool2" is available. With Jedis, pooling is implicitly enabled in sentinel mode and this setting only applies to single node setup. |
|
|
Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
|
|
Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
|
|
Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely. |
|
|
Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive. |
|
|
Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed. |
|
|
Whether adaptive topology refreshing using all available refresh triggers should be used. |
|
|
Whether to discover and query all cluster nodes for obtaining the cluster topology. When set to false, only the initial seed nodes are used as sources for topology discovery. |
|
|
Cluster topology refresh period. |
|
|
Whether to enable the pool. Enabled automatically if "commons-pool2" is available. With Jedis, pooling is implicitly enabled in sentinel mode and this setting only applies to single node setup. |
|
|
Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. |
|
|
Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. |
|
|
Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely. |
|
|
Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive. |
|
|
Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed. |
|
|
Shutdown timeout. |
|
|
Login password of the redis server. |
|
|
Redis server port. |
|
|
Whether to enable Redis repositories. |
|
|
Name of the Redis server. |
|
|
Comma-separated list of "host:port" pairs. |
|
|
Password for authenticating with sentinel(s). |
|
|
Login username for authenticating with sentinel(s). |
|
|
SSL bundle name. |
|
|
Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |
|
|
Read timeout. |
|
|
Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:[email protected]:6379 |
|
|
Login username of the redis server. |
|
|
Base path to be used by Spring Data REST to expose repository resources. |
|
|
Content type to use as a default when none is specified. |
|
|
Default size of pages. |
|
|
Strategy to use to determine which repositories get exposed. |
|
|
Whether to enable enum value translation through the Spring Data REST default resource bundle. |
|
|
Name of the URL query string parameter that indicates how many results to return at once. |
|
|
Maximum size of pages. |
|
|
Name of the URL query string parameter that indicates what page to return. |
|
|
Whether to return a response body after creating an entity. |
|
|
Whether to return a response body after updating an entity. |
|
|
Name of the URL query string parameter that indicates what direction to sort results. |
|
|
Default page size. |
|
|
Maximum page size to be accepted. |
|
|
Whether to expose and assume 1-based page number indexes. Defaults to "false", meaning a page number of 0 in the request equals the first page. |
|
|
Page index parameter name. |
|
|
General prefix to be prepended to the page number and page size parameters. |
|
|
Delimiter to be used between the qualifier and the actual page number and size properties. |
|
|
Page size parameter name. |
|
|
Sort parameter name. |
|
|
Commons DBCP2 specific settings bound to an instance of DBCP2's BasicDataSource |
|
|
Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. |
|
|
Connection details for an embedded database. Defaults to the most suitable embedded database that is available on the classpath. |
|
|
Whether to generate a random datasource name. |
|
|
Hikari specific settings bound to an instance of Hikari's HikariDataSource |
|
|
JNDI location of the datasource. Class, url, username and password are ignored when set. |
|
|
Datasource name to use if "generate-unique-name" is false. Defaults to "testdb" when using an embedded database, otherwise null. |
|
|
Oracle UCP specific settings bound to an instance of Oracle UCP's PoolDataSource |
|
|
Login password of the database. |
|
|
Tomcat datasource specific settings bound to an instance of Tomcat JDBC's DataSource |
|
|
Fully qualified name of the connection pool implementation to use. By default, it is auto-detected from the classpath. |
|
|
JDBC URL of the database. |
|
|
Login username of the database. |
|
|
XA datasource fully qualified name. |
|
|
Properties to pass to the XA data source. |
|
|
Connection timeout used when communicating with Elasticsearch. |
|
|
Password for authentication with Elasticsearch. |
|
|
Prefix added to the path of every request sent to Elasticsearch. |
|
|
Delay of a sniff execution scheduled after a failure. |
|
|
Interval between consecutive ordinary sniff executions. |
|
|
SSL bundle name. |
|
|
Whether to enable socket keep alive between client and Elasticsearch. |
|
|
Socket timeout used when communicating with Elasticsearch. |
|
|
Comma-separated list of the Elasticsearch instances to use. |
|
|
Username for authentication with Elasticsearch. |
|
|
Whether to enable the console. |
|
|
Path at which the console is available. |
|
|
Whether to enable trace output. |
|
|
Password to access preferences and tools of H2 Console. |
|
|
Whether to enable remote access. |
|
|
Login password. |
|
|
URL of the InfluxDB instance to which to connect. |
|
|
Login user. |
|
|
Number of rows that should be fetched from the database when more rows are needed. Use -1 to use the JDBC driver's default configuration. |
|
|
Maximum number of rows. Use -1 to use the JDBC driver's default configuration. |
|
|
Query timeout. Default is to use the JDBC driver's default configuration. If a duration suffix is not specified, seconds will be used. |
|
|
SQL dialect to use. Auto-detected by default. |
|
|
Target database to operate on, auto-detected by default. Can be alternatively set using the "databasePlatform" property. |
|
|
Name of the target database to operate on, auto-detected by default. Can be alternatively set using the "Database" enum. |
|
|
Whether to defer DataSource initialization until after any EntityManagerFactory beans have been created and initialized. |
|
|
Whether to initialize the schema on startup. |
|
|
DDL mode. This is actually a shortcut for the "hibernate.hbm2ddl.auto" property. Defaults to "create-drop" when using an embedded database and no schema manager was detected. Otherwise, defaults to "none". |
|
|
Fully qualified name of the implicit naming strategy. |
|
|
Fully qualified name of the physical naming strategy. |
|
|
Mapping resources (equivalent to "mapping-file" entries in persistence.xml). |
|
|
Register OpenEntityManagerInViewInterceptor. Binds a JPA EntityManager to the thread for the entire processing of the request. |
|
|
Additional native properties to set on the JPA provider. |
|
|
Whether to enable logging of SQL statements. |
|
|
Whether read-only operations should use an anonymous environment. Disabled by default unless a username is set. |
|
|
Base suffix from which all operations should originate. |
|
|
LDAP specification settings. |
|
|
List of base DNs. |
|
|
Embedded LDAP password. |
|
|
Embedded LDAP username. |
|
|
Schema (LDIF) script resource reference. |
|
|
Embedded LDAP port. |
|
|
Whether to enable LDAP schema validation. |
|
|
Path to the custom schema. |
|
|
Login password of the server. |
|
|
Whether NameNotFoundException should be ignored in searches through the LdapTemplate. |
|
|
Whether PartialResultException should be ignored in searches through the LdapTemplate. |
|
|
Whether SizeLimitExceededException should be ignored in searches through the LdapTemplate. |
|
|
LDAP URLs of the server. |
|
|
Login username of the server. |
|
|
Kerberos ticket for connecting to the database. Mutual exclusive with a given username. |
|
|
Login password of the server. |
|
|
Realm to connect to. |
|
|
Login user of the server. |
|
|
Timeout for borrowing connections from the pool. |
|
|
Maximum time transactions are allowed to retry. |
|
|
Acquisition of new connections will be attempted for at most configured timeout. |
|
|
Pooled connections that have been idle in the pool for longer than this threshold will be tested before they are used again. |
|
|
Whether to log leaked sessions. |
|
|
Pooled connections older than this threshold will be closed and removed from the pool. |
|
|
Maximum amount of connections in the connection pool towards a single database. |
|
|
Whether to enable metrics. |
|
|
Path to the file that holds the trusted certificates. |
|
|
Whether the driver should use encrypted traffic. |
|
|
Whether hostname verification is required. |
|
|
Trust strategy to use. |
|
|
URI used by the driver. |
|
|
Whether to generate a random database name. Ignore any configured name when enabled. |
|
|
Database name. Set if no name is specified in the url. Default to "testdb" when using an embedded database. |
|
|
Login password of the database. Set if no password is specified in the url. |
|
|
Whether pooling is enabled. Requires r2dbc-pool. |
|
|
Initial connection pool size. |
|
|
Maximum time to acquire a connection from the pool. By default, wait indefinitely. |
|
|
Maximum time to wait to create a new connection. By default, wait indefinitely. |
|
|
Maximum amount of time that a connection is allowed to sit idle in the pool. |
|
|
Maximum lifetime of a connection in the pool. By default, connections have an infinite lifetime. |
|
|
Maximal connection pool size. |
|
|
Maximum time to validate a connection from the pool. By default, wait indefinitely. |
|
|
Minimal number of idle connections. |
|
|
Validation depth. |
|
|
Validation query. |
|
|
Additional R2DBC options. |
|
|
R2DBC URL of the database. database name, username, password and pooling options specified in the url take precedence over individual options. |
|
|
Login username of the database. Set if no username is specified in the url. |
6. Transaction Properties
Name | Description | Default Value |
---|---|---|
|
Timeout, in seconds, for borrowing connections from the pool. |
|
|
Whether to ignore the transacted flag when creating session. |
|
|
Whether local transactions are desired. |
|
|
Time, in seconds, between runs of the pool's maintenance thread. |
|
|
Time, in seconds, after which connections are cleaned up from the pool. |
|
|
Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. |
|
|
Maximum size of the pool. |
|
|
Minimum size of the pool. |
|
|
Reap timeout, in seconds, for borrowed connections. 0 denotes no limit. |
|
|
Unique name used to identify the resource during recovery. |
|
|
Vendor-specific implementation of XAConnectionFactory. |
|
|
Vendor-specific XA properties. |
|
|
Timeout, in seconds, for borrowing connections from the pool. |
|
|
Whether to use concurrent connection validation. |
|
|
Default isolation level of connections provided by the pool. |
|
|
Timeout, in seconds, for establishing a database connection. |
|
|
Time, in seconds, between runs of the pool's maintenance thread. |
|
|
Time, in seconds, after which connections are cleaned up from the pool. |
|
|
Time, in seconds, that a connection can be pooled for before being destroyed. 0 denotes no limit. |
|
|
Maximum size of the pool. |
|
|
Minimum size of the pool. |
|
|
Reap timeout, in seconds, for borrowed connections. 0 denotes no limit. |
|
|
SQL query or statement used to validate a connection before returning it. |
|
|
Unique name used to identify the resource during recovery. |
|
|
Vendor-specific implementation of XAConnectionFactory. |
|
|
Vendor-specific XA properties. |
|
|
Whether to enable JTA support. |
|
|
Default transaction timeout. If a duration suffix is not specified, seconds will be used. |
|
|
Whether to roll back on commit failures. |
7. Data Migration Properties
Name | Description | Default Value |
---|---|---|
|
Description to tag an existing schema with when applying a baseline. |
|
|
Whether to automatically call baseline when migrating a non-empty schema. |
|
|
Version to tag an existing schema with when executing baseline. |
|
|
Whether to batch SQL statements when executing them. Requires Flyway Teams. |
|
|
Migrations that Flyway should consider when migrating or undoing. When empty all available migrations are considered. Requires Flyway Teams. |
|
|
Whether to disable cleaning of the database. |
|
|
Whether to automatically call clean when a validation error occurs. |
|
|
Maximum number of retries when attempting to connect to the database. |
|
|
Maximum time between retries when attempting to connect to the database. If a duration suffix is not specified, seconds will be used. |
|
|
Whether Flyway should attempt to create the schemas specified in the schemas property. |
|
|
Default schema name managed by Flyway (case-sensitive). |
|
|
Whether to attempt to automatically detect SQL migration file encoding. Requires Flyway Teams. |
|
|
Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. |
|
|
Whether to enable flyway. |
|
|
Encoding of SQL migrations. |
|
|
Rules for the built-in error handling to override specific SQL states and error codes. Requires Flyway Teams. |
|
|
Whether Flyway should execute SQL within a transaction. |
|
|
Whether to fail if a location of migration scripts doesn't exist. |
|
|
Whether to group all pending migrations together in the same transaction when applying them. |
|
|
Ignore migrations that match this comma-separated list of patterns when validating migrations. Requires Flyway Teams. |
|
|
SQL statements to execute to initialize a connection immediately after obtaining it. |
|
|
Username recorded in the schema history table as having applied the migration. |
|
|
Properties to pass to the JDBC driver. Requires Flyway Teams. |
|
|
Path of the Kerberos config file. Requires Flyway Teams. |
|
|
Licence key for Flyway Teams. |
|
|
Locations of migrations scripts. Can contain the special "{vendor}" placeholder to use vendor-specific locations. |
|
|
Maximum number of retries when trying to obtain a lock. |
|
|
Loggers Flyway should use. |
|
|
Whether to allow mixing transactional and non-transactional statements within the same migration. |
|
|
Path of the Oracle Kerberos cache file. Requires Flyway Teams. |
|
|
Whether to enable support for Oracle SQL*Plus commands. Requires Flyway Teams. |
|
|
Whether to issue a warning rather than an error when a not-yet-supported Oracle SQL*Plus statement is encountered. Requires Flyway Teams. |
|
|
Location of the Oracle Wallet, used to sign in to the database automatically. Requires Flyway Teams. |
|
|
Whether to allow migrations to be run out of order. |
|
|
Whether Flyway should output a table with the results of queries when executing migrations. Requires Flyway Teams. |
|
|
Login password of the database to migrate. |
|
|
Prefix of placeholders in migration scripts. |
|
|
Perform placeholder replacement in migration scripts. |
|
|
Separator of default placeholders. |
|
|
Suffix of placeholders in migration scripts. |
|
|
Placeholders and their replacements to apply to sql migration scripts. |
|
|
File name prefix for repeatable SQL migrations. |
|
|
Scheme names managed by Flyway (case-sensitive). |
|
|
Prefix of placeholders in migration scripts. |
|
|
Suffix of placeholders in migration scripts. |
|
|
Whether to skip default callbacks. If true, only custom callbacks are used. |
|
|
Whether to skip default resolvers. If true, only custom resolvers are used. |
|
|
Whether Flyway should skip executing the contents of the migrations and only update the schema history table. Requires Flyway teams. |
|
|
File name prefix for SQL migrations. |
|
|
File name separator for SQL migrations. |
|
|
File name suffix for SQL migrations. |
|
|
Path to the SQL Server Kerberos login file. Requires Flyway Teams. |
|
|
Whether to stream SQL migrations when executing them. Requires Flyway Teams. |
|
|
Name of the schema history table that will be used by Flyway. |
|
|
Tablespace in which the schema history table is created. Ignored when using a database that does not support tablespaces. Defaults to the default tablespace of the connection used by Flyway. |
|
|
Target version up to which migrations should be considered. |
|
|
JDBC url of the database to migrate. If not set, the primary configured data source is used. |
|
|