-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathindex.html
More file actions
172 lines (161 loc) · 6.75 KB
/
index.html
File metadata and controls
172 lines (161 loc) · 6.75 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<!doctype html>
<html lang="en">
<head>
<title>Getting started | Ebean</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="shortcut icon" href="/images/favicon.ico">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto|Source+Sans+Pro|Ubuntu&display=swap">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
<link rel="stylesheet" href="/css/reset3.css">
<link rel="stylesheet" href="/css/site3.css">
<link rel="stylesheet" href="/css/pygments3.css">
</head>
<body>
<div id="main">
<div id="banner">
<header>
<nav id="top">
<h1 id="breadcrumb">
<a class="nav-logo" href="/"><img src="/images/logo-200.png" height="35"></a> <a href="/docs">Documentation</a><span class="sep"> / </span><span class="last">Getting started</span>
</h1>
<ul>
<li> <a href="https://github.com/ebean-orm/website-source/blob/master/docs/getting-started/index.html"><i class="fab fa-github"></i> edit page</a>
</li>
<li><a onclick="toggleTheme();" title="switch dark light theme"><i class="fas fa-adjust"></i></a></li>
</ul>
</nav>
</header>
</div>
<div class="grid grid-docs">
<aside>
<nav class="side">
<ul>
<li class="nav0 active">
<a class="active" href="/docs/getting-started">Getting started</a>
<ul>
<li class="nav1 ">
<a href="/docs/getting-started/intellij-idea">IntelliJ</a>
</li>
<li class="nav1 ">
<a href="/docs/getting-started/eclipse-ide">Eclipse</a>
</li>
<li class="nav1 ">
<a href="/docs/getting-started/maven">Maven</a>
</li>
<li class="nav1 ">
<a href="/docs/getting-started/gradle">Gradle</a>
</li>
<li class="nav1 ">
<a href="/docs/getting-started/ebean-test">Test setup</a>
</li>
</ul>
</li>
<li class="nav0 ">
<a href="/docs/intro">Introduction</a>
</li>
<li class="nav0 ">
<a href="/docs">Documentation</a>
</li>
<li class="nav0 ">
<a href="/support">Getting help</a>
</li>
<li class="nav0 ">
<a target="_blank" href="/apidoc/13">API Javadoc</a>
</li>
<li class="nav0 ">
<a href="/videos">Videos</a>
</li>
<li class="nav0 ">
<a href="/docs/upgrading">Upgrading</a>
</li>
<li class="nav0 ">
<a href="/docs/deprecated">Deprecated</a>
</li>
<li class="nav0 ">
<a href="/releases">Releases</a>
</li>
</ul>
</nav>
</aside>
<article>
<form action="https://www.google.com/search" method="get" class="inline-form">
<input type="hidden" name="as_sitesearch" value="ebean.io">
<div id="page-search">
<div class="input-group">
<input class="frm" name="q" id="searchinput" type="text" placeholder="Search... (press 's' to focus)" data-placeholder-focus="Search... (use '↑', '↓' and '⏎' to select results)" data-placeholder-blur="Search... (press 's' to focus)" autocomplete="off">
<div class="input-group-btn">
<button class="frm" type="submit"><i class="fas fa-search"></i></button>
</div>
</div>
<div id="page-search-results" style="display: none;">
<ul id="search-results-container" class="search-results"><li class=" active"><a href="/docs" title="Docs"><span style="color:#777;">Docs</span> Documentation </a></li><li class=""><small style="color:#999;">And 101 more...</small></li></ul>
</div>
</div>
</form>
<h2 id="prerequisites">Prerequisite - Java 11</h2>
<p>
Ebean 13+ requires Java 11. Please upgrade as soon as you can.
</p>
<h2 id="Jakarata">jakarta and javax persistence</h2>
<p>
Ebean 14.x/15.x use <code>jakarta.persistence</code>.
To use <code>javax.persistence</code> use Ebean version <b>14.x-javax</b>.
</p>
<p> </p>
<h3 id="examples">Example projects</h3>
<p>
You can explore example Java projects for
<a href="https://github.com/ebean-orm-examples/example-java8">Maven</a>,
<a href="https://github.com/ebean-orm-examples/example-gradle-java">Gradle</a>
or example Kotlin projects using
<a href="https://github.com/ebean-orm-examples/example-kotlin">Maven</a> or
<a href="https://github.com/ebean-orm-examples/example-gradle-kotlin">Gradle</a>.
</p>
<p>
For other example projects like PostGIS etc goto <a href="/docs/examples">/docs/examples</a>.
</p>
<p> </p>
<h2 id="ai-guides">Step-by-step guides (for AI agents and developers)</h2>
<p>
If you use a skill-aware coding tool, install the <code>ebean-orm</code> agent skill first.
See <a href="/docs/agents/skills">Agent Skills for Ebean Projects</a>.
</p>
<p>
Prescriptive step-by-step guides for adding Ebean to an existing project are available
in the Ebean GitHub repository. These guides are written to be followed by AI coding
agents (Copilot, Cursor, Claude Code, etc.) as well as human developers.
</p>
<ul>
<li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-postgres-maven-pom.md">Add Ebean + PostgreSQL — Maven POM setup</a></li>
<li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-postgres-database-config.md">Database configuration (DataSourceBuilder + DatabaseBuilder)</a></li>
<li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-postgres-test-container.md">Test container setup (PostgreSQL / PostGIS via Docker)</a></li>
<li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-db-migration-generation.md">Database migration generation</a></li>
<li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/lombok-with-ebean-entity-beans.md">Using Lombok with Ebean entity beans</a></li>
<li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/README.md">Full guide index</a></li>
</ul>
<p> </p>
<h2 id="ide">Install IDE Plugin</h2>
<p>
Ebean uses bytecode enhancement to provide <code>dirty checking</code> and <code>lazy loading</code>.
We using tooling via IDEA, Eclipse, Maven and Gradle plugins to perform this enhancement.
</p>
<p>
Install the Plugin for <a class="btn" href="/docs/getting-started/intellij-idea">IntelliJ IDEA</a> or
<a class="btn" href="/docs/getting-started/eclipse-ide">Eclipse IDE</a>.
</p>
</article>
</div>
</div>
<script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script>
<script src="/js/site3.js"></script>
<script src="/js/search3.js"></script>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-75181644-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-75181644-1');
</script>
</body>
</html>