This page links to all of the LookML parameters that are children of the explore parameter.
An “explore” serves as the starting point for a query in the Looker application. Explores reference views and each explore can contain joins to other views. Explores should typically be declared in a model file.
Example Usage
New Feature! Hover over the parameter names in the code example below to see quick descriptions, and click on parameter names to jump to that page.
When a parameter can be set to one of several specific options, the default value is listed first.
# STRUCTURAL PARAMETERS
explore: explore_name {
fields: [field_or_set, field_or_set, …]
# DISPLAY PARAMETERS
description: "Description I Want"
hidden: yes | no
label: "Label I Want"
group_label: "Label To Use as a Heading in the Explore Menu"
view_label: "View Label I Want"
# FILTER PARAMETERS
access_filter: {
field: fully_scoped_field
user_attribute: user_attribute_name
}
# Possibly more access_filter declarations
always_filter: {
filters: {
field: field_name
value: "Looker filter expression"
}
# Possibly more filters declarations
}
case_sensitive: yes | no
conditionally_filter: {
filters: {
field: field_name
value: "Looker filter expression"
}
unless: [field_name, field_name, …]
}
sql_always_having: SQL HAVING condition ;;
sql_always_where: SQL WHERE condition ;;
suggestions: yes | no
# JOIN PARAMETERS always_join: [view_name, view_name, …]
join: view_name { # Desired join parameters (described on Join Parameters page) } # Possibly more join declarations # QUERY PARAMETERS cancel_grouping_fields: [fully_scoped_field, fully_scoped_field, …]
from: view_name
persist_for: "N (seconds | minutes | hours)"
sql_table_name: table_name ;;
symmetric_aggregates: yes | no
view_name: view_name
}
explore: explore_name {
fields: [field_or_set, field_or_set, …]
# DISPLAY PARAMETERS
description: "Description I Want"
hidden: yes | no
label: "Label I Want"
group_label: "Label To Use as a Heading in the Explore Menu"
view_label: "View Label I Want"
# FILTER PARAMETERS
access_filter: {
field: fully_scoped_field
user_attribute: user_attribute_name
}
# Possibly more access_filter declarations
always_filter: {
filters: {
field: field_name
value: "Looker filter expression"
}
# Possibly more filters declarations
}
case_sensitive: yes | no
conditionally_filter: {
filters: {
field: field_name
value: "Looker filter expression"
}
unless: [field_name, field_name, …]
}
sql_always_having: SQL HAVING condition ;;
sql_always_where: SQL WHERE condition ;;
suggestions: yes | no
# JOIN PARAMETERS always_join: [view_name, view_name, …]
join: view_name { # Desired join parameters (described on Join Parameters page) } # Possibly more join declarations # QUERY PARAMETERS cancel_grouping_fields: [fully_scoped_field, fully_scoped_field, …]
from: view_name
persist_for: "N (seconds | minutes | hours)"
sql_table_name: table_name ;;
symmetric_aggregates: yes | no
view_name: view_name
}
Parameter Definitions
| Parameter Name | Description |
|---|---|
| Structural Parameters | |
explore (for model) |
Expose a view in the Explore menu |
fields (for explore) |
Limits the fields available in an explore from its base view and through the explore’s joins |
| Display Parameters | |
description (for explore) |
Add a description for an explore that appears to users in the UI |
hidden (for explore) |
Hide an explore from the Explore menu |
label (for explore) |
Change the way an explore appears in the Explore menu |
group_label (for explore) |
ADDED4.14Create a label to use as a heading in the Explore menu |
view_label (for explore) |
Specify how a group of fields from the explore’s base view will be labeled in the field picker |
| Filter Parameters | |
access_filter |
NEW LOOKML Add user-specific filters to an explore |
access_filters |
OLD LOOKML Add user-specific filters to an explore |
always_filter |
Add filters a user can change, but not remove, to an explore |
case_sensitive (for explore) |
Specify whether filters are case sensitive for an explore |
conditionally_filter |
Add filters to an explore if a user does not add their own filter from a specific list |
sql_always_having |
ADDED4.2 Insert conditions into the query’s HAVING clause that a user cannnot change or remove for this explore |
sql_always_where |
Insert conditions into the query’s WHERE clause that a user cannnot change or remove for this explore |
suggestions |
Specify whether filter suggestions are enabled for an explore |
| Join Parameters | |
always_join |
Specify which joins must always be applied to an explore |
join |
Join an additional view to an explore. For more information about joins and their parameters, see the Join Parameters reference page. |
joins |
OLD LOOKML Begin a section of joins. For more information about joins and their parameters, see the Join Parameters reference page. |
| Query Parameters | |
cancel_grouping_fields |
Cancel the GROUP BY clause when certain fields are chosen in an explore |
from (for explore) |
Specify the view on which an explore will be based, and reference the fields of that view by the explore’s name |
persist_for (for explore) |
Change the cache settings for an explore |
sql_table_name (for explore) |
Specify the database table on which an explore will be based |
symmetric_aggregates |
Specify whether symmetric aggregates are enabled for an explore |
view (for explore) |
OLD LOOKML Specify the view on which an explore will be based, and reference the fields of that view by the view’s name |
view_name (for explore) |
NEW LOOKML Specify the view on which an explore will be based, and reference the fields of that view by the view’s name |
| Parameters to Avoid | |
access_filter_fields |
AVOID AS OF3.10 Replaced by access_filter |