Skip to content
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.

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

Jakarta NoSQL 1.0 #793

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 11 additions & 11 deletions nosql/1.0/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Jakarta NoSQL 1.0 (under development)"
title: "Jakarta NoSQL 1.0"
date: 2023-05-30
summary: "Release supporting Jakarta EE 11"
---
Expand All @@ -9,12 +9,12 @@ Jakarta NoSQL is a Java framework that streamlines the integration of Java appli

## Goals

* Increase productivity performing common NoSQL operations
* Rich Object Mapping integrated
* Java-based Query and Fluent-API
* Template API to do NoSQL operations
* Template specializations by NoSQL types (Key-value, Column and Document)
* Annotation-oriented using JPA-like naming when it makes sense
* Increase productivity performing common NoSQL operations.
* Rich Object Mapping integrated.
* Java-based Query and Fluent-API.
* It is designed to work with various NoSQL databases and can quickly adapt to support new types and behaviors through extensions.
* Annotation-oriented using Jakarta Persistence-like naming when it makes sense.


```java
@Inject
Expand Down Expand Up @@ -46,12 +46,12 @@ template.delete(Car.class, 1L);


* [Jakarta NoSQL Release Plan](https://projects.eclipse.org/projects/ee4j.nosql/governance)
* [Jakarta NoSQL 1.0 Specification Document](./nosql-1.0.0-M1.pdf) (PDF)
* [Jakarta NoSQL 1.0 Specification Document](./nosql-1.0.0-M1.html) (HTML)
* [Jakarta NoSQL 1.0 Specification Document](./jakarta-nosql-1.0.0.pdf) (PDF)
* [Jakarta NoSQL 1.0 Specification Document](./jakarta-nosql-1.0.0.html) (HTML)
* [Jakarta NoSQL 1.0 Specification Javadoc](./apidocs)
* Maven coordinates
* [jakarta-nosql-api:jakarta.nosql:jar:1.0.0-M1](https://repo1.maven.org/maven2/jakarta/nosql/jakarta.nosql-api/1.0.0-M1/)

* [jakarta-nosql:jakarta.nosql-api:jar:1.0.0](https://repo1.maven.org/maven2/jakarta/nosql/jakarta.nosql-api/1.0.0)
* [Jakarta NoSQL 1.0 TCK](nosql-tck-1.0.0.zip), [sha](nosql-tck-1.0.0.zip.sha256)

# Compatible Implementations

Expand Down
15 changes: 8 additions & 7 deletions nosql/1.0/apidocs/allclasses-index.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!DOCTYPE HTML>
<html lang="en">
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>All Classes and Interfaces (Jakarta NoSQL API 1.0.0-M1 API)</title>
<title>All Classes and Interfaces (Jakarta NoSQL API documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-classes-index-page">
Expand All @@ -25,6 +25,7 @@
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><br>Jakarta NoSQL API v1.0</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
Expand Down Expand Up @@ -52,8 +53,8 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div id="all-classes-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exception Classes</button><button id="all-classes-table-tab6" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab6', 2)" class="table-tab">Annotation Interfaces</button></div>
<div id="all-classes-table.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0">
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="jakarta.nosql.core/jakarta/nosql/AttributeConverter.html" title="interface in jakarta.nosql">AttributeConverter&lt;X,<wbr>Y&gt;</a></div>
Expand Down Expand Up @@ -83,7 +84,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="jakarta.nosql.core/jakarta/nosql/Embeddable.EmbeddableType.html" title="enum class in jakarta.nosql">Embeddable.EmbeddableType</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Defines the strategy for how fields of the embeddable class are stored.</div>
<div class="block">Defines the strategies for how fields of an embeddable class are stored in the database.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab6"><a href="jakarta.nosql.core/jakarta/nosql/Entity.html" title="annotation interface in jakarta.nosql">Entity</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab6">
Expand Down Expand Up @@ -188,7 +189,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
<p class="legal-copy"><small>Comments to: <a href="mailto:nosql-dev@eclipse.org">[email protected]</a>.<br> Copyright &#169; 2025 Eclipse Foundation. All rights reserved.<br></small></p>
</footer>
</div>
</div>
Expand Down
9 changes: 5 additions & 4 deletions nosql/1.0/apidocs/allpackages-index.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!DOCTYPE HTML>
<html lang="en">
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>All Packages (Jakarta NoSQL API 1.0.0-M1 API)</title>
<title>All Packages (Jakarta NoSQL API documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-packages-index-page">
Expand All @@ -25,6 +25,7 @@
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><br>Jakarta NoSQL API v1.0</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
Expand Down Expand Up @@ -62,7 +63,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
<p class="legal-copy"><small>Comments to: <a href="mailto:nosql-dev@eclipse.org">[email protected]</a>.<br> Copyright &#169; 2025 Eclipse Foundation. All rights reserved.<br></small></p>
</footer>
</div>
</div>
Expand Down
9 changes: 5 additions & 4 deletions nosql/1.0/apidocs/constant-values.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!DOCTYPE HTML>
<html lang="en">
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>Constant Field Values (Jakarta NoSQL API 1.0.0-M1 API)</title>
<title>Constant Field Values (Jakarta NoSQL API documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="constants-summary-page">
Expand All @@ -25,6 +25,7 @@
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><br>Jakarta NoSQL API v1.0</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
Expand Down Expand Up @@ -75,7 +76,7 @@ <h2 title="jakarta.nosql.*">jakarta.nosql.*</h2>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
<p class="legal-copy"><small>Comments to: <a href="mailto:nosql-dev@eclipse.org">[email protected]</a>.<br> Copyright &#169; 2025 Eclipse Foundation. All rights reserved.<br></small></p>
</footer>
</div>
</div>
Expand Down
9 changes: 5 additions & 4 deletions nosql/1.0/apidocs/help-doc.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!DOCTYPE HTML>
<html lang="en">
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>API Help (Jakarta NoSQL API 1.0.0-M1 API)</title>
<title>API Help (Jakarta NoSQL API documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="help">
<meta name="generator" content="javadoc/HelpWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="help-page">
Expand All @@ -25,6 +25,7 @@
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><br>Jakarta NoSQL API v1.0</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
Expand Down Expand Up @@ -199,7 +200,7 @@ <h3>Index</h3>
<span class="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
<p class="legal-copy"><small>Comments to: <a href="mailto:nosql-dev@eclipse.org">[email protected]</a>.<br> Copyright &#169; 2025 Eclipse Foundation. All rights reserved.<br></small></p>
</footer>
</div>
</div>
Expand Down
16 changes: 8 additions & 8 deletions nosql/1.0/apidocs/index-all.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!DOCTYPE HTML>
<html lang="en">
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>Index (Jakarta NoSQL API 1.0.0-M1 API)</title>
<title>Index (Jakarta NoSQL API documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="index">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
Expand All @@ -25,6 +25,7 @@
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><br>Jakarta NoSQL API v1.0</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="jakarta.nosql.core/module-summary.html">Module</a></li>
<li><a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">Package</a></li>
Expand Down Expand Up @@ -136,7 +137,7 @@ <h2 class="title" id="I:E">E</h2>
</dd>
<dt><a href="jakarta.nosql.core/jakarta/nosql/Embeddable.EmbeddableType.html" class="type-name-link" title="enum class in jakarta.nosql">Embeddable.EmbeddableType</a> - Enum Class in <a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">jakarta.nosql</a></dt>
<dd>
<div class="block">Defines the strategy for how fields of the embeddable class are stored.</div>
<div class="block">Defines the strategies for how fields of an embeddable class are stored in the database.</div>
</dd>
<dt><a href="jakarta.nosql.core/jakarta/nosql/Entity.html" class="type-name-link" title="annotation interface in jakarta.nosql">Entity</a> - Annotation Interface in <a href="jakarta.nosql.core/jakarta/nosql/package-summary.html">jakarta.nosql</a></dt>
<dd>
Expand Down Expand Up @@ -232,7 +233,7 @@ <h2 class="title" id="I:J">J</h2>
</dd>
<dt><a href="jakarta.nosql.core/module-summary.html">jakarta.nosql.core</a> - module jakarta.nosql.core</dt>
<dd>
<div class="block">The Jakarta NoSQL Core module.</div>
<div class="block"><b>Jakarta NoSQL</b></div>
</dd>
</dl>
<h2 class="title" id="I:L">L</h2>
Expand Down Expand Up @@ -328,8 +329,7 @@ <h2 class="title" id="I:N">N</h2>
<dt><a href="jakarta.nosql.core/jakarta/nosql/NoSQLException.html#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">NoSQLException(Throwable)</a> - Constructor for exception class jakarta.nosql.<a href="jakarta.nosql.core/jakarta/nosql/NoSQLException.html" title="class in jakarta.nosql">NoSQLException</a></dt>
<dd>
<div class="block">Constructs a new runtime exception with the specified cause and a detail
message of (cause==null ? null : cause.toString()) (which typically contains
the class and detail message of cause).</div>
message of (cause==null ?</div>
</dd>
<dt><a href="jakarta.nosql.core/jakarta/nosql/QueryMapper.MapperDeleteNameCondition.html#not()" class="member-name-link">not()</a> - Method in interface jakarta.nosql.<a href="jakarta.nosql.core/jakarta/nosql/QueryMapper.MapperDeleteNameCondition.html" title="interface in jakarta.nosql">QueryMapper.MapperDeleteNameCondition</a></dt>
<dd>
Expand Down Expand Up @@ -549,7 +549,7 @@ <h2 class="title" id="I:W">W</h2>
<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:J">J</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:Q">Q</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a href="#I:W">W</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="constant-values.html">Constant&nbsp;Field&nbsp;Values</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized&nbsp;Form</a></main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
<p class="legal-copy"><small>Comments to: <a href="mailto:nosql-dev@eclipse.org">[email protected]</a>.<br> Copyright &#169; 2025 Eclipse Foundation. All rights reserved.<br></small></p>
</footer>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions nosql/1.0/apidocs/index.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!DOCTYPE HTML>
<html lang="en">
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>Jakarta NoSQL API 1.0.0-M1 API</title>
<title>Jakarta NoSQL API documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="index redirect">
Expand Down
Loading