edee.oneDocs
EdeeShop · Implementace

Konfigurace query pro načtení publikovaných produktů

Upraveno

Následující kapitola popisuje konfiguraci dotazu (query) pro načtení produktů z publikovaných dat.

Příklad konfigurace

xml
<query>    <ids/>    <codes/>    <filterBy/>    <orderBy/>    <require/>    <associatedData/>    <brandCodes/>    <brandsIds/>    <category/>    <categoryId/>    <changedAfter/>    <exceptProductCodes/>    <exceptProductIds/>    <groupCodes/>    <groupIds/>    <hierarchyFetchDepth/>    <locale/>    <masterCodes/>    <masterIds/>    <pageNumber/>    <pageSize/>    <parameterValueCodes/>    <parameterValueIds/>    <productTypes>        <productType/>    </productTypes>    <publishedAfter/>    <referencedEntities>        <referencedEntity/>    </referencedEntities>    <referencedEntitiesAndTheirGroups/>    <references/>    <relatedFileSetCodes>        <code/>    </relatedFileSetCodes>    <scopes>        <scope/>    </scopes>    <status>ACTIVE</status>    <stockCodes/>    <stockIds/>    <tagCodes/>    <tagIds/>    <theMoment/>    <visibility/>    <visibleForStockCodes/>    <visibleForStockIds/></query>

Popis

query

VlastnostPopisHodnotaPovinnáVýchozí hodnota
ids

Umožňuje definovat id entit, které mají být vráceny.

Integer

-

-

codes

Umožňuje definovat kódy entit, které mají být vráceny.

String

-

-

filterBy

Vrací filtr obsahující podmínky (omezení), které musí vrácené entity splňovat.

FilterBy

-

-

orderBy

Vrací nastavení pro setřídění entit ve výsledku.

OrderBy

-

-

require

Vrací další požadavky na rozsah či formu výstupních entit nebo dalších výpočtů v rámci dotazu.

Require

-

-

associatedData

Vrací seznam klíčů asociovaných dat, které je třeba načíst společně s entitami.

Podrobněji zde https://evitadb.io/documentation/query/requirements/fetching?lang=evitaql#associated-data-content

String

-

-

brandCodes

Omezuje vyhledávání produktů pouze na ty, které mají některou z uvedených značek dle jejich kódu (OR).

String

-

-

brandsIds

Omezuje vyhledávání produktů pouze na ty, které mají některou z uvedených značek dle jejich primárního klíče (OR).

int

-

-

category

Omezuje vyhledávání produktů pouze v kategorii s určitým kódem a jejích podkategoriích.

String

-

-

categoryId

Omezuje vyhledávání produktů pouze v kategorii s určitým primárním klíčem a jejích podkategoriích.

Integer

-

-

changedAfter

Datum a čas, od kterého se mají vrátit entity, které se změnily po tomto datu a čase.

java.time.OffsetDateTime

-

-

exceptProductCodes

Zajišťuje, že z vyhledaného výsledku jsou vyloučeny všechny produkty s konkrétními kódy.

String

-

-

exceptProductIds

Zajišťuje, že z vyhledaného výsledku jsou vyloučeny všechny produkty s konkrétními primárními klíči.

int

-

-

groupCodes

Omezuje vyhledávání produktů pouze na ty, které jsou zařazeny v uvedených skupinách dle jejich kódu (OR).

String

-

-

groupIds

Omezuje vyhledávání produktů pouze na ty, které jsou zařazeny v uvedených skupinách dle jejich primárního klíče (OR).

int

-

-

hierarchyFetchDepth

Vrací hloubku načítání referencí na hierarchicky členěné entity (v našem prostředí typicky pouze kategorie). Pokud je hodnota null, tak se hierarchické informace entit nenačítají, pokud je Integer#MAX_VALUE, tak se načítají všechny úrovně až ke kořenu hierarchie.

Podrobněji zde https://evitadb.io/documentation/query/requirements/fetching?lang=evitaql#hierarchy-content

Integer

-

-

locale

Umožňuje definovat jazyk, pro který musí mít daná entita odpovídající lokalizaci. Lokalizované atributy a asociovaná data jsou následně vrácena v tomto jazyku.

Podrobněji zde https://evitadb.io/documentation/query/filtering/locale

locale

-

-

masterCodes

Omezuje vyhledávání produktů pouze na ty, které jsou variantami uvedených master produktů dle jejich kódu.

String

-

-

masterIds

Omezuje vyhledávání produktů pouze na ty, které jsou variantami uvedených master produktů dle jejich primárního klíče.

int

-

-

pageNumber

Specifikuje stránku výsledku stránkovaného výsledku. Výchozí hodnota: 1

Integer

-

-

pageSize

Definuje počet položek na stránce stránkovaného výsledku. Výchozí hodnota: 20

Integer

-

-

parameterValueCodes

Omezuje vyhledávání produktů pouze na ty, které mají kombinaci uvedených hodnot parametrů dle jejich kódu. Hodnoty parametrů v rámci stejného typu parametru se spojují logickým a nebo (OR), různé typy parametrů pak logickým a zároveň (AND).

String

-

-

parameterValueIds

Omezuje vyhledávání produktů pouze na ty, které mají kombinaci uvedených hodnot parametrů dle jejich primárního klíče. Hodnoty parametrů v rámci stejného typu parametru se spojují logickým a nebo (OR), různé typy parametrů pak logickým a zároveň (AND).

int

-

-

productTypes/productType

Omezuje vyhledávání produktů pouze na uvedené typy.

  • BASIC - Standardní (základní) produkt
  • MASTER - Master produkt představuje jakéhosi společného předka pro všechny varianty produktu.

Např. můžeme mít tričko ve více velikostech (S,M,L,LX), ale všechny tyto varianty se mají v přehledech prezentovat jako jeden produkt v různých variantách.

Zobrazuje se v rozeskoku. Nelze objednat ani například přidat do wishlistu.

  • VARIANT - Varianta produktu.
  • SET - Komplet - tj. sada produktů kupovaná jako jeden celek.

-

-

publishedAfter

Datum a čas, od kterého se mají vrátit entity, které byly publikovány po tomto datu a čase.

java.time.OffsetDateTime

-

-

referencedEntities/referencedEntity

Vrací seznam názvů referencí, pro které mají být načtena těla entit na které odkazují společně s entitami.

Podrobněji zde https://evitadb.io/documentation/query/requirements/fetching?lang=evitaql#reference-content

String

-

-

referencedEntitiesAndTheirGroups

Vrací seznam názvů referencí, pro které mají být načtena těla entit na které odkazují společně s entitami a entitami skupin, do kterých jsou odkazované entity zařazené.

Podrobněji zde https://evitadb.io/documentation/query/requirements/fetching?lang=evitaql#reference-content

String

-

-

references

Vrací seznam názvů referencí, které je třeba načíst společně s entitami.

Podrobněji zde https://evitadb.io/documentation/query/requirements/fetching?lang=evitaql#reference-content

String

-

-

relatedFileSetCodes/code

Seznam kódů souborových sad (např. galerií), které mají inicializovány a tím tak načteny doplňující informace o souboru.

String

-

-

scopes/scope

Definuje rozsahy, ve kterých se mají produkty vyhledávat. Ve výchozím režimu se prohledávají pouze živé produkty, ale je možné přepnout na vyhledávání mezi archivovanými produkty (tj. s ukončeným prodejem) nebo mezi všemi produkty.

  • LIVE
  • ARCHIVED

-

[LIVE]

status

Určuje stav entity. Pokud není nastaveno na stav entit se nebere ohled.

  • ACTIVE - Entity is available on frontend.
  • TRASHED - Entity is entirely not available on frontend.
  • PRIVATE - Entity is entirely not available on frontend, but it's visible in administration.

-

[ACTIVE]

stockCodes

Omezuje vyhledávání produktů pouze na ty, které jsou dostupné na konkrétních skladech dle jejich kódu.

String

-

-

stockIds

Omezuje vyhledávání produktů pouze na ty, které jsou dostupné na konkrétních skladech dle jejich primárního klíče.

int

-

-

tagCodes

Omezuje vyhledávání produktů pouze na ty, které mají přiřazené konkrétní štítky dle systemId / kódu (OR).

String

-

-

tagIds

Omezuje vyhledávání produktů pouze na ty, které mají přiřazené konkrétní štítky dle primárního klíče (OR).

int

-

-

theMoment

Určuje aktuální čas v době dotazu, ve kterém musí být dané entity platné. Pokud není uvedeno, tak se časová platnost nebere v potaz.

Výchozí hodnota pro nové query se vyhodnocuje pomocí ClockAccessor#now(). Týká se ovšem pouze entity implementujících rozhraní WithPublishedValidity.

java.time.OffsetDateTime

-

-

visibility

Určuje stav viditelnosti vrácených entit. Pokud není nastaveno jinak na viditelnost entit se nebere ohled.

  • INVISIBLE - Entita je dostupná pouze na konkrétní detail stránce (se znalostí URL), není vyhledatelná a není přítomná ve výpisech.

Entity is not browsable, searchable, but is still accessible on direct url (detail page).

  • VISIBLE - Entita je viditelní v rozcestnících, lze vyhledat, je přístupná na detail stránce.

Entity is browsable, searchable and accessible on direct url (detail page).

-

-

visibleForStockCodes

Omezuje vyhledávání produktů pouze na ty, které jsou viditelné pro sklady dle jejich kódu.

Pokud není vyplněno, tak se produkty dle viditelnosti pro sklady neomezují.

String

-

-

visibleForStockIds

Omezuje vyhledávání produktů pouze na ty, které jsou viditelné pro sklady dle jejich primárního klíče.

Pokud není vyplněno, tak se produkty dle viditelnosti pro sklady neomezují.

int

-

-