Liking cljdoc? Tell your friends :D
Clojure only.

metabase.api.table

/api/table endpoints.

/api/table endpoints.
raw docstring

card->virtual-tableclj

(card->virtual-table {:keys [database_id] :as card} & {:keys [include-fields?]})

Return metadata for a 'virtual' table for a CARD in the Saved Questions 'virtual' database. Optionally include 'virtual' fields as well.

Return metadata for a 'virtual' table for a CARD in the Saved Questions 'virtual' database. Optionally include
'virtual' fields as well.
sourceraw docstring

fetch-query-metadataclj

(fetch-query-metadata table include_sensitive_fields)

Returns the query metadata used to power the query builder for the given table table-or-table-id

Returns the query metadata used to power the query builder for the given table `table-or-table-id`
sourceraw docstring

GET_clj

GET /api/table/

Get all Tables.

## `GET /api/table/`

Get all `Tables`.
sourceraw docstring

GET_:idclj

GET /api/table/:id

Get Table with ID.

PARAMS:
  • id
## `GET /api/table/:id`

Get `Table` with ID.

##### PARAMS:

*  **`id`**
sourceraw docstring

GET_:id_fksclj

GET /api/table/:id/fks

Get all foreign keys whose destination is a Field that belongs to this Table.

PARAMS:
  • id
## `GET /api/table/:id/fks`

Get all foreign keys whose destination is a `Field` that belongs to this `Table`.

##### PARAMS:

*  **`id`**
sourceraw docstring

GET_:id_query_metadataclj

GET /api/table/:id/query_metadata

Get metadata about a Table useful for running queries. Returns DB, fields, field FKs, and field values.

By passing include_sensitive_fields=true, information about sensitive Fields will be returned; in no case will any of its corresponding values be returned. (This option is provided for use in the Admin Edit Metadata page).

PARAMS:

  • id

  • include_sensitive_fields value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

## `GET /api/table/:id/query_metadata`

Get metadata about a `Table` useful for running queries.
   Returns DB, fields, field FKs, and field values.

  By passing `include_sensitive_fields=true`, information *about* sensitive `Fields` will be returned; in no case will
  any of its corresponding values be returned. (This option is provided for use in the Admin Edit Metadata page).

##### PARAMS:

*  **`id`** 

*  **`include_sensitive_fields`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
sourceraw docstring

GET /api/table/:id/related

Return related entities.

PARAMS:
  • id
## `GET /api/table/:id/related`

Return related entities.

##### PARAMS:

*  **`id`**
sourceraw docstring

GET_card__:id_fksclj

GET /api/table/card__:id/fks

Return FK info for the 'virtual' table for a Card. This is always empty, so this endpoint serves mainly as a placeholder to avoid having to change anything on the frontend.

## `GET /api/table/card__:id/fks`

Return FK info for the 'virtual' table for a Card. This is always empty, so this endpoint
   serves mainly as a placeholder to avoid having to change anything on the frontend.
sourceraw docstring

GET_card__:id_query_metadataclj

GET /api/table/card__:id/query_metadata

Return metadata for the 'virtual' table for a Card.

PARAMS:
  • id
## `GET /api/table/card__:id/query_metadata`

Return metadata for the 'virtual' table for a Card.

##### PARAMS:

*  **`id`**
sourceraw docstring

POST_:id_discard_valuesclj

POST /api/table/:id/discard_values

Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. If this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.

You must be a superuser to do this.

PARAMS:
  • id
## `POST /api/table/:id/discard_values`

Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. If
   this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.

You must be a superuser to do this.

##### PARAMS:

*  **`id`**
sourceraw docstring

POST_:id_rescan_valuesclj

POST /api/table/:id/rescan_values

Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields that are eligible for FieldValues.

You must be a superuser to do this.

PARAMS:
  • id
## `POST /api/table/:id/rescan_values`

Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields that
   are eligible for FieldValues.

You must be a superuser to do this.

##### PARAMS:

*  **`id`**
sourceraw docstring

PUT_:idclj

PUT /api/table/:id

Update Table with ID.

PARAMS:

  • id

  • display_name value may be nil, or if non-nil, value must be a non-blank string.

  • entity_type value may be nil, or if non-nil, value must be a valid entity type (keyword or string).

  • visibility_type value may be nil, or if non-nil, value must be one of: cruft, hidden, technical.

  • description value may be nil, or if non-nil, value must be a non-blank string.

  • caveats value may be nil, or if non-nil, value must be a non-blank string.

  • points_of_interest value may be nil, or if non-nil, value must be a non-blank string.

  • show_in_getting_started value may be nil, or if non-nil, value must be a boolean.

## `PUT /api/table/:id`

Update `Table` with ID.

##### PARAMS:

*  **`id`** 

*  **`display_name`** value may be nil, or if non-nil, value must be a non-blank string.

*  **`entity_type`** value may be nil, or if non-nil, value must be a valid entity type (keyword or string).

*  **`visibility_type`** value may be nil, or if non-nil, value must be one of: `cruft`, `hidden`, `technical`.

*  **`description`** value may be nil, or if non-nil, value must be a non-blank string.

*  **`caveats`** value may be nil, or if non-nil, value must be a non-blank string.

*  **`points_of_interest`** value may be nil, or if non-nil, value must be a non-blank string.

*  **`show_in_getting_started`** value may be nil, or if non-nil, value must be a boolean.
sourceraw docstring

routesclj

Ring routes for api/table: (PUT_:id POST_:id_discard_values POST_:id_rescan_values GET_:id_query_metadata GET_card__:id_fks GET_:id_fks GET_ GET_:id_related GET_:id GET_card__:id_query_metadata)

Ring routes for api/table:
(PUT_:id POST_:id_discard_values POST_:id_rescan_values GET_:id_query_metadata GET_card__:id_fks GET_:id_fks GET_ GET_:id_related GET_:id GET_card__:id_query_metadata)
sourceraw docstring

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close