Skip to content

Commit

Permalink
docs: Add CUBEJS_DAX_CREATE_DATE_HIERARCHIES env var
Browse files Browse the repository at this point in the history
  • Loading branch information
igorlukanin committed Mar 9, 2025
1 parent a4d48a0 commit 29f80c9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/pages/product/apis-integrations/dax-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ To enable or disable the DAX API on a specific deployment, go to <Btn>Settings</
in the Cube Cloud sidebar, then <Btn>Configuration</Btn>, and then toggle the
<Btn>Enable DAX API</Btn> option.

By default, the DAX API exposes all [time dimensions][ref-time-dimensions] as calendar
hierarchies. You can set the `CUBEJS_DAX_CREATE_DATE_HIERARCHIES` environment
variable to `false` to disable this behavior.

## Authentication

The DAX API supports the user name and password authentication method.
Expand All @@ -55,12 +59,6 @@ The DAX API works only with [views][ref-views], not cubes.

</InfoBox>

{/*
TODO
*/}

### Connection methods

Power BI provides [three methods][link-powerbi-connection] to connect to data
Expand All @@ -84,4 +82,5 @@ it removes the benefits of using a semantic layer.
[ref-sql-api]: /product/apis-integrations/sql-api
[ref-ref-dax-api]: /product/apis-integrations/dax-api/reference
[ref-views]: /product/data-modeling/concepts#views
[link-powerbi-connection]: https://learn.microsoft.com/en-us/power-bi/connect-data/service-live-connect-dq-datasets
[link-powerbi-connection]: https://learn.microsoft.com/en-us/power-bi/connect-data/service-live-connect-dq-datasets
[ref-time-dimensions]: /product/data-modeling/concepts#time-dimensions
8 changes: 8 additions & 0 deletions docs/pages/reference/configuration/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1210,6 +1210,14 @@ Number of seconds before session's SQL API security context will be invalidated.
| --------------- | ---------------------- | --------------------- |
| A valid integer number | `300` | `300` |

## `CUBEJS_DAX_CREATE_DATE_HIERARCHIES`

If `true`, the DAX API will expose time dimensions as calendar hierarchies.

| Possible Values | Default in Development | Default in Production |
| --------------- | ---------------------- | --------------------- |
| `true`, `false` | `true` | `true` |

## `CUBEJS_TELEMETRY`

If `true`, then send telemetry to Cube.
Expand Down

0 comments on commit 29f80c9

Please sign in to comment.