Datastore Item

Name	Type	Description
object_type	String	Will always be datastore_item
is_valid	Boolean	True if this references a published datastore_item
guid	String	The unique identifier for this datastore_item
value	String	Synonymn for guid
name	text	The name of the datastore_item
title	text	The title of the datastore_item
linked_title	String	A link to the datastore_item if it has a URL, or the escaped title if not
datastore_guid	String	The unique identifier of the related datastore
datastore	datastore	Reference to the related datastore object
tags	tags	The list of tags associated with this datastore_item
authors	authors	The list of authors associated with this datastore_item
has_url	Boolean	True if the datastore_item has a URL
include_in_search	Boolean	Whether or not this datastore_item should be returned in on-site search results
domain_name	text	The domain name used by the URL for this datastore_item
url	text	The portion of the URL for this datastore_item following the domain name
full_url	String	The full URL for this datastore_item including the scheme, domain name, and path
visited	Boolean	Whether or not the user has visited this URL previously in their current session. Note that this will always be false if the user has not allowed session permission (see the Permissions and Personalization documentation). Using this property prevents the page from being fast-cached
template_guid	String	The unique identifier for the template that would be used to respond to this URL
template	template	The template that would be used to respond to this URL
canonical_url	url	The canonical URL if this is not the original source of content for this URL
browser_title	text	The browser title to use for this URL
meta_description	textarea	The meta description for this URL
meta_robots	text	The meta robots for this URL
keywords	textarea	The SEO keywords for this URL
search_entity_guid	String	The unique identifier for the entity that search results should be directed to (if this datastore_item does not have a URL)
search_entity	entity	The entity that search results should be directed to (if this datastore_item does not have a URL)
folder_guid	String	The unique identifier for the folder that contains this datastore_item.
folder	folder	The folder that contains this datastore_item.
field_id	String	The identifier for this field
label	String	The label for this field
output	String	The default output that the datastore_item produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of datastore items themselves
data	data	Object containing the custom fields on this datastore_item
*	String	Specific custom fields may be accessed using {{ entity.fieldid }} or {{datastore_item['field-id']}}

Contains multiple datastore_items.

Name	Type	Description
object_type	String	Will always be datastore_item
is_valid	Boolean	True if this contains at least one published datastore_item
output	String	The default output that the datastore_items will produce when it is output directly to the template - using the "output_in_list" property of each datastore_item in the items list
prepended	list	List containing any prepended datastore_items.
fetched	list	List containing all of the datastore_items that were fetched from the database (as opposed to prepended or appended).
appended	list	List containing any appended datastore_items.
appended_unique	list	List containing any appended datastore_items excluding any datastore_items that are in either the list of prepended or fetched datastore_items.
items	list	List containing all of the combined datastore_items from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of datastore_items specified.
size	Integer	The total number of datastore_items in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
max_size	Integer	If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this datastore_items object is enumerated as a list. When not set, this value will be 0.
unique	Boolean	When true, the items list will not contain any duplicates. Only the first instance of each datastore_item will be included.
limit	Integer	The maximum number of items that were allowed to be in the list of fetched datastore_items. May be 0 in some cases (such as when when there are no fetched datastore_items.
start	Integer	The 1-based index of the first item in the list of fetched datastore_items.
page	Integer	The 1-based index of the paginated results returned in the list of fetched datastore_items, which is calculated from the start and limit parameters. Useful for paginated results.
total_count	Integer	The 1-based index of the first item in the list of fetched datastore_items
total_pages	Integer

{% datastore_item %}

{% datastore_item output_to_template? [var, set, or assign]? variable? output_to_template? = value %}

{% datastore_item

output_to_template

If included the datastore_item will be output directly to the template.

var, set, or assign

Optional. Specify either "var", "set" or "assign" to change which scope this datastore_item is stored on. "var" is the default behavior.

variable_name

Specify a variable name in order to save this datastore_item to a variable. If not specified, it will be output to the template instead.

output_to_template

If included the datastore_item will be output directly to the template.

value

Should evaluate to a datastore_item object, or the name or guid of a datastore_item May use liquid filters.

Fetches a single datastore_item.

{% datastore_items %}

{% datastore_items output_to_template? [var, set, or assign]? variable? output_to_template? = arguments %}

{% datastore_items

output_to_template

If included the datastore_items will be output directly to the template.

var, set, or assign

Optional. Specify either "var", "set" or "assign" to change which scope this datastore_items is stored on. "var" is the default behavior.

variable

output_to_template

If included the datastore_items will be output directly to the template.

arguments

Key:value pairs. May use the variable arguments syntax.

arguments

prepend

May be a single datastore_item, a list of datastore_items, or the name or guid of a datastore_item to be be included at the beginning of the datastore_items.

append

May be a single datastore_item, a list of datastore_items, or the name or guid of a datastore_item to be be included at the end of the datastore_items.

exclude

May be a single datastore_item, a list of datastore_items, or the name or guid of a datastore_item that should NOT be included in the fetched results. Has no affect on prepended or appended datastore_items.

exclude_prepended

True to specifically exclude all prepended datastore_items from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.

exclude_appended

True to specifically exclude all appended datastore_items from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.

unique

True to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.

max_size

The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many datastore_items as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting datastore_items. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".

filter

Only include datastore items that match the given string filter

datastore

May include multiple datastores. Only include datastore items with one of the given datastores

query

Only include datastore items which match the given query. Datastore item queries have their own advanced syntax, which may be reviewed at https://help.marketpath.com/liquid/advanced-datastore-queries

tag

May include multiple tags. Only include datastore items with one of the given tags

author

May include multiple authors. Only include datastore items with one of the given authors

folder

May include multiple folders. Only include datastore items with one of the given folders

date_created_start

Only include datastore items with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the datastore item was first published.

date_created_end

Only include datastore items with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the datastore item was first published.

start

Set the 1-based index of the first datastore_item to fetch.

page

Used to automatically calculate the first datastore_item to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.

limit

The maximum number of datastore_items to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.

sort_by

Specify which property to sort the results by. Has no affect on prepended or appended datastore_items. By default, results will be sorted by relevance if there is a filter string and date_created desc (newest first) if not. Options include:

relevance: only applies when there is a filter string. When sorting by relevance sort_direction is ignored.
date_created: the date each datastore_items was first published. Unpublishing and republishing a datastore_items resets date_created to the current date.
random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
name
title
url
browser_title

sort_direction

asc or desc.

cache_random

True to allow the results to be cached when sort_by is "random".

Fetches a list of datastore_items.

Examples

Simple query: {% datastore_items items = datastore:"Hotels" query:"number_of_rooms > 100 AND average_room_price <= 100" %}

Complex query:
{% capture query %}
is_vegan
OR
(
number_of_ingredients < 6
AND (
NOT ingredients contains chicken
-ingredients contains pork
- ingredients LIKE 'beef'
{% if other_meat_to_avoid is_valid %}
AND !(ingredients CONTAINS "{{other_meat_to_avoid | replace: '"', '""' }}")
{% endif %}
)
AND NOT (
'contains_dairy'
OR ingredients contains egg
)
)
{% endcapture %}
{% datastore_items items = datastore:'Recipes' query:query %}

Query multiple configurable fields:
{% set query = "" %}
{% set fieldvalue = request.query_params['fieldvalue'] | urldecode %}
{% if request.query_params['fieldnames'] is_valid and fieldvalue is_valid %}
{% var fieldnames = request.query_params['fieldnames'] | urldecode | split: ',' %}
{% var queryparts = '' | compact %}
{% for field in fieldnames %}
{% capture querypart %}{{field}} = "{{fieldvalue | replace: '"', '""'}}"{% endcapture %}
{% set queryparts = queryparts | concat: querypart %}
{% endfor %}
{% set query = queryparts | join: ' OR ' %}
{% endif %}
{% datastore_items items = datastore:entity query:query %}

Datastore Item

Datastore Item

{{ datastore_item }}

{{ datastore_items }}

{% datastore_item %}

{% datastore_items %}

Examples