Field parameters

This page links to all of the LookML parameters that define fields.

There are several types of fields:

  • Dimensionsrepresent a column in a table, or a computed value based on some sort of column manipulation or combination
  • Dimension Groupsare only used with time-based data, and enable you to create many time-based dimensions at one time
  • Measuresare similar to aggregate functions in SQL (for example, COUNT , SUM , AVG ) and represent information about multiple rows
  • Filterscreate a filter-only field users can use to provide input to a templated filter or a conditional join
  • Parameterscreate a filter-only field users can use to provide input to a Liquid {% parameter %} tag

Example usage

Hold the pointer over a parameter name to see a quick description. Click a parameter name to jump to its reference page.

When a parameter can be set to one of several specific options, the default value is listed first.

## STRUCTURAL PARAMETERS  view 
 
 : 
 view_name 
 { 
 ( 
  dimension 
 
|  dimension_group 
 
|  measure 
 
|  filter 
 
 |  parameter 
 
 ) 
 : 
 field_name 
 { 
  intervals 
 
 : 
 [ 
 interval, interval, … 
 ] 
  timeframes 
 
 : 
 [ 
 timeframe, timeframe, … 
 ] 
    # ACTION AND LINKING PARAMETERS
      action 
 
 : { 
  label 
 
 : 
 "Label to Appear in Action Menu" 
  url 
 
 : 
 "url" 
  icon_url 
 
 : 
 "url" 
  form_url 
 
 : 
 "url" 
  param 
 
 : { 
  name 
 
 : 
 "name string" 
  value 
 
 : 
 "value string" 
 } 
      # Possibly more param definitions
        form_param 
 
 : { 
  name 
 
 : 
 "title" 
  type 
 
 : 
 select 
| string 
| textarea 
  label 
 
 : 
 "desired label name" 
  required 
 
 : 
 yes 
| no 
  default 
 
 : 
 "value string" 
  option 
 
 : { 
  name 
 
 : 
 "name string" 
  value 
 
 : 
 "value string" 
 } 
        # Possibly more option definitions
       } 
      # Possibly more form_param definitions
     } 
  drill_fields 
 
 : 
 [ 
 field_or_set, field_or_set, ... 
 ] 
  tags 
 
 : 
 [ 
 "string1", "string2", ... 
 ] 
  link 
 
 : 
 { 
  label 
 
 : 
 "desired label name;" 
  url 
 
 : 
 "desired_url" 
  icon_url 
 
 : 
 "url_of_an_image_file" 
 } 
    # Possibly more link definitions
    # DISPLAY PARAMETERS
      alias 
 
 : 
 [ 
 old_field_name, old_field_name, ... 
 ] 
  alpha_sort 
 
 : 
 yes 
| no 
  description 
 
 : 
 "description string" 
  group_label 
 
 : 
 "desired group label name" 
  group_item_label 
 
 : 
 "label to use under the group label in the field picker" 
  hidden 
 
 : 
 yes 
| no 
  label 
 
 : 
 "desired label name" 
  label_from_parameter 
 
 : 
 parameter_name 
  order_by_field 
 
 : 
 dimension_name | dimension_group_name | measure_name 
  style 
 
 : 
 classic | interval | integer | relational 
  view_label 
 
 : 
 "desired label name" 
    # FILTER PARAMETERS
      can_filter 
 
 : 
 yes 
| no 
  case_sensitive 
 
 : 
 yes 
| no 
  filters 
 
 : 
 [ 
 dimension 
 : 
 "filter expression" 
 , 
 dimension 
 : 
 "filter expression" 
 , ... 
 ] 
  skip_drill_filter 
 
 : 
 yes 
| no 
    # FILTER SUGGESTION PARAMETERS
      allowed_value 
 
 : { 
  label 
 
 : 
 "desired label name" 
  value 
 
 : 
 "looker filter expression" 
 } 
    # Possibly more allowed_value definitions
      bypass_suggest_restrictions 
 
 : 
 yes 
| no 
  full_suggestions 
 
 : 
 yes 
| no 
  suggest_dimension 
 
 : 
 dimension_name 
  suggest_explore 
 
 : 
 explore_name 
  suggest_persist_for 
 
 : 
 "N (seconds | minutes | hours)" 
  suggestable 
 
 : 
 yes 
| no 
  suggestions 
 
 : 
 [ 
 "suggestion string", "suggestion string", "…" 
 ] 
<

    # QUERY PARAMETERS
      allow_approximate_optimization 
 
 : 
 yes 
| no 
  approximate 
 
 : 
 yes 
| no 
  approximate_threshold 
 
 : 
 N 
  convert_tz 
 
 : 
 yes 
| no 
  datatype 
 
 : 
 epoch | timestamp | datetime | date | yyyymmdd 
  fanout_on 
 
 : 
 repeated_record_name 
  precision 
 
 : 
 N 
  primary_key 
 
 : 
 yes 
| no 
  required_access_grants 
 
 : [ 
 access_grant_name 
 , 
 access_grant_name 
 , ...] 
  required_fields 
 
 : 
 [ 
 field_name, field_name, ... 
 ] 
  sql_distinct_key 
 
 : 
 SQL expression to define repeated entities ;; 
    # VALUE AND FORMATTING PARAMETERS
      case 
 
 : 
 { 
  when 
 
 : 
 { 
  sql 
 
 : 
 SQL condition ;; 
  label 
 
 : 
 "value" 
 } 
      # Possibly more when statements
     } 
  default_value 
 
 : 
 "desired default value" 
  direction 
 
 : 
 "row | column" 
  end_location_field 
 
 : 
 dimension_name 
  html 
 
 : 
 HTML expression using Liquid template elements ;; 
  list_field 
 
 : 
 dimension_name 
  percentile 
 
 : 
 Nth percentile 
  sql 
 
 : 
 SQL expression to generate the field value ;; 
  sql_end 
 
 : 
 SQL expression indicating the end time of a duration ;; 
  sql_latitude 
 
 : 
 SQL expression to generate a latitude ;; 
  sql_longitude 
 
 : 
 SQL expression to generate a longitude ;; 
  sql_start 
 
 : 
 SQL expression indicating the start time of a duration ;; 
  start_location_field 
 
 : 
 dimension_name 
  synonyms 
 
 : 
 [ 
 synonym1, synonym2, ... 
 ] 
  tiers 
 
 : 
 [ 
 N, N, ... 
 ] 
  type 
 
 : 
 dimension_field_type 
# For a dimension field
      type 
 
 : 
 dimension_group_type 
# For a dimension_group field
      type 
 
 : 
 measure_field_type 
   # For a measure field
      type 
 
 : 
 filter_field_type 
   # For a filter field
      type 
 
 : 
 parameter_field_type 
# For a parameter field
      string_datatype 
 
 : 
 unicode 
# For a dimension field
      units 
 
 : 
 feet | kilometers | meters | miles | nautical_miles | yards 
  value_format 
 
 : 
 "excel-style formatting string" 
  value_format_name 
 
 : 
 format_name 
    # VISUALIZATION PARAMETERS
      allow_fill 
 
 : 
 yes 
| no 
  map_layer_name 
 
 : 
 name_of_map_layer 
 } 
 } 
 

Parameter definitions

  • D = Dimension
  • DG = Dimension Group
  • M = Measure
  • F = Filter
  • P = Parameter
Parameter Name
Valid Field Types
Description
Structural Parameters
D
Creates a dimension field
DG
Creates several time-based dimensions at the same time
F
Creates a filter-only field for use in a templated filter or conditional join
M
Creates a measure field
P
Creates a filter-only field users can use to provide input to a Liquid {% parameter %} tag
DG
Defines the set of duration dimensions you want in a dimension_group of type: duration
DG
Defines the set of timeframe dimensions you want in a dimension_group of type: time
Action and Linking Parameters
D M
Creates a data action on a field that lets users perform tasks in other tools, directly from Looker
D DG M
Declares the list of fields that will be displayed when the measure or dimension is drilled into
D M
Creates links to other Looker and external content
D DG M F P
Adds text that can be passed to other applications to provide data about a field
Display Parameters
D DG M F P
Allows saved URLs with old field names to remain functional after a field is renamed
D
Makes a case parameter sort its conditions alphabetically
D DG M F P
Adds a description to the field users can see when hovering the cursor over the field.
D DG M F
Groups fields together within a view in the field picker
D DG M F
Specifies a label to use for the field under its group label in the field picker
D DG M F P
Hides a field from the Explore UI
D DG M F P
Changes the way a field name appears in the field picker
D M
Changes the way a field name appears in a visualization based on the input to a parameter
D DG M

Sorts a field by the values of another field

Supported for dimensions, dimension groups

Supported for measures

D
Changes the way that tiers appear in the Looker UI for a dimension of type: tier
D DG M F P
Changes the fields that appear within a view in the field picker
Filter Parameters
D DG M
Determines if a dimension or measure can be used as a filter
D F
Determines if filters are case-sensitive for a dimension
F
Creates a filter-only field for use in a templated filter
M
Restricts a measure's calculation based on dimension limitations
D
Stops a dimension from being added to the filters when a measure is drilled into
Filter Suggestion Parameters
P
Specifies the choices for a parameter
D DG F P
Shows suggestions to users when sql_always_where is in use, but don't apply those limits to the suggestions
D DG F P
Controls how Looker queries your database to provide suggestions for a field's values in the filter of an Explore. Looker can use a basic SELECT DISTINCT query, or Looker can use the full logic of the Explore, including joins and sql_always_where and access_filter parameters.
D DG M F P
Bases the suggestions for a field on the values of a different dimension
D DG M F P
Bases the suggestions for a field on the values of a different Explore
D F P
Changes the cache settings for Looker filter suggestions
D DG M F P
Enables or disables suggestions for a field
D F P
Declares a list of values that will be used for a field's suggestions
Query Parameters
M
Allows distinct count approximations for measures of type: count or type: count_distinct , so that the measure can be used for aggregate awareness
M
Performs an approximate count for a measure of type: count_distinct . See the approximate documentation page for a list of dialects that support this parameter.
M
Sets the count at which BigQuery switches from an exact count distinct to an approximate count distinct
D DG M F P
Disables automatic time zone conversion for a field
D DG F M
Specifies the type of time data you are providing to a field
D DG M
Enables access to Google BigQuery repeated fields
M
Specifies the number of decimal places to use when making calculations for Looker symmetric aggregates
D
Declares a dimension as the primary key of a view
D DG F M P
Limits access to the field to only users whose user attribute values match the access grants
D M
Requires that additional fields are added to a query when a field is chosen
M
Defines the unique entities over which a measure of type: sum_distinct or type: average_distinct will be calculated
Value and Formatting Parameters
D
Creates a discrete set of values a dimension can have determined by SQL conditions
F P
Specifies a default value for filter fields
M
Determines the direction that a measure of type: percent_of_total or type: running_total is calculated when pivots are used
D
Defines the field that contains the end location for a field of type: distance
D DG M
Modifies the HTML output of a field using Liquid templating
M
Declares the dimension from which a measure of type: list will be calculated
M
Specifies the fractional value (the Nth percentile) for a measure of type: percentile or type: percentile_distinct
D DG M F
Determines how a field will be calculated
D DG
Defines the end time of a duration for a duration type dimension group or a duration type dimension
D
Defines the latitude of a dimension of type: location
D
Defines the longitude of a dimension of type: location
D DG
Defines the begin time of a duration for a duration type dimension group or a duration type dimension
D
Defines the field that contains the start location for a field of type: distance
D DG F M P
Specifies a list of string synonyms (words or phrases) that can be used to help large language models and app developers understand other ways that users may refer to a field
D
Defines the tiers for a dimension of type: tier
D F P
Specifies the type of dimension, filter, or parameter
DG
Specifies the type of dimension group
M
Specifies the type of measure
D
Specifies the unicode data type for a field of type: string for SQL Server or MySQL
D
Specifies the units to use for a field of type: distance
D M
Formats the output of a field using Excel style options
D M
Formats the output of a field using a built-in or custom format
Visualization Parameters
D DG
Determines if dimension filling is allowed for a dimension
D
Specifies a mapping from a data value to a geographic region that you've defined on a built-in or custom map
Parameters to Avoid
D M
Removed 5.4 Replaced by value_format
D M
Removed 3.16 Replaced by value_format
Design a Mobile Site
View Site in Mobile | Classic
Share by: