Datastore

Datastore

{{ datastore }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published datastore
guid String The unique identifier for this datastore
value String Synonymn for guid
name text The name of the datastore
title text The title of the datastore
linked_title String A link to the datastore if it has a URL, or the escaped title if not
has_url Boolean True if the datastore has a URL
include_in_search Boolean Whether or not this datastore should be returned in on-site search results
domain_name text The domain name used by the URL for this datastore
url text The portion of the URL for this datastore following the domain name
full_url String The full URL for this datastore 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 does not have a URL)
search_entity entity The entity that search results should be directed to (if this datastore does not have a URL)
folder_guid String The unique identifier for the folder that contains this datastore.
folder folder The folder that contains this datastore.
field_id String The identifier for this field
label String The label for this field
output String The default output that the datastore 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 datastores themselves
data data Object containing the custom fields on this datastore
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{datastore['field-id']}}

{{ datastores }}

Contains multiple datastores.

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this contains at least one published datastore
output String The default output that the datastores will produce when it is output directly to the template - using the "output_in_list" property of each datastore in the items list
prepended list List containing any prepended datastores.
fetched list List containing all of the datastores that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended datastores.
appended_unique list List containing any appended datastores excluding any datastores that are in either the list of prepended or fetched datastores.
items list List containing all of the combined datastores 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 datastores specified.
size Integer The total number of datastores 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 datastores 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 will be included.
limit Integer The maximum number of items that were allowed to be in the list of fetched datastores. May be 0 in some cases (such as when when there are no fetched datastores.
start Integer The 1-based index of the first item in the list of fetched datastores.
page Integer The 1-based index of the paginated results returned in the list of fetched datastores, 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 datastores
total_pages Integer

{% datastore %}

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

{% datastore
output_to_template
 
If included the datastore will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this datastore is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this datastore to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the datastore will be output directly to the template.
=
value
 
Should evaluate to a datastore object, or the name or guid of a datastore May use liquid filters.
%}
Fetches a single datastore.

{% datastores %}

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

{% datastores
output_to_template
 
If included the datastores will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this datastores is stored on. "var" is the default behavior.
variable
output_to_template
 
If included the datastores will be output directly to the template.
=
arguments
 
Key:value pairs. May use the variable arguments syntax.
%}

arguments

prepend
 
May be a single datastore, a list of datastores, or the name or guid of a datastore to be be included at the beginning of the datastores.
append
 
May be a single datastore, a list of datastores, or the name or guid of a datastore to be be included at the end of the datastores.
exclude
 
May be a single datastore, a list of datastores, or the name or guid of a datastore that should NOT be included in the fetched results. Has no affect on prepended or appended datastores.
exclude_prepended
 
True to specifically exclude all prepended datastores 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 datastores 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 datastores as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting datastores. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
filter
 
Only include datastores that match the given string filter
folder
 
May include multiple folders. Only include datastores with one of the given folders
date_created_start
 
Only include datastores with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the datastore was first published.
date_created_end
 
Only include datastores with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the datastore was first published.
start
 
Set the 1-based index of the first datastore to fetch.
page
 
Used to automatically calculate the first datastore 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 datastores 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 datastores. 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 datastores was first published. Unpublishing and republishing a datastores 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 datastores.