{"record":{"id":"3fc8f9fc2687d10e","repo":"quarkusio/quarkus","slug":"the-quarkus-hibernate-orm-mapping-format-global","errorCode":null,"errorMessage":"The 'quarkus.hibernate-orm.mapping.format.global' configuration property is deprecated and only accepts 'ignore'. Quarkus no longer pre-builds format mappers. Either define a custom `FormatMapper` bean or let Hibernate ORM create its own internally. Refer to https://quarkus.io/guides/hibernate-orm#json_xml_serialization_deserialization for guidance. Remove this property or set it to 'ignore'.","messagePattern":"The 'quarkus\\.hibernate-orm\\.mapping\\.format\\.global' configuration property is deprecated and only accepts 'ignore'\\. Quarkus no longer pre-builds format mappers\\. Either define a custom `FormatMapper` bean or let Hibernate ORM create its own internally\\. Refer to https://quarkus\\.io/guides/hibernate-orm#json_xml_serialization_deserialization for guidance\\. Remove this property or set it to 'ignore'\\.","errorType":"exception","errorClass":"ConfigurationException","httpStatus":null,"severity":"error","filePath":"extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/customized/BuiltinFormatMapperBehaviour.java","lineNumber":42,"sourceCode":"        @Override\n        public void action() {\n            fail();\n        }\n    },\n    /**\n     * A no longer supported option. Using it will result in the application failing at build time.\n     *\n     * @asciidoclet\n     */\n    FAIL {\n        @Override\n        public void action() {\n            fail();\n        }\n    };\n\n    private static void fail() {\n        throw new ConfigurationException(\n                \"The 'quarkus.hibernate-orm.mapping.format.global' configuration property is deprecated\"\n                        + \" and only accepts 'ignore'. Quarkus no longer pre-builds format mappers.\"\n                        + \" Either define a custom `FormatMapper` bean or let Hibernate ORM create its own internally.\"\n                        + \" Refer to https://quarkus.io/guides/hibernate-orm#json_xml_serialization_deserialization for guidance.\"\n                        + \" Remove this property or set it to 'ignore'.\");\n    }\n\n    public abstract void action();\n}\n","sourceCodeStart":24,"sourceCodeEnd":52,"githubUrl":"https://github.com/quarkusio/quarkus/blob/e1c734241f34c7919086ceb4c9262b4a58f6de44/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/customized/BuiltinFormatMapperBehaviour.java#L24-L52","documentation":"BuiltinFormatMapperBehaviour.FAIL's action calls fail(), which throws a ConfigurationException. Since Quarkus no longer pre-builds JSON/XML FormatMapper instances for Hibernate ORM, the only accepted value of quarkus.hibernate-orm.mapping.format.global is 'ignore'; any other value (the old 'fail' behavior) deliberately aborts startup with this message.","triggerScenarios":"Keeping quarkus.hibernate-orm.mapping.format.global=fail (or any value other than 'ignore') in application.properties after upgrading Quarkus, causing Hibernate ORM startup to throw a ConfigurationException.","commonSituations":"Upgrading an application from an older Quarkus where this property controlled built-in mapper behavior; stale config in CI/test profiles; following outdated documentation or examples.","solutions":["Remove the quarkus.hibernate-orm.mapping.format.global property from your configuration entirely.","Or set quarkus.hibernate-orm.mapping.format.global=ignore, the only accepted value.","If you need custom JSON/XML mapping, define your own FormatMapper CDI bean instead of relying on built-in mapper configuration.","See the referenced Quarkus Hibernate ORM guide section on JSON/XML serialization for the supported approach."],"exampleFix":"# before\nquarkus.hibernate-orm.mapping.format.global=fail\n\n# after\nquarkus.hibernate-orm.mapping.format.global=ignore","handlingStrategy":"validation","validationCode":"// Detect the deprecated/unsupported property value before startup\nString val = System.getProperty(\"quarkus.hibernate-orm.mapping.format.global\",\n        System.getenv().getOrDefault(\"QUARKUS_HIBERNATE_ORM_MAPPING_FORMAT_GLOBAL\", \"\"));\nif (!val.isEmpty() && !val.equals(\"ignore\")) {\n    throw new IllegalStateException(\n        \"quarkus.hibernate-orm.mapping.format.global must be removed or set to 'ignore'; got: \" + val);\n}","typeGuard":null,"tryCatchPattern":"try {\n    startApplication();\n} catch (io.quarkus.runtime.ConfigurationException e) {\n    if (e.getMessage() != null && e.getMessage().contains(\"mapping.format.global\")) {\n        log.error(\"Remove the property or set it to 'ignore'; use a custom FormatMapper bean if needed\", e);\n    }\n    throw e;\n}","preventionTips":["Audit application.properties for quarkus.hibernate-orm.mapping.format.* keys after each Quarkus upgrade","Use the Quarkus config report (dev mode) to spot ignored/removed properties","Provide custom JSON/XML mapping via FormatMapper CDI beans instead of the removed global switch"],"tags":["hibernate-orm","config","deprecation","quarkus","startup"],"backgroundTag":"removed-config-property","analyzedSha":"e1c734241f34c7919086ceb4c9262b4a58f6de44","analyzedAt":"2026-09-05T17:01:29.979Z","contentChangedAt":"2026-09-05T17:01:29.979Z","schemaVersion":2},"datasetVersion":"2026-09-14T00:17:10.932Z"}