Micronaut Data Configuration Reference

Every documented configuration property of Micronaut Data, with types, descriptions, and defaults.

Micronaut Data documentation

41 properties across 5 sections

Micronaut Data Azure Cosmos Config Properties

Configuration properties for CosmosDatabaseConfiguration

PropertyTypeDescription
azure.cosmos.database.database-namejava.lang.StringSets the database name.
azure.cosmos.database.update-policyStorageUpdatePolicySets the update policy for the database to be used during startup.
azure.cosmos.database.packagesjava.util.Listthe list of package names to filter entities during init database and containers
azure.cosmos.database.query-metrics-enabledbooleanSets the indicator telling whether query metrics will be enabled for Azure Cosmos Db query requests.
azure.cosmos.database.disable-non-streaming-order-bybooleanSets an indicator telling whether non-streaming order by is by default disabled.

Configuration properties for CosmosDatabaseConfiguration$CosmosContainerSettings

PropertyTypeDescription
azure.cosmos.database.container-settings[*].container-namejava.lang.StringSets the container name.
azure.cosmos.database.container-settings[*].partition-key-pathjava.lang.StringSets the container partition key path.

Configuration properties for CosmosDatabaseConfiguration$CosmosContainerSettings$ContainerThroughputSettings

PropertyTypeDescription
azure.cosmos.database.container-settings[*].throughput-settings.request-unitsjava.lang.IntegerSets the request units.
azure.cosmos.database.container-settings[*].throughput-settings.auto-scalebooleanSets the auto scaled indicator for throughput.

Configuration properties for CosmosDatabaseConfiguration$DefaultThroughputSettings

PropertyTypeDescription
azure.cosmos.database.throughput-settings.request-unitsjava.lang.IntegerSets the request units.
azure.cosmos.database.throughput-settings.auto-scalebooleanSets the auto scaled indicator for throughput.

Micronaut Data Jdbc Config Properties

Configuration properties for DataJdbcConfiguration

PropertyTypeDescription
datasources.*.schema-generateSchemaGenerateSets the schema generation strategy.
datasources.*.batch-generatebooleanWhether to generate tables in batch.
datasources.*.packagesjava.util.ListSets the packages to include use for the purposes of schema generation.
datasources.*.dialectDialectSets the dialect.
datasources.*.allow-connection-per-operationbooleanIf true, {@link javax.sql.DataSource#getConnection()} will be used in try-resource block for the operation.
datasources.*.schema-generate-namejava.lang.StringThe schema name that should be used for generating
datasources.*.schema-generate-namesjava.util.ListThe schema names that should be used for generating
datasources.*.enabledbooleanSets an indicator telling whether data source is enabled.
datasources.*.unique-result-on-find-onebooleanFail on multiple results for findOne.
datasources.*.default-fetch-sizejava.lang.IntegerSets the default fetch size for the JDBC driver. The fetch size is a hint to the JDBC driver as to the number of rows that should be fetched from the database when more rows are needed. If set to null, the JDBC driver’s default fetch size will be used. Used in streaming operations.

Micronaut Data Mongodb Config Properties

Configuration properties for MongoDataConfiguration

PropertyTypeDescription
micronaut.data.mongodb.create-collectionsbooleanCreate MongoDB collection at app initialization.
micronaut.data.mongodb.ignore-json-viewsbooleanIgnore any JsonView annotations on the properties of mapped entity during encode and decode operations.
micronaut.data.mongodb.driver-typeMongoDataConfiguration$DriverTypeChoose the appropriate driver type when both are on classpath.

Micronaut Data R2dbc Config Properties

Configuration properties for DataR2dbcConfiguration

PropertyTypeDescription
r2dbc.datasources.*.schema-generateSchemaGenerateSets the schema generation strategy.
r2dbc.datasources.*.batch-generatebooleanWhether to generate tables in batch.
r2dbc.datasources.*.packagesjava.util.ListSets the packages to include use for the purposes of schema generation.
r2dbc.datasources.*.dialectDialectSets the dialect.
r2dbc.datasources.*.schema-generate-namejava.lang.StringThe schema name that should be used for generating
r2dbc.datasources.*.schema-generate-namesjava.util.ListThe schema names that should be used for generating
r2dbc.datasources.*.default-fetch-sizejava.lang.IntegerSets the default fetch size for the JDBC driver. The fetch size is a hint to the JDBC driver as to the number of rows that should be fetched from the database when more rows are needed. If set to null, the JDBC driver’s default fetch size will be used. Used in streaming operations.

Micronaut Data Runtime Config Properties

Configuration properties for DataConfiguration

PropertyTypeDescription
micronaut.data.save-as-insertbooleanSets whether repository save methods should always use insert operations. This restores the Micronaut Data 4 behavior where {@code save} and {@code saveAll} always inserted entities instead of selecting insert or update based on identity state.
micronaut.data.save-assigned-id-fallback-to-updatebooleanSets whether repository save methods should fall back to update when an insert detects that an entity with a non-generated identity already exists.

Configuration properties for MultiTenancyConfiguration

PropertyTypeDescription
micronaut.data.multi-tenancy.modeMultiTenancyModeSets the multi-tenancy mode.

Configuration properties for DataConfiguration$PageableConfiguration

PropertyTypeDescription
micronaut.data.pageable.sort-ignore-casebooleanWhether sort ignores case.
micronaut.data.pageable.sort-delimiterjava.lang.StringThe delimiter to use to calculate sort order. Defaults to {@code ,}.
micronaut.data.pageable.max-page-sizeintSets the maximum page size when binding Pageable objects.
micronaut.data.pageable.default-page-sizeintSets the default page size when binding Pageable objects and no size parameter is used. Should be smaller or equal than {@link #maxPageSize}.
micronaut.data.pageable.sort-parameter-namejava.lang.StringThe default sort parameter name
micronaut.data.pageable.size-parameter-namejava.lang.StringThe default size parameter name
micronaut.data.pageable.page-parameter-namejava.lang.StringThe default page parameter name