Liking cljdoc? Tell your friends :D

metabase.public-settings


admin-emailclj

(admin-email)
(admin-email new-value)

The email address users should be referred to if they encounter a problem.

admin-email is a string Setting. You can get its value by calling:

(admin-email)

and set its value by calling:

(admin-email <new-value>)

You can also set its value with the env var MB_ADMIN_EMAIL.

Clear its value by calling:

(admin-email nil)

Its default value is nil.

The email address users should be referred to if they encounter a problem.

`admin-email` is a string Setting. You can get its value by calling:

    (admin-email)

and set its value by calling:

    (admin-email <new-value>)

You can also set its value with the env var `MB_ADMIN_EMAIL`.

Clear its value by calling:

    (admin-email nil)

Its default value is `nil`.
sourceraw docstring

anon-tracking-enabledclj

(anon-tracking-enabled)
(anon-tracking-enabled new-value)

Enable the collection of anonymous usage data in order to help Metabase improve.

anon-tracking-enabled is a boolean Setting. You can get its value by calling:

(anon-tracking-enabled)

and set its value by calling:

(anon-tracking-enabled <new-value>)

You can also set its value with the env var MB_ANON_TRACKING_ENABLED.

Clear its value by calling:

(anon-tracking-enabled nil)

Its default value is true.

Enable the collection of anonymous usage data in order to help Metabase improve.

`anon-tracking-enabled` is a boolean Setting. You can get its value by calling:

    (anon-tracking-enabled)

and set its value by calling:

    (anon-tracking-enabled <new-value>)

You can also set its value with the env var `MB_ANON_TRACKING_ENABLED`.

Clear its value by calling:

    (anon-tracking-enabled nil)

Its default value is `true`.
sourceraw docstring

breakout-bin-widthclj

(breakout-bin-width)
(breakout-bin-width new-value)

When using the default binning strategy for a field of type Coordinate (such as Latitude and Longitude), this number will be used as the default bin width (in degrees).

breakout-bin-width is a double Setting. You can get its value by calling:

(breakout-bin-width)

and set its value by calling:

(breakout-bin-width <new-value>)

You can also set its value with the env var MB_BREAKOUT_BIN_WIDTH.

Clear its value by calling:

(breakout-bin-width nil)

Its default value is 10.0.

When using the default binning strategy for a field of type Coordinate (such as Latitude and Longitude), this number will be used as the default bin width (in degrees).

`breakout-bin-width` is a double Setting. You can get its value by calling:

    (breakout-bin-width)

and set its value by calling:

    (breakout-bin-width <new-value>)

You can also set its value with the env var `MB_BREAKOUT_BIN_WIDTH`.

Clear its value by calling:

    (breakout-bin-width nil)

Its default value is `10.0`.
sourceraw docstring

breakout-bins-numclj

(breakout-bins-num)
(breakout-bins-num new-value)

When using the default binning strategy and a number of bins is not provided, this number will be used as the default.

breakout-bins-num is a integer Setting. You can get its value by calling:

(breakout-bins-num)

and set its value by calling:

(breakout-bins-num <new-value>)

You can also set its value with the env var MB_BREAKOUT_BINS_NUM.

Clear its value by calling:

(breakout-bins-num nil)

Its default value is 8.

When using the default binning strategy and a number of bins is not provided, this number will be used as the default.

`breakout-bins-num` is a integer Setting. You can get its value by calling:

    (breakout-bins-num)

and set its value by calling:

    (breakout-bins-num <new-value>)

You can also set its value with the env var `MB_BREAKOUT_BINS_NUM`.

Clear its value by calling:

    (breakout-bins-num nil)

Its default value is `8`.
sourceraw docstring

check-for-updatesclj

(check-for-updates)
(check-for-updates new-value)

Identify when new versions of Metabase are available.

check-for-updates is a boolean Setting. You can get its value by calling:

(check-for-updates)

and set its value by calling:

(check-for-updates <new-value>)

You can also set its value with the env var MB_CHECK_FOR_UPDATES.

Clear its value by calling:

(check-for-updates nil)

Its default value is true.

Identify when new versions of Metabase are available.

`check-for-updates` is a boolean Setting. You can get its value by calling:

    (check-for-updates)

and set its value by calling:

    (check-for-updates <new-value>)

You can also set its value with the env var `MB_CHECK_FOR_UPDATES`.

Clear its value by calling:

    (check-for-updates nil)

Its default value is `true`.
sourceraw docstring

custom-formattingclj

(custom-formatting)
(custom-formatting new-value)

Object keyed by type, containing formatting settings

custom-formatting is a json Setting. You can get its value by calling:

(custom-formatting)

and set its value by calling:

(custom-formatting <new-value>)

You can also set its value with the env var MB_CUSTOM_FORMATTING.

Clear its value by calling:

(custom-formatting nil)

Its default value is {}.

Object keyed by type, containing formatting settings

`custom-formatting` is a json Setting. You can get its value by calling:

    (custom-formatting)

and set its value by calling:

    (custom-formatting <new-value>)

You can also set its value with the env var `MB_CUSTOM_FORMATTING`.

Clear its value by calling:

    (custom-formatting nil)

Its default value is `{}`.
sourceraw docstring

enable-embeddingclj

(enable-embedding)
(enable-embedding new-value)

Allow admins to securely embed questions and dashboards within other applications?

enable-embedding is a boolean Setting. You can get its value by calling:

(enable-embedding)

and set its value by calling:

(enable-embedding <new-value>)

You can also set its value with the env var MB_ENABLE_EMBEDDING.

Clear its value by calling:

(enable-embedding nil)

Its default value is false.

Allow admins to securely embed questions and dashboards within other applications?

`enable-embedding` is a boolean Setting. You can get its value by calling:

    (enable-embedding)

and set its value by calling:

    (enable-embedding <new-value>)

You can also set its value with the env var `MB_ENABLE_EMBEDDING`.

Clear its value by calling:

    (enable-embedding nil)

Its default value is `false`.
sourceraw docstring

enable-nested-queriesclj

(enable-nested-queries)
(enable-nested-queries new-value)

Allow using a saved question as the source for other queries?

enable-nested-queries is a boolean Setting. You can get its value by calling:

(enable-nested-queries)

and set its value by calling:

(enable-nested-queries <new-value>)

You can also set its value with the env var MB_ENABLE_NESTED_QUERIES.

Clear its value by calling:

(enable-nested-queries nil)

Its default value is true.

Allow using a saved question as the source for other queries?

`enable-nested-queries` is a boolean Setting. You can get its value by calling:

    (enable-nested-queries)

and set its value by calling:

    (enable-nested-queries <new-value>)

You can also set its value with the env var `MB_ENABLE_NESTED_QUERIES`.

Clear its value by calling:

    (enable-nested-queries nil)

Its default value is `true`.
sourceraw docstring

enable-public-sharingclj

(enable-public-sharing)
(enable-public-sharing new-value)

Enable admins to create publicly viewable links (and embeddable iframes) for Questions and Dashboards?

enable-public-sharing is a boolean Setting. You can get its value by calling:

(enable-public-sharing)

and set its value by calling:

(enable-public-sharing <new-value>)

You can also set its value with the env var MB_ENABLE_PUBLIC_SHARING.

Clear its value by calling:

(enable-public-sharing nil)

Its default value is false.

Enable admins to create publicly viewable links (and embeddable iframes) for Questions and Dashboards?

`enable-public-sharing` is a boolean Setting. You can get its value by calling:

    (enable-public-sharing)

and set its value by calling:

    (enable-public-sharing <new-value>)

You can also set its value with the env var `MB_ENABLE_PUBLIC_SHARING`.

Clear its value by calling:

    (enable-public-sharing nil)

Its default value is `false`.
sourceraw docstring

enable-query-cachingclj

(enable-query-caching)
(enable-query-caching new-value)

Enabling caching will save the results of queries that take a long time to run.

enable-query-caching is a boolean Setting. You can get its value by calling:

(enable-query-caching)

and set its value by calling:

(enable-query-caching <new-value>)

You can also set its value with the env var MB_ENABLE_QUERY_CACHING.

Clear its value by calling:

(enable-query-caching nil)

Its default value is false.

Enabling caching will save the results of queries that take a long time to run.

`enable-query-caching` is a boolean Setting. You can get its value by calling:

    (enable-query-caching)

and set its value by calling:

    (enable-query-caching <new-value>)

You can also set its value with the env var `MB_ENABLE_QUERY_CACHING`.

Clear its value by calling:

    (enable-query-caching nil)

Its default value is `false`.
sourceraw docstring

enable-xraysclj

(enable-xrays)
(enable-xrays new-value)

Allow users to explore data using X-rays

enable-xrays is a boolean Setting. You can get its value by calling:

(enable-xrays)

and set its value by calling:

(enable-xrays <new-value>)

You can also set its value with the env var MB_ENABLE_XRAYS.

Clear its value by calling:

(enable-xrays nil)

Its default value is true.

Allow users to explore data using X-rays

`enable-xrays` is a boolean Setting. You can get its value by calling:

    (enable-xrays)

and set its value by calling:

    (enable-xrays <new-value>)

You can also set its value with the env var `MB_ENABLE_XRAYS`.

Clear its value by calling:

    (enable-xrays nil)

Its default value is `true`.
sourceraw docstring

map-tile-server-urlclj

(map-tile-server-url)
(map-tile-server-url new-value)

The map tile server URL template used in map visualizations, for example from OpenStreetMaps or MapBox.

map-tile-server-url is a string Setting. You can get its value by calling:

(map-tile-server-url)

and set its value by calling:

(map-tile-server-url <new-value>)

You can also set its value with the env var MB_MAP_TILE_SERVER_URL.

Clear its value by calling:

(map-tile-server-url nil)

Its default value is http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png.

The map tile server URL template used in map visualizations, for example from OpenStreetMaps or MapBox.

`map-tile-server-url` is a string Setting. You can get its value by calling:

    (map-tile-server-url)

and set its value by calling:

    (map-tile-server-url <new-value>)

You can also set its value with the env var `MB_MAP_TILE_SERVER_URL`.

Clear its value by calling:

    (map-tile-server-url nil)

Its default value is `http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`.
sourceraw docstring

public-settingsclj

(public-settings)

Return a simple map of key/value pairs which represent the public settings (MetabaseBootstrap) for the front-end application.

Return a simple map of key/value pairs which represent the public settings (`MetabaseBootstrap`) for the front-end
application.
sourceraw docstring

query-caching-max-kbclj

(query-caching-max-kb)
(query-caching-max-kb new-value)

The maximum size of the cache, per saved question, in kilobytes:

query-caching-max-kb is a integer Setting. You can get its value by calling:

(query-caching-max-kb)

and set its value by calling:

(query-caching-max-kb <new-value>)

You can also set its value with the env var MB_QUERY_CACHING_MAX_KB.

Clear its value by calling:

(query-caching-max-kb nil)

Its default value is 1000.

The maximum size of the cache, per saved question, in kilobytes:

`query-caching-max-kb` is a integer Setting. You can get its value by calling:

    (query-caching-max-kb)

and set its value by calling:

    (query-caching-max-kb <new-value>)

You can also set its value with the env var `MB_QUERY_CACHING_MAX_KB`.

Clear its value by calling:

    (query-caching-max-kb nil)

Its default value is `1000`.
sourceraw docstring

query-caching-max-ttlclj

(query-caching-max-ttl)
(query-caching-max-ttl new-value)

The absolute maximum time to keep any cached query results, in seconds.

query-caching-max-ttl is a integer Setting. You can get its value by calling:

(query-caching-max-ttl)

and set its value by calling:

(query-caching-max-ttl <new-value>)

You can also set its value with the env var MB_QUERY_CACHING_MAX_TTL.

Clear its value by calling:

(query-caching-max-ttl nil)

Its default value is 8640000.

The absolute maximum time to keep any cached query results, in seconds.

`query-caching-max-ttl` is a integer Setting. You can get its value by calling:

    (query-caching-max-ttl)

and set its value by calling:

    (query-caching-max-ttl <new-value>)

You can also set its value with the env var `MB_QUERY_CACHING_MAX_TTL`.

Clear its value by calling:

    (query-caching-max-ttl nil)

Its default value is `8640000`.
sourceraw docstring

query-caching-min-ttlclj

(query-caching-min-ttl)
(query-caching-min-ttl new-value)

Metabase will cache all saved questions with an average query execution time longer than this many seconds:

query-caching-min-ttl is a integer Setting. You can get its value by calling:

(query-caching-min-ttl)

and set its value by calling:

(query-caching-min-ttl <new-value>)

You can also set its value with the env var MB_QUERY_CACHING_MIN_TTL.

Clear its value by calling:

(query-caching-min-ttl nil)

Its default value is 60.

Metabase will cache all saved questions with an average query execution time longer than this many seconds:

`query-caching-min-ttl` is a integer Setting. You can get its value by calling:

    (query-caching-min-ttl)

and set its value by calling:

    (query-caching-min-ttl <new-value>)

You can also set its value with the env var `MB_QUERY_CACHING_MIN_TTL`.

Clear its value by calling:

    (query-caching-min-ttl nil)

Its default value is `60`.
sourceraw docstring

query-caching-ttl-ratioclj

(query-caching-ttl-ratio)
(query-caching-ttl-ratio new-value)

To determine how long each saved question's cached result should stick around, we take the query's average execution time and multiply that by whatever you input here.So if a query takes on average 2 minutes to run, and you input 10 for your multiplier, its cache entry will persist for 20 minutes.

query-caching-ttl-ratio is a integer Setting. You can get its value by calling:

(query-caching-ttl-ratio)

and set its value by calling:

(query-caching-ttl-ratio <new-value>)

You can also set its value with the env var MB_QUERY_CACHING_TTL_RATIO.

Clear its value by calling:

(query-caching-ttl-ratio nil)

Its default value is 10.

To determine how long each saved question's cached result should stick around, we take the query's average execution time and multiply that by whatever you input here.So if a query takes on average 2 minutes to run, and you input 10 for your multiplier, its cache entry will persist for 20 minutes.

`query-caching-ttl-ratio` is a integer Setting. You can get its value by calling:

    (query-caching-ttl-ratio)

and set its value by calling:

    (query-caching-ttl-ratio <new-value>)

You can also set its value with the env var `MB_QUERY_CACHING_TTL_RATIO`.

Clear its value by calling:

    (query-caching-ttl-ratio nil)

Its default value is `10`.
sourceraw docstring

remove-public-uuid-if-public-sharing-is-disabledclj

(remove-public-uuid-if-public-sharing-is-disabled object)

If public sharing is disabled and OBJECT has a :public_uuid, remove it so people don't try to use it (since it won't work). Intended for use as part of a post-select implementation for Cards and Dashboards.

If public sharing is *disabled* and OBJECT has a `:public_uuid`, remove it so people don't try to use it (since it
won't work). Intended for use as part of a `post-select` implementation for Cards and Dashboards.
sourceraw docstring

site-localeclj

(site-locale)
(site-locale new-value)

The default language for this Metabase instance. This only applies to emails, Pulses, etc. Users' browsers will specify the language used in the user interface.

site-locale is a string Setting. You can get its value by calling:

(site-locale)

and set its value by calling:

(site-locale <new-value>)

You can also set its value with the env var MB_SITE_LOCALE.

Clear its value by calling:

(site-locale nil)

Its default value is en.

The default language for this Metabase instance. This only applies to emails, Pulses, etc. Users' browsers will specify the language used in the user interface.

`site-locale` is a string Setting. You can get its value by calling:

    (site-locale)

and set its value by calling:

    (site-locale <new-value>)

You can also set its value with the env var `MB_SITE_LOCALE`.

Clear its value by calling:

    (site-locale nil)

Its default value is `en`.
sourceraw docstring

site-nameclj

(site-name)
(site-name new-value)

The name used for this instance of Metabase.

site-name is a string Setting. You can get its value by calling:

(site-name)

and set its value by calling:

(site-name <new-value>)

You can also set its value with the env var MB_SITE_NAME.

Clear its value by calling:

(site-name nil)

Its default value is Metabase.

The name used for this instance of Metabase.

`site-name` is a string Setting. You can get its value by calling:

    (site-name)

and set its value by calling:

    (site-name <new-value>)

You can also set its value with the env var `MB_SITE_NAME`.

Clear its value by calling:

    (site-name nil)

Its default value is `Metabase`.
sourceraw docstring

site-urlclj

(site-url)
(site-url new-value)

The base URL of this Metabase instance, e.g. "http://metabase.my-company.com".

site-url is a string Setting. You can get its value by calling:

(site-url)

and set its value by calling:

(site-url <new-value>)

You can also set its value with the env var MB_SITE_URL.

Clear its value by calling:

(site-url nil)

Its default value is nil.

The base URL of this Metabase instance, e.g. "http://metabase.my-company.com".

`site-url` is a string Setting. You can get its value by calling:

    (site-url)

and set its value by calling:

    (site-url <new-value>)

You can also set its value with the env var `MB_SITE_URL`.

Clear its value by calling:

    (site-url nil)

Its default value is `nil`.
sourceraw docstring

site-uuidclj

(site-uuid)
(site-uuid new-value)

Unique identifier used for this instance of Metabase. This is set once and only once the first time it is fetched via its magic getter. Nice!

site-uuid is a string Setting. You can get its value by calling:

(site-uuid)

and set its value by calling:

(site-uuid <new-value>)

You can also set its value with the env var MB_SITE_UUID.

Clear its value by calling:

(site-uuid nil)

Its default value is nil.

Unique identifier used for this instance of Metabase. This is set once and only once the first time it is fetched via
  its magic getter. Nice!

`site-uuid` is a string Setting. You can get its value by calling:

    (site-uuid)

and set its value by calling:

    (site-uuid <new-value>)

You can also set its value with the env var `MB_SITE_UUID`.

Clear its value by calling:

    (site-uuid nil)

Its default value is `nil`.
sourceraw docstring

version-infoclj

(version-info)
(version-info new-value)

Information about available versions of Metabase.

version-info is a json Setting. You can get its value by calling:

(version-info)

and set its value by calling:

(version-info <new-value>)

You can also set its value with the env var MB_VERSION_INFO.

Clear its value by calling:

(version-info nil)

Its default value is {}.

Information about available versions of Metabase.

`version-info` is a json Setting. You can get its value by calling:

    (version-info)

and set its value by calling:

    (version-info <new-value>)

You can also set its value with the env var `MB_VERSION_INFO`.

Clear its value by calling:

    (version-info nil)

Its default value is `{}`.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close