{"id":11220,"date":"2024-03-14T13:37:53","date_gmt":"2024-03-14T13:37:53","guid":{"rendered":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/"},"modified":"2025-08-04T09:03:39","modified_gmt":"2025-08-04T09:03:39","slug":"how-to-use-the-usegeneratedkeys-parameter-in-mybatis","status":"publish","type":"post","link":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/","title":{"rendered":"MyBatis useGeneratedKeys: Complete Guide"},"content":{"rendered":"<p>In MyBatis, useGeneratedKeys parameter can be used by configuring elements.<\/p>\n<p>For example, defining a method in the Mapper interface as shown below:<\/p>\n<pre class=\"post-pre\"><code><span class=\"hljs-meta\">@Insert(\"INSERT INTO user(name, age) VALUES(#{name}, #{age})\")<\/span>\r\n<span class=\"hljs-meta\">@Options(useGeneratedKeys=true, keyProperty=\"id\")<\/span>\r\n<span class=\"hljs-type\">int<\/span> <span class=\"hljs-title function_\">insert<\/span><span class=\"hljs-params\">(User user)<\/span>;\r\n<\/code><\/pre>\n<p>In this example, the useGeneratedKeys parameter is set to true in the @Options annotation, indicating that database-generated primary key values should be used. keyProperty specifies which property of the User object the generated primary key value should be set to.<\/p>\n<p>When the insert method is called to insert a record, MyBatis will call the database to generate the primary key value and set that value to the id property of the User object.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>In MyBatis, useGeneratedKeys parameter can be used by configuring elements. For example, defining a method in the Mapper interface as shown below: @Insert(&#8220;INSERT INTO user(name, age) VALUES(#{name}, #{age})&#8221;) @Options(useGeneratedKeys=true, keyProperty=&#8221;id&#8221;) int insert(User user); In this example, the useGeneratedKeys parameter is set to true in the @Options annotation, indicating that database-generated primary key values should be [&hellip;]<\/p>\n","protected":false},"author":12,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","footnotes":""},"categories":[1],"tags":[1459,14369,14368,2742,14355],"class_list":["post-11220","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-mybatis","tag-mybatis-auto-generated-keys","tag-mybatis-insert","tag-mybatis-tutorial","tag-usegeneratedkeys"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v21.5 (Yoast SEO v21.5) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>MyBatis useGeneratedKeys: Complete Guide - Blog - Silicon Cloud<\/title>\n<meta name=\"description\" content=\"Learn to retrieve auto-generated keys in MyBatis using useGeneratedKeys. Step-by-step example with @Options annotation.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"MyBatis useGeneratedKeys: Complete Guide\" \/>\n<meta property=\"og:description\" content=\"Learn to retrieve auto-generated keys in MyBatis using useGeneratedKeys. Step-by-step example with @Options annotation.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/\" \/>\n<meta property=\"og:site_name\" content=\"Blog - Silicon Cloud\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\" \/>\n<meta property=\"article:published_time\" content=\"2024-03-14T13:37:53+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-08-04T09:03:39+00:00\" \/>\n<meta name=\"author\" content=\"Liam\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:site\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Liam\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/\"},\"author\":{\"name\":\"Liam\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/23786905eb7b377f45ddb01c17da7671\"},\"headline\":\"MyBatis useGeneratedKeys: Complete Guide\",\"datePublished\":\"2024-03-14T13:37:53+00:00\",\"dateModified\":\"2025-08-04T09:03:39+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/\"},\"wordCount\":99,\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"keywords\":[\"MyBatis\",\"MyBatis auto-generated keys\",\"MyBatis insert\",\"MyBatis tutorial\",\"useGeneratedKeys\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/\",\"name\":\"MyBatis useGeneratedKeys: Complete Guide - Blog - Silicon Cloud\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\"},\"datePublished\":\"2024-03-14T13:37:53+00:00\",\"dateModified\":\"2025-08-04T09:03:39+00:00\",\"description\":\"Learn to retrieve auto-generated keys in MyBatis using useGeneratedKeys. Step-by-step example with @Options annotation.\",\"breadcrumb\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.silicloud.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"MyBatis useGeneratedKeys: Complete Guide\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"name\":\"Silicon Cloud Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\",\"name\":\"Silicon Cloud Blog\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"contentUrl\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"width\":1024,\"height\":1024,\"caption\":\"Silicon Cloud Blog\"},\"image\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\",\"https:\/\/twitter.com\/SiliCloudGlobal\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/23786905eb7b377f45ddb01c17da7671\",\"name\":\"Liam\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g\",\"caption\":\"Liam\"},\"sameAs\":[\"http:\/\/Wilson\"],\"url\":\"https:\/\/www.silicloud.com\/blog\/author\/liamwilson\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"MyBatis useGeneratedKeys: Complete Guide - Blog - Silicon Cloud","description":"Learn to retrieve auto-generated keys in MyBatis using useGeneratedKeys. Step-by-step example with @Options annotation.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/","og_locale":"en_US","og_type":"article","og_title":"MyBatis useGeneratedKeys: Complete Guide","og_description":"Learn to retrieve auto-generated keys in MyBatis using useGeneratedKeys. Step-by-step example with @Options annotation.","og_url":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/","og_site_name":"Blog - Silicon Cloud","article_publisher":"https:\/\/www.facebook.com\/SiliCloudGlobal\/","article_published_time":"2024-03-14T13:37:53+00:00","article_modified_time":"2025-08-04T09:03:39+00:00","author":"Liam","twitter_card":"summary_large_image","twitter_creator":"@SiliCloudGlobal","twitter_site":"@SiliCloudGlobal","twitter_misc":{"Written by":"Liam","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/#article","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/"},"author":{"name":"Liam","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/23786905eb7b377f45ddb01c17da7671"},"headline":"MyBatis useGeneratedKeys: Complete Guide","datePublished":"2024-03-14T13:37:53+00:00","dateModified":"2025-08-04T09:03:39+00:00","mainEntityOfPage":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/"},"wordCount":99,"publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"keywords":["MyBatis","MyBatis auto-generated keys","MyBatis insert","MyBatis tutorial","useGeneratedKeys"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/","url":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/","name":"MyBatis useGeneratedKeys: Complete Guide - Blog - Silicon Cloud","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/#website"},"datePublished":"2024-03-14T13:37:53+00:00","dateModified":"2025-08-04T09:03:39+00:00","description":"Learn to retrieve auto-generated keys in MyBatis using useGeneratedKeys. Step-by-step example with @Options annotation.","breadcrumb":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-the-usegeneratedkeys-parameter-in-mybatis\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.silicloud.com\/blog\/"},{"@type":"ListItem","position":2,"name":"MyBatis useGeneratedKeys: Complete Guide"}]},{"@type":"WebSite","@id":"https:\/\/www.silicloud.com\/blog\/#website","url":"https:\/\/www.silicloud.com\/blog\/","name":"Silicon Cloud Blog","description":"","publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.silicloud.com\/blog\/#organization","name":"Silicon Cloud Blog","url":"https:\/\/www.silicloud.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","contentUrl":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","width":1024,"height":1024,"caption":"Silicon Cloud Blog"},"image":{"@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/SiliCloudGlobal\/","https:\/\/twitter.com\/SiliCloudGlobal"]},{"@type":"Person","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/23786905eb7b377f45ddb01c17da7671","name":"Liam","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/8d37ed3e7f770dde8bf069ba0b4298688028c3abaacf1131742fc1352d174ebd?s=96&d=mm&r=g","caption":"Liam"},"sameAs":["http:\/\/Wilson"],"url":"https:\/\/www.silicloud.com\/blog\/author\/liamwilson\/"}]}},"_links":{"self":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/11220","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/users\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/comments?post=11220"}],"version-history":[{"count":2,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/11220\/revisions"}],"predecessor-version":[{"id":154992,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/11220\/revisions\/154992"}],"wp:attachment":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/media?parent=11220"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/categories?post=11220"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/tags?post=11220"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}