Dataset

cache_timeoutinteger

Duration (in seconds) of the caching timeout for this dataset.

column_formatsobject

Column formats.

columnsobject[]

Columns metadata.

databaseobject

Database associated with the dataset.

datasource_namestring

Dataset name.

default_endpointstring

Default endpoint for the dataset.

descriptionstring

Dataset description.

edit_urlstring

The URL for editing the dataset.

editors object[]

List of editors

Array [

idinteger

imgstring

labelstring

secondary_labelstring

typeinteger

]

extraobject

JSON string containing extra configuration elements.

fetch_values_predicatestring

Predicate used when fetching values from the dataset.

filter_selectboolean

SELECT filter applied to the dataset.

filter_select_enabledboolean

If the SELECT filter is enabled.

granularity_sqlaobject[][]

Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use granularity instead.

health_check_messagestring

Health check message.

idinteger

Dataset ID.

is_sqllab_viewboolean

If the dataset is a SQL Lab view.

main_dttm_colstring

The main temporal column.

metricsobject[]

Dataset metrics.

namestring

Dataset name.

offsetinteger

Dataset offset.

order_by_choicesstring[][]

List of order by columns.

paramsobject

Extra params for the dataset.

permstring

Permission expression.

rls_filters object[]

Row-level security filters applied to this dataset.

Array [

clausestringnullable

RLS filter clause.

filter_typestringnullable

RLS filter type.

group_keystringnullable

RLS filter group key.

idinteger

RLS filter ID.

inheritedboolean

If the filter is inherited from underlying physical tables.

Default value: false

namestring

RLS filter name.

roles object[]

Roles associated with the RLS filter.

Array [

idinteger

Role ID.

namestring

Role name.

]

]

schemastring

Dataset schema.

select_starstring

Select all clause.

sqlstring

A SQL statement that defines the dataset.

table_namestring

The name of the table associated with the dataset.

template_paramsobject

Table template params.

time_grain_sqlastring[][]

List of temporal granularities supported by the dataset.

typestring

Dataset type.

uidstring

Dataset unique identifier.

verbose_mapobject

Mapping from raw name to verbose name.

Dataset

{
  "cache_timeout": 0,
  "column_formats": {},
  "columns": [
    {}
  ],
  "database": {},
  "datasource_name": "string",
  "default_endpoint": "string",
  "description": "string",
  "edit_url": "string",
  "editors": [
    {
      "id": 0,
      "img": "string",
      "label": "string",
      "secondary_label": "string",
      "type": 0
    }
  ],
  "extra": {},
  "fetch_values_predicate": "string",
  "filter_select": true,
  "filter_select_enabled": true,
  "granularity_sqla": [
    {}
  ],
  "health_check_message": "string",
  "id": 0,
  "is_sqllab_view": true,
  "main_dttm_col": "string",
  "metrics": [
    {}
  ],
  "name": "string",
  "offset": 0,
  "order_by_choices": [
    "string"
  ],
  "params": {},
  "perm": "string",
  "rls_filters": [
    {
      "clause": "string",
      "filter_type": "string",
      "group_key": "string",
      "id": 0,
      "inherited": false,
      "name": "string",
      "roles": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    }
  ],
  "schema": "string",
  "select_star": "string",
  "sql": "string",
  "table_name": "string",
  "template_params": {},
  "time_grain_sqla": [
    "string"
  ],
  "type": "string",
  "uid": "string",
  "verbose_map": {}
}