Konfigurace query pro načtení publikovaných skupin

Konfigurace query pro načtení publikovaných skupin

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

Zkopírovat odkaz na sekciPříklad konfigurace

xml
1 <query>2    <ids/>3    <codes/>4    <filterBy/>5    <orderBy/>6    <require/>7    <associatedData/>8    <changedAfter/>9    <hierarchyFetchDepth/>10    <locale/>11    <optionalUrl/>12    <pageNumber/>13    <pageSize/>14    <publishedAfter/>15    <referencedEntities>16        <referencedEntity/>17    </referencedEntities>18    <referencedEntitiesAndTheirGroups/>19    <references/>20    <relatedFileSetCodes>21        <code/>22    </relatedFileSetCodes>23    <status>ACTIVE</status>24    <tagCodes/>25    <tagIds/>26    <theMoment/>27    <visibility/>28</query>

Zkopírovat odkaz na sekciPopis

Zkopírovat odkaz na sekciquery

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

-

-

changedAfter

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

java.time.OffsetDateTime

-

-

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

-

-

optionalUrl

Pokud je nastaveno na true, tak se do výsledku vyhledávání zařadí i skupiny, které nemají nastavenou URL.

boolean

-

false

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

-

-

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 .

String

-

-

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]

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).

-

-