Skip to content

Readme updates from feedback #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mswatosh merged 1 commit into from
Oct 24, 2025
Merged

Readme updates from feedback #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,23 @@ ID Length Width Height Destination
You can then try some of the queries which use input to see how it changes which packages are returned.


//TODO add an example with input here

[role='command']
include::{common-includes}/twyb-end.adoc[]

== Creating an Entity and Repository

Navigate to the `start` directory to begin.
ifdef::cloud-hosted[]
```bash
cd /home/project/guide-jakarta-data/start
```
endif::[]

[role='command']
include::{common-includes}/devmode-lmp33-start.adoc[]

In Jakarta Data an entity defines the structure for persisting a piece of data. This structure is represented by a Java object and its associated fields. Start by creating a simple record class.

[role="code_command hotspot file=0", subs="quotes"]
Expand Down Expand Up @@ -202,6 +217,8 @@ Sort sort = Sort.desc("height");
Jakarta Data queries can restrict the number of entities returned at runtime by providing a `Limit` object to the query:

```java
@Find
@OrderBy("length")
List<Package> longestWithLimit(Limit limit);
```

Expand Down Expand Up @@ -273,5 +290,9 @@ See the https://jakarta.ee/specifications/data/1.0/jakarta-data-1.0#_jakarta_dat
== Where to next?
Experiment by creating your own queries. Use the existing ones in the `Packages` class as a starting point and then test them out in the sample application.


//TODO add ideas for queries here


//Eventually link to an Advanced Guide as well.
//Include Static Metamodel