Skip to content

Commit 5620f71

Browse files
committed
docs: Tiny fixes
1 parent 8cfb253 commit 5620f71

File tree

9 files changed

+74
-9
lines changed

9 files changed

+74
-9
lines changed

docs/pages/guides/recipes/queries/pagination.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ We have the following data model:
2020

2121
```yaml
2222
cubes:
23-
- name: Orders
23+
- name: orders
2424
sql_table: orders
2525

2626
measures:
@@ -38,7 +38,7 @@ cubes:
3838
```
3939
4040
```javascript
41-
cube(`Orders`, {
41+
cube(`orders`, {
4242
sql_table: `orders`,
4343

4444
measures: {

docs/pages/product/caching/running-in-production.mdx

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,10 +377,67 @@ It also requires the M [Cube Store Worker tier](/product/deployment/cloud/pricin
377377
You can provide, rotate, or drop your own [customer-managed keys][ref-cmk] (CMK)
378378
for Cube Store via the <Btn>Encryption Keys</Btn> page in Cube Cloud.
379379

380+
## Troubleshooting
381+
382+
### Heavy pre-aggregations
383+
384+
When building some pre-aggregations, you might encounter the following error:
385+
386+
```
387+
Error: Error during create table: CREATE TABLE <REDACTED>
388+
Error: Query execution timeout after 10 min of waiting
389+
```
390+
391+
It means that your pre-aggregation is too heavy and takes too long to build.
392+
393+
As a temporary solution, you can increase the timeout for all queies that Cube
394+
runs against your data source via the `CUBEJS_DB_QUERY_TIMEOUT` environment variable.
395+
396+
However, it is recommended that you optimize your pre-aggregations instead:
397+
398+
* Use an export bucket if your [data source][ref-data-sources] supports it. Cube will then load the pre-aggregation data in a much more efficient way.
399+
* Use [partitions][ref-pre-agg-partitions]. Cube will then run a separate query to build each partition.
400+
* Build pre-aggregations [incrementally][ref-pre-agg-incremental]. Cube will then build only the necessary partitions with each pre-aggregation refresh.
401+
* Set an appropriate [build range][ref-pre-agg-build-range] if you don't need to query the whole date range. Cube will then include only the necessary data in the pre-aggregation.
402+
* Check that your pre-aggregation includes only necessary dimensions. Each additional dimension usually increases the volume of the pre-aggregation data.
403+
* If you include a high cardinality dimension, Cube needs to store a lot of data in the pre-aggregation. For example, if you include the primary key into the pre-aggregation, Cube will effectively need to store a copy of the original table in the pre-aggregation, which is rarely useful.
404+
* If a single pre-aggregation is used by queries with different sets of dimensions, consider creating separate pre-aggregations for each set of dimensions. This way, Cube will only include necessary data in each pre-aggregation.
405+
* Check if you have a heavy calculation in the [`sql` expression][ref-cube-sql] of your cubes (rather than a simple `sql_table` reference). If it's the case, you can build an additional [`original_sql` pre-aggregation][ref-pre-agg-original-sql] and [instruct][ref-pre-agg-use-original-sql] Cube to use it when building other pre-aggregations for this cube.
406+
407+
### MinIO
408+
409+
When using MinIO for persistent storage, you might encounter the following error:
410+
411+
```
412+
Error: Error during upload of <REDACTED>
413+
File <REDACTED> can't be listed after upload.
414+
Either there's Cube Store cluster misconfiguration,
415+
or storage can't provide the required consistency.
416+
```
417+
418+
Most likely, it happens because MinIO is not providing strong consistency guarantees,
419+
as required for Cube Store's [persistent storage](#persistent-storage).
420+
You can either try configuring MinIO to provide strong consistency or switch to
421+
using S3 or GCS.
422+
423+
<WarningBox>
424+
425+
The support for MinIO as persistent storage in Cube Store was contributed by the community.
426+
It's not supported by Cube or the vendor.
427+
428+
</WarningBox>
429+
380430

381431
[link-wsl2]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
382432
[ref-caching-partitioning]: /product/caching/using-pre-aggregations#partitioning
383433
[ref-config-env]: /reference/configuration/environment-variables
384434
[link-parquet-encryption]: https://parquet.apache.org/docs/file-format/data-pages/encryption/
385435
[link-aes]: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
386-
[ref-cmk]: /product/workspace/encryption-keys
436+
[ref-cmk]: /product/workspace/encryption-keys
437+
[ref-data-sources]: /product/configuration/data-sources
438+
[ref-pre-agg-partitions]: /product/caching/using-pre-aggregations#partitioning
439+
[ref-pre-agg-incremental]: /reference/data-model/pre-aggregations#incremental
440+
[ref-pre-agg-build-range]: /reference/data-model/pre-aggregations#build_range_start-and-build_range_end
441+
[ref-cube-sql]: /reference/data-model/cube#sql
442+
[ref-pre-agg-original-sql]: /reference/data-model/pre-aggregations#original_sql
443+
[ref-pre-agg-use-original-sql]: /reference/data-model/pre-aggregations#use_original_sql_pre_aggregations

docs/pages/product/configuration/data-sources/pinot.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ redirect_from:
33
- /config/databases/pinot
44
---
55

6-
# Pinot
6+
# Apache Pinot
77

88
[Apache Pinot][link-pinot] is a real-time distributed OLAP datastore purpose-built
99
for low-latency, high-throughput analytics, and perfect for user-facing analytical
@@ -14,6 +14,9 @@ workloads. [StarTree][link-startree] is a fully-managed platform for Pinot.
1414
- The hostname for the [Pinot][pinot] broker
1515
- The port for the [Pinot][pinot] broker
1616

17+
With the current implementation of the Pinot driver, you have to enable the
18+
[multi-stage query engine][link-pinot-msqe] in your Pinot cluster.
19+
1720
## Setup
1821

1922
<ReferenceBox>
@@ -93,6 +96,7 @@ Cube does not require any additional configuration to enable SSL as Pinot connec
9396

9497
[link-pinot]: https://pinot.apache.org/
9598
[pinot]: https://docs.pinot.apache.org/
99+
[link-pinot-msqe]: https://docs.pinot.apache.org/reference/multi-stage-engine
96100
[pinot-docs-approx-agg-fns]:
97101
https://docs.pinot.apache.org/users/user-guide-query/query-syntax/how-to-handle-unique-counting
98102
[ref-recipe-enable-ssl]:

docs/pages/product/configuration/data-sources/vertica.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Vertica
22

3+
[OpenText Analytics Database][opentext-adb] (Vertica) is a columnar database
4+
designed for big data analytics.
5+
36
## Prerequisites
47

58
- The hostname for the [Vertica][vertica] database server
@@ -41,6 +44,7 @@ To enable SSL-encrypted connections between Cube and Verica, set the
4144
configure custom certificates, please check out [Enable SSL Connections to the
4245
Database][ref-recipe-enable-ssl].
4346

47+
[opentext-adb]: https://www.opentext.com/products/analytics-database?o=vert
4448
[vertica]: https://www.vertica.com/documentation/vertica/all/
4549
[ref-recipe-enable-ssl]:/guides/recipes/data-sources/using-ssl-connections-to-data-source
4650

docs/pages/product/data-modeling/concepts/working-with-joins.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ cubes:
7070
sql: company
7171
type: string
7272

73-
- name: Orders
73+
- name: orders
7474
# ...
7575

7676
dimensions:

docs/pages/product/deployment/cloud/deployments.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ make sure to run a few queries in [Playground][ref-playground].
5959
## Deployment overview
6060

6161
The&nbsp;<Btn>Overview</Btn> page of each deployment provides a high-level
62-
summary if its components and state:
62+
summary of its components and state:
6363
* API endpoints with URLs and connection instructions.
6464
* Allocated resources in line with the [deployment type][ref-deployment-types].
6565
* Activity log of the most recent events.

docs/pages/product/faqs/troubleshooting.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ details which will help narrow down the scope of the issue.
3434
If you see `has a key that already exists in Name index` message, it means that your
3535
multitenancy setup is missing the `pre_aggregations_schema` configuration setting in your `cube.py` file.
3636

37-
If you see `Error: Query execution timeout after 10 min of waiting` message, it means pre-aggregation is too large to be built.
38-
3937
For any other error types, feel free to reach out to us in our support chat.
4038

4139
## Warning: There were queries in these timezones which are not added in the CUBEJS_SCHEDULED_REFRESH_TIMEZONES environment variable.

docs/pages/reference/frontend/cubejs-client-react.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## `useCubeQuery`
66

7-
> **useCubeQuery****TData**›(**query**: Query | Query[], **options?**: [UseCubeQueryOptions](#use-cube-query-options)): *[UseCubeQueryResult](#use-cube-query-result)‹Query, TData›*
7+
> **useCubeQuery****TData**›(**query**: Query | Query[], **options?**: [UseCubeQueryOptions](#usecubequeryoptions)): *[UseCubeQueryResult](#usecubequeryresulttquery-tdata)‹Query, TData›*
88
99
A React hook for executing Cube queries
1010
```js

docs/pages/reference/rest-api.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,9 @@ Response
165165
- `meta` - Custom metadata
166166
- `measures` - Array of measures in this cube/view
167167
- `dimensions` - Array of dimensions in this cube/view
168+
- `hierarchies` - Array of hierarchies in this cube
168169
- `segments` - Array of segments in this cube/view
170+
- `folders` - Array of folders in this view
169171
- `connectedComponent` - An integer representing a join relationship. If the same value is returned for two cubes, then there is
170172
at least one join path between them.
171173

0 commit comments

Comments
 (0)