Skip to content

Commit 8223f02

Browse files
committed
docs: Note on MDX API performance considerations
1 parent f1621e4 commit 8223f02

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/pages/product/apis-integrations/mdx-api.mdx

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,19 @@ To enable or disable the MDX API on a specific deployment, go to <Btn>Settings</
4040
in the Cube Cloud sidebar, then <Btn>Configuration</Btn>, and then toggle the
4141
<Btn>Enable MDX API</Btn> option.
4242

43+
### Performance considerations
44+
45+
To ensure the best user experience in Excel, the MDX API should be able to respond to
46+
requests with a subsecond latency. Consider the following recommendations:
47+
48+
- The [deployment][ref-deployment] should be collocated with users, so deploy it a region
49+
that is closest to your users.
50+
- Queries should hit [pre-aggregations][ref-pre-aggregations] whenever possible. Consider
51+
turning on the [rollup-only mode][ref-rollup-only-mode] to disallow queries that go
52+
directly to the upstream data source.
53+
- If some queries still go to the upstream data source, it should respond with a
54+
subsecond latency. Consider tuning the concurrency and quotas to achieve that.
55+
4356
## Using MDX API with Excel
4457

4558
<InfoBox>
@@ -178,4 +191,7 @@ Authentication and authorization work the same as for the [SQL API](/product/api
178191
[ref-cube-cloud-for-excel]: /product/apis-integrations/microsoft-excel
179192
[ref-hierarchies]: /product/data-modeling/reference/hierarchies
180193
[ref-folders]: /product/data-modeling/reference/view#folders
181-
[ref-views]: /product/data-modeling/concepts#views
194+
[ref-views]: /product/data-modeling/concepts#views
195+
[ref-deployment]: /product/deployment/cloud/deployments
196+
[ref-pre-aggregations]: /product/caching/using-pre-aggregations
197+
[ref-rollup-only-mode]: /product/caching/using-pre-aggregations#rollup-only-mode

0 commit comments

Comments
 (0)