343 lines
12 KiB
XML
343 lines
12 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
Copyright (c) 2008, 2020 Oracle and/or its affiliates. All rights reserved.
|
|
|
|
This program and the accompanying materials are made available under the
|
|
terms of the Eclipse Public License v. 2.0 which is available at
|
|
http://www.eclipse.org/legal/epl-2.0,
|
|
or the Eclipse Distribution License v. 1.0 which is available at
|
|
http://www.eclipse.org/org/documents/edl-v10.php.
|
|
|
|
SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
|
|
|
|
-->
|
|
|
|
<!-- persistence.xml schema -->
|
|
<xsd:schema targetNamespace="https://jakarta.ee/xml/ns/persistence"
|
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
xmlns:persistence="https://jakarta.ee/xml/ns/persistence"
|
|
elementFormDefault="qualified"
|
|
attributeFormDefault="unqualified"
|
|
version="3.0">
|
|
|
|
<xsd:annotation>
|
|
<xsd:documentation><![CDATA[
|
|
|
|
This is the XML Schema for the persistence configuration file.
|
|
The file must be named "META-INF/persistence.xml" in the
|
|
persistence archive.
|
|
|
|
Persistence configuration files must indicate
|
|
the persistence schema by using the persistence namespace:
|
|
|
|
https://jakarta.ee/xml/ns/persistence
|
|
|
|
and indicate the version of the schema by
|
|
using the version element as shown below:
|
|
|
|
<persistence xmlns="https://jakarta.ee/xml/ns/persistence"
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="https://jakarta.ee/xml/ns/persistence
|
|
https://jakarta.ee/xml/ns/persistence/persistence_3_0.xsd"
|
|
version="3.0">
|
|
...
|
|
</persistence>
|
|
|
|
]]></xsd:documentation>
|
|
</xsd:annotation>
|
|
|
|
<xsd:simpleType name="versionType">
|
|
<xsd:restriction base="xsd:token">
|
|
<xsd:pattern value="[0-9]+(\.[0-9]+)*"/>
|
|
</xsd:restriction>
|
|
</xsd:simpleType>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="persistence">
|
|
<xsd:complexType>
|
|
<xsd:sequence>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="persistence-unit"
|
|
minOccurs="1" maxOccurs="unbounded">
|
|
<xsd:complexType>
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Configuration of a persistence unit.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
<xsd:sequence>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="description" type="xsd:string"
|
|
minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Description of this persistence unit.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="provider" type="xsd:string"
|
|
minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Provider class that supplies EntityManagers for this
|
|
persistence unit.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="jta-data-source" type="xsd:string"
|
|
minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
The container-specific name of the JTA datasource to use.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="non-jta-data-source" type="xsd:string"
|
|
minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
The container-specific name of a non-JTA datasource to use.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="mapping-file" type="xsd:string"
|
|
minOccurs="0" maxOccurs="unbounded">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
File containing mapping information. Loaded as a resource
|
|
by the persistence provider.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="jar-file" type="xsd:string"
|
|
minOccurs="0" maxOccurs="unbounded">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Jar file that is to be scanned for managed classes.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="class" type="xsd:string"
|
|
minOccurs="0" maxOccurs="unbounded">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Managed class to be included in the persistence unit and
|
|
to scan for annotations. It should be annotated
|
|
with either @Entity, @Embeddable or @MappedSuperclass.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="exclude-unlisted-classes" type="xsd:boolean"
|
|
default="true" minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
When set to true then only listed classes and jars will
|
|
be scanned for persistent classes, otherwise the
|
|
enclosing jar or directory will also be scanned.
|
|
Not applicable to Java SE persistence units.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="shared-cache-mode"
|
|
type="persistence:persistence-unit-caching-type"
|
|
minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Defines whether caching is enabled for the
|
|
persistence unit if caching is supported by the
|
|
persistence provider. When set to ALL, all entities
|
|
will be cached. When set to NONE, no entities will
|
|
be cached. When set to ENABLE_SELECTIVE, only entities
|
|
specified as cacheable will be cached. When set to
|
|
DISABLE_SELECTIVE, entities specified as not cacheable
|
|
will not be cached. When not specified or when set to
|
|
UNSPECIFIED, provider defaults may apply.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="validation-mode"
|
|
type="persistence:persistence-unit-validation-mode-type"
|
|
minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
The validation mode to be used for the persistence unit.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:element>
|
|
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:element name="properties" minOccurs="0">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
A list of standard and vendor-specific properties
|
|
and hints.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
<xsd:complexType>
|
|
<xsd:sequence>
|
|
<xsd:element name="property"
|
|
minOccurs="0" maxOccurs="unbounded">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
A name-value pair.
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
<xsd:complexType>
|
|
<xsd:attribute name="name" type="xsd:string"
|
|
use="required"/>
|
|
<xsd:attribute name="value" type="xsd:string"
|
|
use="required"/>
|
|
</xsd:complexType>
|
|
</xsd:element>
|
|
</xsd:sequence>
|
|
</xsd:complexType>
|
|
</xsd:element>
|
|
|
|
</xsd:sequence>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:attribute name="name" type="xsd:string" use="required">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Name used in code to reference this persistence unit.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:attribute>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:attribute name="transaction-type"
|
|
type="persistence:persistence-unit-transaction-type">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
Type of transactions used by EntityManagers from this
|
|
persistence unit.
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
</xsd:attribute>
|
|
|
|
</xsd:complexType>
|
|
</xsd:element>
|
|
</xsd:sequence>
|
|
<xsd:attribute name="version" type="persistence:versionType"
|
|
fixed="3.0" use="required"/>
|
|
</xsd:complexType>
|
|
</xsd:element>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:simpleType name="persistence-unit-transaction-type">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
public enum PersistenceUnitTransactionType {JTA, RESOURCE_LOCAL};
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
<xsd:restriction base="xsd:token">
|
|
<xsd:enumeration value="JTA"/>
|
|
<xsd:enumeration value="RESOURCE_LOCAL"/>
|
|
</xsd:restriction>
|
|
</xsd:simpleType>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:simpleType name="persistence-unit-caching-type">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
public enum SharedCacheMode { ALL, NONE, ENABLE_SELECTIVE, DISABLE_SELECTIVE, UNSPECIFIED};
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
<xsd:restriction base="xsd:token">
|
|
<xsd:enumeration value="ALL"/>
|
|
<xsd:enumeration value="NONE"/>
|
|
<xsd:enumeration value="ENABLE_SELECTIVE"/>
|
|
<xsd:enumeration value="DISABLE_SELECTIVE"/>
|
|
<xsd:enumeration value="UNSPECIFIED"/>
|
|
</xsd:restriction>
|
|
</xsd:simpleType>
|
|
|
|
<!-- **************************************************** -->
|
|
|
|
<xsd:simpleType name="persistence-unit-validation-mode-type">
|
|
<xsd:annotation>
|
|
<xsd:documentation>
|
|
|
|
public enum ValidationMode { AUTO, CALLBACK, NONE};
|
|
|
|
</xsd:documentation>
|
|
</xsd:annotation>
|
|
<xsd:restriction base="xsd:token">
|
|
<xsd:enumeration value="AUTO"/>
|
|
<xsd:enumeration value="CALLBACK"/>
|
|
<xsd:enumeration value="NONE"/>
|
|
</xsd:restriction>
|
|
</xsd:simpleType>
|
|
|
|
</xsd:schema>
|