Difference between revisions of "EclipseLink/DesignDocs/312146"

From Eclipsepedia

Jump to: navigation, search
(Project overview)
 
(14 intermediate revisions by one user not shown)
Line 16: Line 16:
 
| James
 
| James
 
| 0.1 Draft
 
| 0.1 Draft
 +
|-
 +
| 2012-02-07
 +
| James
 +
| 0.2 Updated
 +
|-
 +
| 2012-03-01
 +
| James
 +
| 0.3 Updated
 
|-  
 
|-  
 
|}
 
|}
Line 40: Line 48:
 
* (select fixed - Hermes) - BUG#350597 - [https://bugs.eclipse.org/bugs/show_bug.cgi?id=350597 JPA 2.1 sub select in functions, having, select, from]
 
* (select fixed - Hermes) - BUG#350597 - [https://bugs.eclipse.org/bugs/show_bug.cgi?id=350597 JPA 2.1 sub select in functions, having, select, from]
 
* support IN with nested arrays
 
* support IN with nested arrays
* support LITERAL key word
+
* support SQL key word
* support table and column references
+
* support PROPERTY key word
* support asOf
+
* support TABLE and COLUMN references
 +
* support ASOF
 
* support BATCH FETCH in JPQL
 
* support BATCH FETCH in JPQL
 
* BUG#246356 - [https://bugs.eclipse.org/bugs/show_bug.cgi?id=246356 support inner joins in from clause]
 
* BUG#246356 - [https://bugs.eclipse.org/bugs/show_bug.cgi?id=246356 support inner joins in from clause]
 +
* support 'from ...' without SELECT clause.
 +
* Expression support in Criteria API
 +
* support JPQL without select clause "from Employee e"
  
 
Other JPQL bugs:
 
Other JPQL bugs:
Line 70: Line 82:
 
* object parameters on left
 
* object parameters on left
 
* (fixed) - BUG#362063 - [https://bugs.eclipse.org/bugs/show_bug.cgi?id=362063 Nested subselects]
 
* (fixed) - BUG#362063 - [https://bugs.eclipse.org/bugs/show_bug.cgi?id=362063 Nested subselects]
 +
 +
JPA 2.1 also define several JPQL enhancements:
 +
* ON clause support
 +
* Support for usage of sub-SELECT in arithmetic and other functions, optionally in SELECT and other clauses.
 +
* FUNCTION support for generic database function usage.
 +
* Support TREAT in WHERE clause.
  
 
= Concepts =
 
= Concepts =
Line 101: Line 119:
 
* Added support to FunctionExpression and RelationExpression to support object comparisons with IN.  For composite ids as parameters arrayed INs are used, this requires database specific support.
 
* Added support to FunctionExpression and RelationExpression to support object comparisons with IN.  For composite ids as parameters arrayed INs are used, this requires database specific support.
 
* Added support for count distinct with composite ids for MySQL and supporting databases.
 
* Added support for count distinct with composite ids for MySQL and supporting databases.
 +
* Support cast() function.
  
 
JPQL
 
JPQL
Line 109: Line 128:
 
* Support = with aliases.
 
* Support = with aliases.
 
* Support alias on JOIN FETCH.
 
* Support alias on JOIN FETCH.
 +
* Support CAST, EXTRACT functions.
 +
* Support STDDEV, VAR functions.
 
* Support FUNCTION key word.
 
* Support FUNCTION key word.
 
* Support OPERATOR key word to allow usage of any ExpressionOperator.
 
* Support OPERATOR key word to allow usage of any ExpressionOperator.
 +
* Support SQL key word for SQL literals and custom SQL.
 +
* Support TABLE() in from clause for data level fragments and mixed queries.
 +
* Support COLUMN() key word for data level fragments and mixed queries.
 
* Support CONNECT BY PRIOR in  FROM clause.
 
* Support CONNECT BY PRIOR in  FROM clause.
 
* Support AS OF in FROM clause.
 
* Support AS OF in FROM clause.
 
* Support BATCH FETCH in FROM clause.
 
* Support BATCH FETCH in FROM clause.
 +
* Support arrays comparisons with IN.
 +
* Support FROM without SELECT clause
 +
* Support TREAT in WHERE clause
  
 
= Testing =
 
= Testing =
Line 145: Line 172:
 
** Select e.salary, (Select Max(e2.salary from Employee e2 where e2.address.city = e.address.city) from Employee e
 
** Select e.salary, (Select Max(e2.salary from Employee e2 where e2.address.city = e.address.city) from Employee e
 
** Select e.id, c.city from Employee e, (Select a.city from Address a) c
 
** Select e.id, c.city from Employee e, (Select a.city from Address a) c
 +
* =
 +
** Select e from Employee e, Employee e2 where e = e2 and e = e2.manager
 +
* CAST
 +
** Select e from Employee e where CAST(e.number AS NUMBER) > 100
 +
* FUNCTION
 +
** Select e from Employee e where FUNCTION('UPPER', e.lastName) = 'SMITH'
 +
* OPERATOR
 +
** Select e from Employee e where OPERATOR('NextDay', e.hireDate) = CURRENT DATE
 +
* SQL
 +
** Select e from Employee e where SQL('CAST(? AS NUMBER)', e.id) > 100
 +
* TABLE
 +
** Select s.NAME from TABLE('ALL_STATES') s where s.COUNTRY = 'Canada'
 +
** @AdditionalCriteria("this.tenant IN (Select a.TENANT from TABLE('TENANT') a where a.ACTIVE = true)")
 +
** @AdditionalCriteria("TABLE('PHONE').ACTIVE = true")
 +
* COLUMN
 +
** Select COLUMN('ADDRESS_ID', e) from Employee e
 +
** @AdditionalCriteria("COLUMN('IS_DELETED', e) = false")
 +
* arrays with IN
 +
** Select e from Employee e where (e.deptId, e.empId) IN ((1,5), (6, 8), (9, 2))
 +
* AS OF
 +
** Select e from Employee e AS OF :date where e.id = :id
 +
* CONNECT BY
 +
** Select e from Employee e CONNECT BY e.manager START WITH (e.job = 'President')
 +
* TREAT
 +
** Select p from Project p where Type(p) = SmallProject or Treat(p as LargeProject).budget < 1000
 +
* FROM
 +
** FROM Employee e
 +
 +
Criteria
 +
* query.where(cb.fromExpression(cb.toExpression(root).getField('ROWID').equal(rowid))
  
 
= Native API =
 
= Native API =
Line 151: Line 208:
 
** leftJoin(Expression target, Expression onClause)
 
** leftJoin(Expression target, Expression onClause)
 
** getAlias(Expression subSelect)
 
** getAlias(Expression subSelect)
 +
** operator(String name, List arguments)
 +
** sql(String sql, List arguments)
 +
** cast(Expression, String type)
 
* ObjectLevelReadQuery
 
* ObjectLevelReadQuery
 
** addNonFetchJoin(Expression)
 
** addNonFetchJoin(Expression)
Line 225: Line 285:
 
= Future Considerations =
 
= Future Considerations =
 
* Other JPQL enhancements.
 
* Other JPQL enhancements.
 +
** WITH recursive queries
 +
** WINDOW functions
 +
** SIMILAR, REGEX
 +
** intervals
 +
** sampling
 +
** NULLS FIRST/LAST ordering
 +
** UNIQUE/ALL group by
 +
** grouping sets
 +
** MATCH functions
 +
** statistical functions
 +
** join functions (CROSS, UNION, ...)
 
* Criteria support.
 
* Criteria support.

Latest revision as of 16:37, 1 March 2012

[edit] Design Specification: Enhanced JPQL

ER 312146

Feedback

[edit] Document History

Date Author Version Description & Notes
2011-10-04 James 0.1 Draft
2012-02-07 James 0.2 Updated
2012-03-01 James 0.3 Updated

[edit] Project overview

JPQL currently offers a sub-set of SQL functionality. Some queries that are possible using SQL cannot be defined using JPQL.

It is desired to make EclipseLink's JPQL support be more complete of what is possible in SQL.

A key requirement from users (#1 voted enhancement) is to have ON clause support in JPQL.

Other missing features of SQL could also be added to JPQL, such as sub selects in the SELECT from FROM clauses, and enhanced function support.

Other JPQL enhancements:

Other JPQL bugs:

JPA 2.1 also define several JPQL enhancements:

  • ON clause support
  • Support for usage of sub-SELECT in arithmetic and other functions, optionally in SELECT and other clauses.
  • FUNCTION support for generic database function usage.
  • Support TREAT in WHERE clause.

[edit] Concepts

ON clause : the SQL clause part of the FROM clause that defines how to tables are joined, this can be used for both joins and outer joins, but is required for outer joins.

outer join : A join where if a row in the source table has no joined rows in the target table it is still included in the join result with a null row for the target table.

ANTRL : Third party library currently used in EclipseLink for parsing JPQL.

SQL : SQL 2003 BNF

Hermes : New JPQL parser developed by Dali project for parsing JPQL at design time. Currently included in EclipseLink SVN, but not currently used.

[edit] Requirements

  • Support additional ON clause for a relationship join.
  • Support an ON clause on the join for two independent objects.
  • Support JPA 2.1 ON clause
  • Support JPA 2.1 function key word
  • Allow sub-selects in the select clause, having clause, and from clause. ("optionalish" in JPA 2.1)

[edit] Design Constraints

  • Outer join capabilities differ in different databases.
  • SQL capabilities differ in different databases.

[edit] Functionality

  • Extend ObjectExpression to support an onClause, must normalize and copy expression accordingly.
  • Allow ExpressionBuilders and other Expressions to be added to nonFetchJoinExpressions in ObjectLevelReadQuery.
  • Add support for having SubSelectExpressions in SQLSelectStatement's fields and print/normalize accordingly.
  • Added new FromSubSelectExpression to allow SubSelectExpressions to be contained an aliased in a SQLSelectStatement's from clause.
  • Added new FromAliasExpression to allow get() to be used from a FromSubSelectExpression and treated as a QueryKeyExpression aliasing one of the items in the sub-select.
  • Added support to FunctionExpression and RelationExpression to support object comparisons with IN. For composite ids as parameters arrayed INs are used, this requires database specific support.
  • Added support for count distinct with composite ids for MySQL and supporting databases.
  • Support cast() function.

JPQL

  • Support ON clause for join and allow joins of non related entities.
  • Support sub-selects in the SELECT, HAVING, and FROM clause.
  • Support IN with object expressions.
  • Support ORDER BY with object expressions.
  • Support = with aliases.
  • Support alias on JOIN FETCH.
  • Support CAST, EXTRACT functions.
  • Support STDDEV, VAR functions.
  • Support FUNCTION key word.
  • Support OPERATOR key word to allow usage of any ExpressionOperator.
  • Support SQL key word for SQL literals and custom SQL.
  • Support TABLE() in from clause for data level fragments and mixed queries.
  • Support COLUMN() key word for data level fragments and mixed queries.
  • Support CONNECT BY PRIOR in FROM clause.
  • Support AS OF in FROM clause.
  • Support BATCH FETCH in FROM clause.
  • Support arrays comparisons with IN.
  • Support FROM without SELECT clause
  • Support TREAT in WHERE clause

[edit] Testing

ON clause needs Expression tests in core testing and JPQL tests in JPA testing. Testing both 1-1, 1-m, relationship and parallel.

  • Added ON clause tests to Expression outerJoin core tests (both inner and outer joins tested).
  • Added FROM and SELECT sub-select tests to Expression subSelects core tests.

[edit] API

JPQL

  • ON
    • Select e from Employee e left join e.address a on (a.city = 'Ottawa')
    • Select e from Employee e left join Project p on (p.teamLeader = e)
  • Sub-select
    • Select e.id, (Select a.city from Address a where e.address = a) from Employee e
    • Select e.id, a2.city from Employee e, (Select a.city from Address a) a2
  • IN / NOT IN
    • Select e from Employee e where e.address in (Select a from Address a where city = 'Ottawa')
    • Select e from Employee e join e.phones p where p in :phones
    • Select e from Employee e join e.phones p where p in (:phone1, :phone2)
    • Select e from Employee e where e.address = (Select a from Address a where street = '27 Hastings')
  • ORDER BY (order by objects, Id or all fields for embeddables)
    • Select e from Employee e order by e.address
    • Select e from Employee e order by e.period
  • JOIN FETCH alias
    • Select e from Employee e join fetch e.address a where a.city = :city order by a.street
    • Select e from Employee e join fetch e.phones p order by p.areaCode
    • Select e from Employee e join fetch e.manager m join fetch m.address
  • sub-SELECTs
    • Select e.salary, (Select Max(e2.salary from Employee e2 where e2.address.city = e.address.city) from Employee e
    • Select e.id, c.city from Employee e, (Select a.city from Address a) c
  • =
    • Select e from Employee e, Employee e2 where e = e2 and e = e2.manager
  • CAST
    • Select e from Employee e where CAST(e.number AS NUMBER) > 100
  • FUNCTION
    • Select e from Employee e where FUNCTION('UPPER', e.lastName) = 'SMITH'
  • OPERATOR
    • Select e from Employee e where OPERATOR('NextDay', e.hireDate) = CURRENT DATE
  • SQL
    • Select e from Employee e where SQL('CAST(? AS NUMBER)', e.id) > 100
  • TABLE
    • Select s.NAME from TABLE('ALL_STATES') s where s.COUNTRY = 'Canada'
    • @AdditionalCriteria("this.tenant IN (Select a.TENANT from TABLE('TENANT') a where a.ACTIVE = true)")
    • @AdditionalCriteria("TABLE('PHONE').ACTIVE = true")
  • COLUMN
    • Select COLUMN('ADDRESS_ID', e) from Employee e
    • @AdditionalCriteria("COLUMN('IS_DELETED', e) = false")
  • arrays with IN
    • Select e from Employee e where (e.deptId, e.empId) IN ((1,5), (6, 8), (9, 2))
  • AS OF
    • Select e from Employee e AS OF :date where e.id = :id
  • CONNECT BY
    • Select e from Employee e CONNECT BY e.manager START WITH (e.job = 'President')
  • TREAT
    • Select p from Project p where Type(p) = SmallProject or Treat(p as LargeProject).budget < 1000
  • FROM
    • FROM Employee e

Criteria

  • query.where(cb.fromExpression(cb.toExpression(root).getField('ROWID').equal(rowid))

[edit] Native API

  • Expression
    • join(Expression target, Expression onClause)
    • leftJoin(Expression target, Expression onClause)
    • getAlias(Expression subSelect)
    • operator(String name, List arguments)
    • sql(String sql, List arguments)
    • cast(Expression, String type)
  • ObjectLevelReadQuery
    • addNonFetchJoin(Expression)

Examples:

// ON
ExpressionBuilder employee = new ExpressionBuilder();
Expression address = employee.getAllowingNull("address");
employee.leftJoin(address, address.get("city").equal("Ottawa"));
ReadAllQuery query = new ReadAllQuery(Employee.class, employee);
query.addNonFetchJoin(address);
 
// ON
ExpressionBuilder employee = new ExpressionBuilder(Employee.class);
ExpressionBuilder project = new ExpressionBuilder(Project.class);
employee.join(project, project.get("teamLeader").equal(employee));
ReadAllQuery query = new ReadAllQuery(Employee.class, employee);
query.addNonFetchJoin(project);
 
// SELECT SUB-SELECT
ExpressionBuilder employee = new ExpressionBuilder(Employee.class);
ExpressionBuilder address = new ExpressionBuilder(Address.class);
ReportQuery subQuery = new ReportQuery(Address.class, address);
subQuery.addAttribute("city");
subQuery.setSelectionCriteria(employee.get("address").equal(a));
ReportQuery query = new ReportQuery(Employee.class, employee);
query.addAttribute("id");
query.addItem("city", employee.subQuery(subQuery));
 
// FROM SUB-SELECT
ExpressionBuilder employee = new ExpressionBuilder(Employee.class);
ExpressionBuilder address = new ExpressionBuilder(Address.class);
ReportQuery subQuery = new ReportQuery(Address.class, address);
subQuery.addAttribute("city");
subQuery.setSelectionCriteria(employee.get("address").equal(a));
Expression a2 = employee.getAlias(employee.subQuery(subQuery));
ReportQuery query = new ReportQuery(Employee.class, employee);
query.addNonFetchJoin(a2);
query.addAttribute("id");
query.addItem("city", a2.get("city"));

[edit] Config files

[edit] Documentation

Need to document our BNF, example queries and support beyond JPA 2.0/2.1 in query section.

[edit] Open Issues

Issue # Owner Description / Notes
1 Which JPQL parser should be used ANTLR or Hermes?

[edit] Decisions

Issue Description / Notes Decision

[edit] Future Considerations

  • Other JPQL enhancements.
    • WITH recursive queries
    • WINDOW functions
    • SIMILAR, REGEX
    • intervals
    • sampling
    • NULLS FIRST/LAST ordering
    • UNIQUE/ALL group by
    • grouping sets
    • MATCH functions
    • statistical functions
    • join functions (CROSS, UNION, ...)
  • Criteria support.