2015-09-20

Aliasy databázových tabulek v Ujorm

Jak se používají aliasy databázových tabulek v ORM frameworku Ujorm? Rád bych vyjasnil nejdříve některé základní pojmy (nejen) z frameworku Ujorm a jejich vzájemný vztah:
  • atribut / property - je vlastnost objektu, výklad můžeme demonstrovat na objektech typu POJO
  • vazba / relationship - speciální "atribut" objektu na jinou třídu typu POJO
  • propertyDescriptor - třída popisující vlastnosti "atributu" POJO (meta-model)
  • relationshipDescriptor - je propertyDescriptor, který popisuje "vazbu" mezi dvéma POJO (meta-model)
  • Key (dříve UjoProperty) - je propertyDescriptor frameworku Ujorm (immutable object)
  • Key<?,RelatedUjo> - je relationshipDescriptor frameworku Ujorm. Pokud je RelatedUjo perzistentní objekt ORM, tak instance Key popisuje vazbu na databázovou tabulku.

Při použití ORM se při startu aplikace sestavuje meta-model, kde každá databázová tabulka dostane pevně přiřazený svůj alias, to je vlastnost frameworku. Takový přístup sice vyhovuje mnoha databázovým dotazům, ale najdeme jistě případy, kdy se statickými aliasy nevystačíme, jsou to:
  1. rekurzivní dotazy (typicky filtrování zaměstnanců podle atributů nadřízeného)
  2. dvě relace na stejnou DB tabulky (například pro filtrování tabulky měnových kurzů, kde pro filtrování potřebujeme jeden alias na tabulky prodejní měny a jiný alias na tabulku nákupní měny). Tento případ zobrazuje následující class-model:
Pro popis odlišných aliasů se ve frameworku Ujorm využívá metoda Key.alias(String) pro Klíče typu relationshipDescriptor. Protože Klíče jsou vždy neměnné instance, tak metoda alias(String) vytváří ve skutečnosti nový kompozitní klíč, který obsahuje ten původní klíč společně a požadovaným alias jménem. Na příkladu měnových kurzů by pak mohla podmínka pro filtrování kurzu EUR/CZK vypadat takto:

import static Currency.CODE;

final Criterion<ExchangeRate> crn1, crn2, crn3;
crn1 = ExchangeRate.BUY.alias(
"aliasBuy").add(CODE).whereEq("EUR");
crn2 = ExchangeRate.SELL.alias(
"aliasSell").add(CODE).whereEq("CZK");
crn3 = crn1.and(crn2);


kde výrazy BUY a SELL jsou vazby (relationshipDescriptor) na číselník kurzových měn Currency. V servisních metodách však není dobré uvádět názvy alias explicitně a proto si připravíme nový kompozitní klíč ve třídě ExchangeRate:

public static final Key<ExchangeRate,Currency> SELL = ExchangeRate.$_DIRECT_SELL.alias(
"aliasSell");

kde výraz $_DIRECT_SELL představuje původní přímý klíč na tabulku prodejní měny. Vazba BUY si ponechá svůj původní alias, vazba SELL použije vždy explicitně zadaný alias. Java kód dotazu se pak zjednoduší na:

final Criterion<ExchangeRate> crn1, crn2, crn3;
crn1 = ExchangeRate.BUY.add(CODE).whereEq("EUR
")
crn2 = ExchangeRate.SELL.add(CODE).whereEq(
"CZK")
crn3 = crn1.and(crn2);


Při častějším použití dotazu si můžeme ve třídě ExchangeRate připravit dva nové kompozitní klíče ukazující přímo na ten kód měny, pak se sestavení podmínky dále zjednoduší na výraz:

final Criterion<ExchangeRate> crn1, crn2, crn3;
crn1 = ExchangeRate.BUY_CODE.whereEq("EUR
")
crn2 = ExchangeRate.SELL_CODE.whereEq(
"CZK")
crn3 = crn1.and(crn2);


Podobné řešení můžeme použít také pro případ rekurzivních SQL dotazů.

2015-04-18

Tvorba indexů v Ujorm 1.56

Nová verze Ujorm 1.56 nabízí rozšířené možnosti tvorby databázových indexů pomocí anotace @Column (umístěné nad klíčem typu Key<A,B>) se dvěma metodami:
  • index()
  • uniqueIndex()
kde argumentem metod může být nově seznam indexů. Pokud se index jednoho jména vyskytuje v několika anotacích, vznikne kompozitní index.

Příklad použití:
   private static final String IDX_STATE_COUNT = "idx_state_count";
   private static final String IDX_COUNT = "idx_count";

   @Column(index = IDX_STATE_COUNT)
   public static final Key STATE = newKey();

   @Column(index = {IDX_STATE_COUNT, IDX_COUNT})
   public static final Key COUNT = newKey();

Databázový sloupec COUNT tedy bude obsažen ve dvou různých indexech, z toho jeden bude kompozitní.

Aby vznikl unikát kompozitní index, musí být jeho jméno vloženo vždy metodou uniqueIndex(). Pořadí sloupců v kompozitním klíči je určeno pořadím Klíčů. Pokud budeme potřebovat jiné pořadí, můžeme použít rozšířenou implementaci třídy pro sestavení indexů z frameworku Ujorm, která akceptuje pořadí sloupce (v kompozitním indexu), které se vkládá za název indexu. Výchozí hodnota je 10, dva sloupce se stejným číslem pak kopírují pořadí Klíče. Ukázka použití je tady:
   private static final String IDX_STATE_COUNT = "idx_state_count";

   @Column(index = IDX_STATE_NOTE + "#30")
   public static final Key STATE = newKey();

   @Column(index = IDX_STATE_NOTE + "#20")
   public static final Key COUNT = newKey();

Rozšířenou implementaci třídy pro sestavení indexů lze nakonfigurovat (v době sestavení meta-modelu) příkazem:
   MetaParams params = new MetaParams();
   params.set(MetaParams.INDEX_MODEL_BUILDER, IndexModelOrderedBuilder.class);
   ormHandler.config(params);

Je zřejmé, že parametr INDEX_MODEL_BUILDER může referencovat také vlastní implementaci, která pak může sestavovat model indexů podle úplně jiných pravidel a anotací. Specifické požadavky lze potom řešit zcela mimo framework Ujorm.

2015-02-19