Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Select into returns a different class and not a different object

RapidClipse bietet mit dem JPA-SQL Editor ein mächtiges Tool für die Erstellung von benutzerdefinierten Abfragen auf Basis von JPA. Die Syntax von JPA-SQL lehnt sich an SQL an und ist somit leicht erlernbarFormulierung Ihrer Datenbankabfragen. JPA-SQL ist eine domänenspezifische, datenbankunabhängige Sprache (DSL). Die Syntax wurde gezielt an SQL angelehnt, sodass JPA-SQL leicht erlernbar ist. JPA-SQL ist eine reine Metasprache. D.h., die in JPA-SQL formulierten Abfragen werden nicht direkt nicht zu verwechseln mit nativem SQL. In JPA-SQL formulierte Abfragen werden niemals an eine Datenbank versendet, sondern in Javacode auf Basis umgewandelt, der auf der JPA Criteria API basiert. Damit erhalten Sie sämtliche Vorteile der JPA Criteria API umgewandelt. , ohne jedoch JPA Criteria Code schreiben zu müssen.

Erst zur Laufzeit werden die nativen aus dem generierten JPA Criteria Code von Hibernate native SQL-Statements passend für die entsprechend angebundene Datenbank erzeugt und abgesetztan die Datenbank versendet. JPA-SQL kombiniert somit die Einfachheit von SQL mit den zahlreichen Vorteilen der JPA Criteria API

Vorteile von JPA-SQL im Vergleich zur Verwendung von plain SQL-Strings:

  • SQL-ähnliche Syntax und Codestruktur
  • ÜbersichtlicherÜbersichtlichere Codestruktur
  • Typsicher
  • Beliebige Reihenfolge der Statements
  • IDE-Unterstützung
    • Autovervollständigung Code Completion - Erkennung von Schlüsselwörter, Operatoren und Entities 
    • Syntax-Highlighting
    • Code-Folding
    • Formatter

    • Inline Refactoring and Refactoring Participants for JDT Member Renames and Moves

    • Hovers

    • Linking (Ctrl+Click)

    • Outline View

    • Error/Warning-Markers with Quick Fixes

    • Code Templates

    • Integration in Eclipse build process

    • debuggbar (generierter JPA Criteria Code)
  • Query-Methode im DAO wird automatisch generiert
  • Datenbankunabhängig

Vorteile von JPA-SQL im Vergleich zur direkten Verwendung der JPA Criteria API:

  • SQL-ähnliche Syntax und CodestrukturÜbersichtlicher
  • Deutlich geringere Komplexität
  • Übersichtlicherer Code
  • Leicht erlernbar


  1. Klicken Sie im Project Management > Data Access das DAO an, über das Sie eine Datenbankabfrage durchführen möchten, z.B. CustomerDAO.java.
  2. Drücken Sie Strg + Shift und Space und wählen Sie in der folgenden Autovervollständigung query - create new query aus.
  3. Geben Sie bei der generierten Methode einen geeigneten Methodennamen an, z.B. findAllCustomer.

    Code Block
    languagesql
    themeConfluence
    findAllCustomer()
    {
    	select * from 
    }


  4. Geben Sie nach dem Schlüsselwort from > C ein, drücken Sie Strg + Space und wählen Sie Customer aus.
    Image Added
  5. Klicken Sie auf Speichern.


Ergebnis:
  • Queries - JPA-SQL Code.

    Code Block
    languagesql
    themeConfluence
    import com.company.test.entities.Customer
    
    findAllCustomer()
    {
    	select * from Customer
    }


  • Java - Generierte Java Code auf Basis der JPA Criteria API. Zu der Query-Methode werden auch die notwendigen Imports generiert. 

    Code Block
    languagejava
    themeConfluence
    /**
     * @queryMethod Do not edit, method is generated by editor!
     */
    public List<Customer> findAllCustomer() {
    	EntityManager entityManager = em();
    
    	CriteriaBuilder criteriaBuilder = entityManager.getCriteriaBuilder();
    
    	CriteriaQuery<Customer> criteriaQuery = criteriaBuilder.createQuery(Customer.class);
    
    	Root<Customer> root = criteriaQuery.from(Customer.class);
    
    	TypedQuery<Customer> query = entityManager.createQuery(criteriaQuery);
    	return query.getResultList();
    }


Examples:
  • Find all 

    Code Block
    languagesql
    themeConfluence
    findAllCustomer()
    {
    	select * from Customer
    }

...

  • 
    

    Alternativ erlaubte Schreibweise:

    Code Block
    languagesql
    themeConfluence
    findAllCustomer()
    {
    	from Customer
    }


  • Where Condition

    Code Block
    languagesql
    themeConfluence
    findAllCustomerWhere()
    {
    	select * from Customer where city = "London"
    }


  • Where Condition mit Parameter

    Code Block
    languagesql
    themeConfluence
    findAllCustomerWhere(String city)
    {
    	select * from Customer where city = :city
    }

    Als Parameter können auch Objekte übergeben werden:

    Code Block
    languagesql
    themeConfluence
    findAllCustomerWhere(Customer customer)
    {
    	select * from Customer where customer = :customer
    }


  • Like Operator

    Code Block
    languagesql
    themeConfluence
    findAllCustomerLike()
    {
    	select * from Customer where city like "%L"
    }


  • Concat Funktion

    Code Block
    languagesql
    themeConfluence
    findAllCustomerLike(String city)
    {
    	select * from Customer where city like concat("%", :city)
    }


  • Rückgabe bestimmter Spalten

    Code Block
    languagesql
    themeConfluence
    findAllCustomerColumn()
    {
    	select customerid, city, address from Customer
    }


  • Speichert das Abfrageergebnis in eine andere Klasse

    Code Block
    languagesql
    themeConfluence
    findAllCustomer()
    {
    	select customerid, city, address from Customer
        into FlatCustomer
    }


  • Alias

    Code Block
    languagesql
    themeConfluence
    findAllCustomerAs()
    {
    	select * from Customer as c
        where c.city = "London"
    }


  • Logisch AND

    Code Block
    languagesql
    themeConfluence
    findAllCustomerAnd()
    {
    	select * from Customer where city = "London" and country = "UK"
    }


  • Logisch OR

    Code Block
    languagesql
    themeConfluence
    findAllCustomerOr()
    {
    	select * from Customer where city = "London" or city = "Berlin"
    }


  • MAX Funktion - Gibt den höchsten Unitprice zurück

    Code Block
    languagesql
    themeConfluence
    getOrderDetailMaxPrice()
    {
    	select max(unitprice) from Orderdetail result single
    }
    
    


  • MIN Funktion - Gibt den niedrigsten Unitprice zurück

    Code Block
    languagesql
    themeConfluence
    getOrderDetailMinPrice()
    {
    	select min(unitprice) from Orderdetail result single
    }


  • AVG Funktion - Gruppiert nach dem Produktnamen und berechnet den durchschnittlichen Bestellwert der Orderdetails

    Code Block
    languagesql
    themeConfluence
    getOrderDetailAvgPrice()
    {
    	select avg(unitprice) from Orderdetail
    	group by product.productname
    }


    Code Block
    languagesql
    themeConfluence
    getOrderDetailAvgPrice()
    {
    	select avg(unitprice) as price, product.productname from Orderdetail
    	group by product.productname
    }


  • ORDER BY Funktion 

    • Absteigende Sortierung

      Code Block
      languagesql
      themeConfluence
      getAllCustomerWithOrderByDesc()
      {
      	select * from Customer order by city desc
      }


    • Aufsteigende Sortierung

      Code Block
      languagesql
      themeConfluence
      getAllCustomerWithOrderByAsc()
      {
      	select * from Customer order by city asc
      }


  • Count Funktion

    Code Block
    languagesql
    themeConfluence
    getCountFromCustomerByCountry()
    {
    	select count(customerid) from Customer group by country
    }


  • Subselects

    Code Block
    languagesql
    themeConfluence
    getOrderDetailsFromLondon()
    {
    	select * from Orderdetail as detail
    	where detail.`order`.orderid in (select orderid from Order where customer.city = "London")
    }

    Alternative zu Subselects:

    Code Block
    languagesql
    themeConfluence
    getOrderDetailsFromLondon()
    {
    	select * from Orderdetail
    	where `order`.customer.city = "London"
    }


  • Komplexe Queries
    • Gibt alle Bestellungen aus London zurück und Gruppiert diese um die Summe aller Bestellungen aus London

      Code Block
      languagesql
      themeConfluence
      getOrderDetailsSumFromLondon()
      {
      	select sum(detail.unitprice) from Orderdetail as detail
      	where detail.`order`.orderid in (select orderid from Order where customer.city = "London")
      	group by detail.`order`.customer.city
      	result single
      }


    • Mögliche Kurzform

      Code Block
      languagesql
      themeConfluence
      getOrderDetailsSumFromLondon()
      {
      	select sum(unitprice) from Orderdetail
      	where `order`.customer.city = "London"
      	group by `order`.customer.city
      	result single
      }


Hinweis:
  • JPA-SQL Funktionsumfang - JPA-SQL wurde entwickelt, um den Einsatz der JPA Criteria API zu vereinfachen. Der Funktionsumfang von JPA-SQL ist dadurch auf den Funktionsumfang der JPA Criteria API begrenzt.
  • Generierten Code editieren - Die Generierung des Java JPA Criteria Codes erfolgt unidirektional. D.h., Änderungen dürfen nur im JPA-SQL Code vorgenommen werden. Der generierte Java JPA Criteria Code darf nicht editiert werden.
  • Mehrere Query-Methoden - In einer DAO Klasse können sich beliebig viele Query-Methoden befinden.

    Code Block
    languagesql
    themeConfluence
    import com.company.test.entities.Customer
    findAllCustomer()
    {
    	select * from Customer 
    }
    
    
    findCustomerByID()
    {
    	select * from Customer where customerid = "BOLID"
    }


JPA-SQL Sprach-Spezifikation