| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Setup and Configuration :: causeway</title> |
| <link rel="canonical" href="https://causeway.apache.org/pjpa/latest/setup-and-configuration.html"> |
| <meta name="generator" content="Antora 3.1.1"> |
| <link rel="stylesheet" href="../../_/css/site.css"> |
| <link rel="stylesheet" href="../../_/css/site-custom.css"> |
| <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i|Raleway:300,400,500,700,800|Montserrat:300,400,700" rel="stylesheet"> |
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"/> |
| <link rel="home" href="https://causeway.apache.org" title="causeway"> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <a class="navbar-item" href="https://causeway.apache.org"> |
| <span class="icon"> |
| <img src="../../_/img/causeway-logo-no-words-65x48.png"></img> |
| </span> |
| <span class="navbar-title">causeway</span> |
| </a> |
| <button class="navbar-burger" data-target="topbar-nav"> |
| <span></span> |
| <span></span> |
| <span></span> |
| </button> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <a class="navbar-end"> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Quick Start</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Starter Apps</span> |
| <a class="navbar-item" href="../../docs/latest/starters/helloworld.html">Hello World</a> |
| <a class="navbar-item" href="../../docs/latest/starters/simpleapp.html">Simple App</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Learning & Tutorials</span> |
| <a class="navbar-item" href="../../docs/latest/reference/about.html">Reference App</a> |
| <a class="navbar-item" href="https://danhaywood.gitlab.io/isis-petclinic-tutorial-docs/petclinic/1.16.2/intro.html">Petclinic</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Resources</span> |
| <a class="navbar-item" href="../../docs/latest/resources/cheatsheet.html">Cheatsheet</a> |
| <a class="navbar-item" href="../../docs/latest/resources/icons.html">Icons</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Guides</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../userguide/latest/about.html">User Guide</a> |
| <a class="navbar-item" href="../../refguide/latest/about.html">Reference Guide</a> |
| <a class="navbar-item" href="../../testing/latest/about.html">Testing Guide</a> |
| <a class="navbar-item" href="../../security/latest/about.html">Security Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">For use in apps</span> |
| <a class="navbar-item" href="../../valuetypes/latest/about.html">Value Types</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../setupguide/latest/about.html">Setup Guide</a> |
| <a class="navbar-item" href="../../conguide/latest/about.html">Contributors' Guide</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Components</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../security/latest/bypass/about.html">Bypass</a> |
| <a class="navbar-item" href="../../security/latest/simple/about.html">Simple</a> |
| <a class="navbar-item" href="../../security/latest/shiro/about.html">Shiro</a> |
| <a class="navbar-item" href="../../security/latest/spring/about.html">Spring</a> |
| <a class="navbar-item" href="../../security/latest/keycloak/about.html">Keycloak</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Viewers</span> |
| <a class="navbar-item" href="../../vw/latest/about.html">Web UI (Wicket)</a> |
| <a class="navbar-item" href="../../gqlv/latest/about.html">GraphQL API</a> |
| <a class="navbar-item" href="../../vro/latest/about.html">REST API (Restful Objects)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../pjpa/latest/about.html">JPA (EclipseLink)</a> |
| <a class="navbar-item" href="../../pjdo/latest/about.html">JDO (DataNucleus)</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Extensions</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../userguide/latest/commandlog/about.html">Command Log</a> |
| <a class="navbar-item" href="../../userguide/latest/docgen/about.html">Doc Gen</a> |
| <a class="navbar-item" href="../../userguide/latest/executionlog/about.html">Execution Log</a> |
| <a class="navbar-item" href="../../userguide/latest/executionoutbox/about.html">Execution Outbox</a> |
| <a class="navbar-item" href="../../userguide/latest/executionrepublisher/about.html">Execution Republisher</a> |
| <a class="navbar-item" href="../../userguide/latest/excel/about.html">Excel</a> |
| <a class="navbar-item" href="../../userguide/latest/flyway/about.html">Flyway</a> |
| <a class="navbar-item" href="../../userguide/latest/layoutloaders/about.html">Layout Loaders</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../security/latest/secman/about.html">Secman</a> |
| <a class="navbar-item" href="../../security/latest/audittrail/about.html">Audit Trail</a> |
| <a class="navbar-item" href="../../security/latest/spring-oauth2/about.html">Spring OAuth2 Integration</a> |
| <a class="navbar-item" href="../../security/latest/shiro-realm-ldap/about.html">LDAP Realm for Shiro</a> |
| <a class="navbar-item" href="../../security/latest/sessionlog/about.html">Session Log</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Web UI (Wicket)</span> |
| <a class="navbar-item" href="../../vw/latest/fullcalendar/about.html">Full Calendar</a> |
| <a class="navbar-item" href="../../vw/latest/pdfjs/about.html">pdf.js</a> |
| <a class="navbar-item" href="../../vw/latest/sse/about.html">Server Side Events</a> |
| <a class="navbar-item" href="../../vw/latest/tabular/about.html">Tabular Download</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">REST API (Restful Objects)</span> |
| <a class="navbar-item" href="../../vro/latest/cors/about.html">CORS</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Support</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Contact</span> |
| <a class="navbar-item" href="../../docs/latest/support/slack-channel.html">Slack</a> |
| <a class="navbar-item" href="../../docs/latest/support/mailing-list.html">Mailing Lists</a> |
| <a class="navbar-item" href="https://issues.apache.org/jira/browse/CAUSEWAY">JIRA</a> |
| <a class="navbar-item" href="https://stackoverflow.com/questions/tagged/causeway">Stack Overflow</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Releases</span> |
| <a class="navbar-item" href="../../docs/latest/downloads/how-to.html">Downloads</a> |
| <a class="navbar-item" href="../../relnotes/latest/about.html">Release Notes</a> |
| <hr class="navbar-divider"/> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Framework</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Process</span> |
| <a class="navbar-item" href="../../comguide/latest/about.html">Committers' Guide</a> |
| <a class="navbar-item" href="../../tooling/latest/about.html">Tooling</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Automated Analysis</span> |
| <a class="navbar-item" href="https://sonarcloud.io/dashboard?id=apache_causeway">SonarCloud.io</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Interim Builds</span> |
| <a class="navbar-item" href="../../comguide/latest/nightly-builds.html">Nightly builds</a> |
| <a class="navbar-item" href="../../comguide/latest/weekly-builds.html">Weekly builds</a> |
| <a class="navbar-item" href="https://apache-causeway-committers.github.io/causeway-nightly">Website Preview (not ASF hosted)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../core/latest/about.html">Internal Design Docs</a> |
| <a class="navbar-item" href="../../regressiontests/latest/about.html">Regression Tests</a> |
| <a class="navbar-item" href="../../incubator/latest/about.html">Incubator</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Thanks</span> |
| <a class="navbar-item" href="../../more-thanks/latest/more-thanks.html">Acknowledgements</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">ASF</a> |
| <div class="navbar-dropdown"> |
| <a class="navbar-item" href="http://www.apache.org/">Apache Homepage</a> |
| <a class="navbar-item" href="https://www.apache.org/events/current-event">Events</a> |
| <a class="navbar-item" href="https://www.apache.org/licenses/">License</a> |
| <a class="navbar-item" href="https://www.apache.org/security/">Security</a> |
| <a class="navbar-item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a> |
| <hr class="navbar-divider"/> |
| <a class="navbar-item" href="https://whimsy.apache.org/board/minutes/Causeway.html">PMC board minutes</a> |
| </div> |
| </div> |
| <a class="navbar-item" href="../../docs/latest/about.html"> |
| <span class="icon"> |
| <img src="../../_/img/home.png"></img> |
| </span> |
| </a> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <div class="body "> |
| <div class="nav-container" data-component="pjpa" data-version="2.0.0"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-search hide-for-print"> |
| <input id="algolia-search-input" placeholder="Search"></span> |
| </div> |
| <div class="nav-panel-pagination"> |
| <a class="page-previous disabled" rel="prev" href="" title=""><span></span></a> |
| <a class="page-next disabled" rel="next" |
| href="" title=""><span></span></a> |
| <!-- |
| page.parent doesn't seem to be set... |
| <a class="page-parent disabled" rel="prev" href="" title=""><span></span></a> |
| --> |
| </div> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <h3 class="title"><a href="about.html">JPA</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/setup-and-configuration.html">Setup and Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/weaving.html">Weaving</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/caching.html">Caching</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/db-schemas.html">DB Schemas</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/mapping-guide.html">Mapping Guide</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/dependency-injection.html">Dependency Injection</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/domain-services.html">Domain Services</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/hints-and-tips.html">Hints and Tips</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| <div class="nav-panel-explore" data-panel="explore"> |
| <div class="context"> |
| <span class="title">JPA</span> |
| <span class="version">2.0.0</span> |
| </div> |
| <ul class="components"> |
| <li class="component"> |
| <span class="title"> </span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../docs/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Committers' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../comguide/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Contributors' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../conguide/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Design Docs</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../core/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Extensions</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../extensions/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">GraphQL Viewer</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../gqlv/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Incubator Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../incubator/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JDO/DataNucleus</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../pjdo/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <span class="title">JPA</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../latest/about.html">3.0.0</a> |
| </li> |
| <li class="version is-current"> |
| <a href="about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Reference Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../refguide/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">regressiontests</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../regressiontests/latest/index.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/2.0.0/index.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Release Notes</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../relnotes/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">REST API (Restful Objects Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../vro/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Security Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../security/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Setup Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../setupguide/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Testing Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../testing/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Tooling</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../tooling/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tooling/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Tutorials</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../tutorials/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">User Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../userguide/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Value Types Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../valuetypes/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Web UI (Wicket Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../vw/latest/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main role="main"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="../../docs/latest/about.html" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="about.html">JPA</a></li> |
| <li><a href="setup-and-configuration.html">Setup and Configuration</a></li> |
| </ul> |
| </nav> |
| <div class="page-versions"> |
| <button class="version-menu-toggle" title="Show other versions of page">2.0.0</button> |
| <div class="version-menu"> |
| <a class="version" href="../latest/setup-and-configuration.html">3.0.0</a> |
| <a class="version is-current" href="setup-and-configuration.html">2.0.0</a> |
| </div> |
| </div> |
| <div class="edit-this-page"><a href="https://github.com/apache/causeway/edit/2.0.0/persistence/jpa/adoc/modules/ROOT/pages/setup-and-configuration.adoc">Edit</a></div> |
| </div> |
| <article class="doc"> |
| <a name="section-top"></a> |
| <h1 class="page">Setup and Configuration</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This section describes how to include the JPA module and setup its configuration properties.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="maven-pom-xml"><a class="anchor" href="#maven-pom-xml"></a>Maven pom.xml</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="dependency-management"><a class="anchor" href="#dependency-management"></a>Dependency Management</h3> |
| <div class="paragraph"> |
| <p>If your application inherits from the Apache Causeway starter app (<code>org.apache.causeway.app:causeway-app-starter-parent</code>) then that will define the version automatically:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="title">pom.xml</div> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><parent> |
| <groupId>org.apache.causeway.app</groupId> |
| <artifactId>causeway-app-starter-parent</artifactId> |
| <version>3.0.0</version> |
| <relativePath/> |
| </parent></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Alternatively, import the core BOM. |
| This is usually done in the top-level parent pom of your application:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="title">pom.xml</div> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><dependencyManagement> |
| <dependencies> |
| <dependency> |
| <groupId>org.apache.causeway.core</groupId> |
| <artifactId>causeway-core</artifactId> |
| <version>3.0.0</version> |
| <scope>import</scope> |
| <type>pom</type> |
| </dependency> |
| </dependencies> |
| </dependencyManagement></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="dependency"><a class="anchor" href="#dependency"></a>Dependency</h3> |
| <div class="paragraph"> |
| <p>For every Maven module that includes JPA entities, add the following dependency:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="title">pom.xml</div> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><dependencies> |
| <dependency> |
| <groupId>org.apache.causeway.persistence</groupId> |
| <artifactId>causeway-persistence-jpa-eclipselink</artifactId> |
| <type>pom</type> |
| </dependency> |
| </dependencies></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="update-appmanifest"><a class="anchor" href="#update-appmanifest"></a>Update AppManifest</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>In your application’s <code>AppManifest</code> (top-level Spring <code>@Configuration</code> used to bootstrap the app), import the</p> |
| </div> |
| <div class="listingblock"> |
| <div class="title">AppManifest.java</div> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@Configuration |
| @Import({ |
| ... |
| CausewayModuleJpaEclipselink.class, |
| ... |
| }) |
| public class AppManifest { |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="datasource"><a class="anchor" href="#datasource"></a>DataSource</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The JPA object store uses Spring to provide a <code>javax.sql.DataSource</code>. |
| Normally this is done by setting the <code>spring.datasource</code> configuration properties, as described in the |
| <a href="https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-connect-to-production-database-configuration">Spring Boot</a> documentation.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example, the <a href="../../docs/latest/starters/simpleapp.html" class="xref page">SimpleApp</a> starter app defines these:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>for H2 (in-memory):</p> |
| <div class="listingblock"> |
| <div class="title">app.properties</div> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-properties hljs" data-lang="properties">spring.sql.init.platform=h2 |
| spring.datasource.url=jdbc:h2:mem:simple |
| spring.datasource.driver-class-name=org.h2.Driver</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>for SQL Server:</p> |
| <div class="listingblock"> |
| <div class="title">app.properties</div> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-properties hljs" data-lang="properties">spring.sql.init.platform=sqlserver |
| spring.datasource.url=jdbc:sqlserver://localhost;databaseName=simpleapp |
| spring.datasource.driver-class-name=com.microsoft.sqlserver.jdbc.SQLServerDriver |
| spring.datasource.username=simpleapp |
| spring.datasource.password=simpleapp</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>It is also possible to programmatically define a <code>DataSource</code>; see the <a href="https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-data-access">Spring docs</a> for details.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="eclipselink-configuration-properties"><a class="anchor" href="#eclipselink-configuration-properties"></a>EclipseLink Configuration Properties</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The following configuration properties are set by default:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="https://www.eclipse.org/eclipselink/documentation/2.7/jpa/extensions/persistenceproperties_ref.htm#weaving">eclipselink.weaving</a></p> |
| <div class="paragraph"> |
| <p>is set to <code>false</code></p> |
| </div> |
| </li> |
| <li> |
| <p><a href="https://www.eclipse.org/eclipselink/documentation/2.7/jpa/extensions/persistenceproperties_ref.htm#BABHEJJI">eclipselink.ddl-generation</a></p> |
| <div class="paragraph"> |
| <p>is set to <code>create-or-extend-tables</code></p> |
| </div> |
| </li> |
| <li> |
| <p><code>javax.persistence.bean.manager</code></p> |
| <div class="paragraph"> |
| <p>is set to an Apache Causeway implementation, to assist with dependency injection into entities.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Generally these should not be changed, though if there is a requirement, then provide a subclasse alternate implementation of <code>org.apache.causeway.persistence.jpa.eclipselink.config.ElSettings</code> with an earlier <code>@Priority</code> precedence.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To set other EclipseLink configuration properties, use a subclass of <a href="../../refguide/latest/persistence/index/jpa/eclipselink/CausewayModulePersistenceJpaEclipselink.html" class="xref page">CausewayModulePersistenceJpaEclipselink</a> and override <code>getVendorProperties()</code>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="other-configuration-properties"><a class="anchor" href="#other-configuration-properties"></a>Other Configuration Properties</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The JPA object store also supports the following configuration properties:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="../../refguide/latest/config/sections/causeway.persistence.schema.html#causeway.persistence.schema.additional-orm-files" class="xref page">causeway.persistence.schema.additional-orm-files</a></p> |
| <div class="paragraph"> |
| <p>Lookup additional "mapping-files" in <code>META-INF/orm-<em>name</em>.xml</code> (equivalent to "mapping-file" entries in <code>persistence.xml</code>) and adds these to those that are already configured the <em>Spring Data</em> way (if any).</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </article> |
| <aside class="article-aside toc hide-for-print" role="navigation"> |
| <p class="toc-title">On this page</p> |
| <div id="article-toc"></div> |
| </aside> |
| </main> |
| </div> |
| <footer class="footer"> |
| <div class="content"> |
| <div class="copyright"> |
| <p> |
| Copyright © 2010~2023 The Apache Software Foundation, licensed under the Apache License, v2.0. |
| <br/> |
| Apache, the Apache feather logo, Apache Causeway, and the Apache Causeway project logo are all trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| <div class="revision"> |
| <p>Revision: website.20240325-2342</p> |
| </div> |
| </div> |
| </footer> |
| <script src="../../_/js/site.js"></script> |
| <script async src="../../_/js/vendor/highlight.js"></script> |
| <script src="../../_/js/vendor/jquery-3.4.1.min.js"></script> |
| <script src="../../_/js/vendor/jquery-ui-1.12.1.custom.widget-only.min.js"></script> |
| <script src="../../_/js/vendor/jquery.tocify.min.js"></script> |
| |
| <script> |
| $(function() { |
| $("#article-toc").tocify( { |
| showEffect: "slideDown", |
| hashGenerator: "pretty", |
| hideEffect: "slideUp", |
| selectors: "h2, h3", |
| scrollTo: 120, |
| smoothScroll: true, |
| theme: "jqueryui", |
| highlightOnScroll: true |
| } ); |
| }); |
| </script> |
| |
| <script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> |
| <script> |
| function focusSearchInput () { document.querySelector('#algolia-search-input').focus() } |
| var search = docsearch({ |
| appId: '5ISP5TFAEN', |
| apiKey: '0fc51c28b4ad46e7318e96d4e97fab7c', |
| indexName: 'causeway-apache-org', |
| inputSelector: '#algolia-search-input', |
| autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] }, |
| debug: false, |
| }).autocomplete |
| search.on('autocomplete:closed', function () { search.autocomplete.setVal() }) |
| focusSearchInput() |
| window.addEventListener('load', focusSearchInput); |
| </script> |
| |
| <!-- |
| docsearch options: |
| https://docsearch.algolia.com/docs/behavior/ |
| --> |
| <!-- |
| https://www.algolia.com/doc/api-reference/api-parameters/ |
| algoliaOptions: { hitsPerPage: 6 }, |
| --> |
| </body> |
| </html> |