From c37370d1248201f0a9a5d0120f15301b25990f26 Mon Sep 17 00:00:00 2001 From: Artyom Keydunov Date: Thu, 16 Apr 2026 16:32:55 -0700 Subject: [PATCH 1/2] docs: recipes cleanup (#10706) * docs: add share-of-total recipe with calculated fields and multi-stage measures Adds a new recipe explaining two approaches to share-of-total calculations: - calculated fields (% of total) for ad-hoc workbook exploration - multi-stage measures with Tesseract (group_by: []) for reusable semantic model metrics Also adds a cursor rule pinning the ecommerce demo as the canonical example data model. Made-with: Cursor * cleanup * docs: update pricing and product tier references - Removed mentions of the "Enterprise Premier" plan across multiple documents, replacing them with "Enterprise" where applicable. - Cleaned up the recipes section by removing references to funnels and XIRR, which are now hidden. - Adjusted the number of recipes listed in the index to reflect recent changes. This update ensures consistency in product tier naming and improves the clarity of the documentation. --- .cursor/rules/docs-example-data-model.mdc | 69 ++++ .../admin/account-billing/pricing.mdx | 16 +- .../admin/account-billing/support.mdx | 22 +- .../connect-to-data/data-sources/ksqldb.mdx | 2 +- .../data-sources/ms-fabric.mdx | 2 +- .../data-sources/singlestore.mdx | 2 +- .../admin/deployment/byoc/aws/index.mdx | 2 +- .../admin/deployment/byoc/aws/privatelink.mdx | 2 +- docs-mintlify/admin/deployment/byoc/index.mdx | 2 +- .../admin/deployment/encryption-keys.mdx | 2 +- .../admin/deployment/infrastructure.mdx | 4 +- docs-mintlify/admin/deployment/limits.mdx | 24 +- .../admin/deployment/vpc/aws/vpc-peering.mdx | 2 +- docs-mintlify/admin/monitoring/audit-log.mdx | 32 +- .../cube-core/running-in-production.mdx | 2 +- docs-mintlify/docs.json | 61 ++- .../running-in-production.mdx | 2 +- .../recipes/data-modeling/active-users.mdx | 50 +-- .../recipes/data-modeling/custom-calendar.mdx | 9 - .../data-modeling/designing-metrics.mdx | 1 + .../data-modeling/entity-attribute-value.mdx | 157 +++++--- .../recipes/data-modeling/funnels.mdx | 1 + .../passing-dynamic-parameters-in-a-query.mdx | 46 +-- .../recipes/data-modeling/percentiles.mdx | 58 +-- .../data-modeling/period-over-period.mdx | 25 +- .../recipes/data-modeling/share-of-total.mdx | 349 ++++++++++++++++++ .../recipes/data-modeling/snapshots.mdx | 99 +---- docs-mintlify/recipes/data-modeling/xirr.mdx | 13 +- docs-mintlify/recipes/index.mdx | 11 +- docs-mintlify/reference/control-plane-api.mdx | 2 +- 30 files changed, 636 insertions(+), 433 deletions(-) create mode 100644 .cursor/rules/docs-example-data-model.mdc create mode 100644 docs-mintlify/recipes/data-modeling/share-of-total.mdx diff --git a/.cursor/rules/docs-example-data-model.mdc b/.cursor/rules/docs-example-data-model.mdc new file mode 100644 index 0000000000000..c69df0ac4cc17 --- /dev/null +++ b/.cursor/rules/docs-example-data-model.mdc @@ -0,0 +1,69 @@ +--- +description: Canonical data model to use as the basis for all documentation examples +globs: docs-mintlify/** +alwaysApply: false +--- + +# Canonical Example Data Model + +All documentation examples and recipes must use the [ecommerce demo data model](https://github.com/cubedevinc/ecommerce_demo) as their basis unless the topic genuinely requires a different domain. + +## Cubes + +### `order_items` (fact, `ECOMMERCE.ORDER_ITEMS`) +The primary fact table. Use this as the starting point for most examples. + +Key fields: +- `id` — primary key +- `order_id`, `user_id`, `product_id`, `inventory_item_id` — foreign keys +- `status` (string) — `complete`, `processing`, `shipped`, `cancelled`, `returned` +- `sale_price` (number) — revenue per line item; measure `total_sale_price` (sum, currency) +- `created_at`, `shipped_at`, `delivered_at`, `returned_at` (time) +- `is_delivered` (boolean) +- measures: `count`, `order_count` (count_distinct on order_id), `total_sale_price` + +### `orders` (`ECOMMERCE.ORDERS`) +Order-level table. Use when examples are about order status or counts. + +Key fields: +- `order_id` — primary key +- `user_id`, `status`, `gender`, `num_of_item` +- `created_at`, `delivered_at`, `shipped_at` (time) +- measures: `count` + +### `products` (`ECOMMERCE.PRODUCTS`) +Product catalog. Use when examples need brand, category, or product dimensions. + +Key fields: +- `id` — primary key +- `brand`, `category`, `department`, `name`, `sku` +- `cost`, `retail_price` (number) +- measures: `count` + +### `users` (`ECOMMERCE.USERS`) +Customer table. Use when examples need demographic or geographic dimensions. + +Key fields: +- `id` — primary key +- `first_name`, `last_name`, `full_name`, `email` +- `age`, `gender` +- `city`, `state`, `country` +- `traffic_source` +- `created_at` (time) +- measures: `count` + +## Common example patterns + +**Revenue over time** → `order_items.total_sale_price` + `order_items.created_at` + +**Orders by status** → `order_items.count` + `order_items.status` + +**Revenue by brand/category** → `order_items.total_sale_price` joined to `products.brand` / `products.category` + +**User demographics** → `users.count` + `users.city` / `users.country` / `users.traffic_source` + +**Multi-cube join** → `order_items` joins `orders`, `products`, `users` via foreign keys defined in the repo + +## Reference + +Full model: https://github.com/cubedevinc/ecommerce_demo diff --git a/docs-mintlify/admin/account-billing/pricing.mdx b/docs-mintlify/admin/account-billing/pricing.mdx index f15a8f7ef5e5a..ea7ce05ed266c 100644 --- a/docs-mintlify/admin/account-billing/pricing.mdx +++ b/docs-mintlify/admin/account-billing/pricing.mdx @@ -30,8 +30,7 @@ subscription: card, and start using Cube Cloud right away. [Starter](#starter) and [Premium](#premium) product tiers are available on the on-demand payment plan. * _Commit payment plan_ allows you to have a contract with a CCU amount specified -in an order form. [Premium](#premium), [Enterprise](#enterprise), and -[Enterprise Premier](#enterprise-premier) product tiers are available on the +in an order form. [Premium](#premium) and [Enterprise](#enterprise) product tiers are available on the commit payment plan. [Contact us][link-contact-us] to learn more. ## Product tiers @@ -84,18 +83,6 @@ control][ref-cloud-acl]. Cube Cloud provides a 99.99% uptime SLA for this produc You can review its [pricing][cube-pricing], [support terms][ref-enterprise-tier-support], and [limits][ref-cloud-limits]. -### Enterprise Premier - -**Enterprise Premier product tier caters to high-scale, high-availability -mission-critical production deployments with security and compliance needs.** - -It offers everything in the [Enterprise product tier](#enterprise) as well as -unlimited pre-aggregation sizes, and support for kSQL and Elasticsearch. Cube -Cloud provides a 99.995% uptime SLA for this product tier. - -You can review its [pricing][cube-pricing], [support -terms][ref-enterprise-premier-tier-support], and [limits][ref-cloud-limits]. - ## Resources The following resource types incur CCU consumption and apply to _individual resources_ @@ -354,7 +341,6 @@ for the AI token consumption at the **Billing** page of their Cube Cloud account [ref-starter-tier-support]: /docs/deployment/cloud/support#starter [ref-premium-tier-support]: /docs/deployment/cloud/support#premium [ref-enterprise-tier-support]: /docs/deployment/cloud/support#enterprise -[ref-enterprise-premier-tier-support]: /docs/deployment/cloud/support#enterprise-premier [ref-query-history]: /admin/monitoring/query-history [ref-performance-insights]: /admin/monitoring/performance [ref-audit-log]: /admin/monitoring/audit-log diff --git a/docs-mintlify/admin/account-billing/support.mdx b/docs-mintlify/admin/account-billing/support.mdx index 3f846415fd0b0..be4f175e94376 100644 --- a/docs-mintlify/admin/account-billing/support.mdx +++ b/docs-mintlify/admin/account-billing/support.mdx @@ -60,25 +60,6 @@ response times as compared to the [Premium product tier](#premium-support). who will provide quarterly reviews, sharing new features and training as well as usage and optimization advice. -### Enterprise Premier - -* [Enterprise Premier product tier][ref-enterprise-premier-tier] includes support via **online resources** such as -[documentation][ref-docs-intro], [webinars][cube-webinars], and [community -Slack][cube-slack]. -* It also includes **unlimited support tickets** for our support engineers during -[support hours](#support-hours) through our in-product chat with faster -response times as compared to the [Enterprise product tier](#enterprise-support). - -| Priority | Response time during support hours | -| -------- | ---------------------------------- | -| P0 | 15 minutes | -| P1 | 1 hour | -| P2 | 8 business hours | -| P3 | 2 business days | - -* Enterprise Premier product tier also includes a **dedicated customer success manager** (CSM) -who will provide quarterly reviews, sharing new features and training as well -as usage and optimization advice. ## Support hours @@ -114,5 +95,4 @@ We prioritize support requests based on their severity, as follows: [ref-free-tier]: /admin/account-billing/pricing#free [ref-starter-tier]: /admin/account-billing/pricing#starter [ref-premium-tier]: /admin/account-billing/pricing#premium -[ref-enterprise-tier]: /admin/account-billing/pricing#enterprise -[ref-enterprise-premier-tier]: /admin/account-billing/pricing#enterprise-premier \ No newline at end of file +[ref-enterprise-tier]: /admin/account-billing/pricing#enterprise \ No newline at end of file diff --git a/docs-mintlify/admin/connect-to-data/data-sources/ksqldb.mdx b/docs-mintlify/admin/connect-to-data/data-sources/ksqldb.mdx index af00bd5bf555f..8fe859163f29d 100644 --- a/docs-mintlify/admin/connect-to-data/data-sources/ksqldb.mdx +++ b/docs-mintlify/admin/connect-to-data/data-sources/ksqldb.mdx @@ -8,7 +8,7 @@ applications, ingesting data from [Apache Kafka](https://kafka.apache.org). -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). [Contact us](https://cube.dev/contact) for details. diff --git a/docs-mintlify/admin/connect-to-data/data-sources/ms-fabric.mdx b/docs-mintlify/admin/connect-to-data/data-sources/ms-fabric.mdx index 02b28014448ad..d99036acabe7f 100644 --- a/docs-mintlify/admin/connect-to-data/data-sources/ms-fabric.mdx +++ b/docs-mintlify/admin/connect-to-data/data-sources/ms-fabric.mdx @@ -9,7 +9,7 @@ data warehouse. -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). [Contact us](https://cube.dev/contact) for details. diff --git a/docs-mintlify/admin/connect-to-data/data-sources/singlestore.mdx b/docs-mintlify/admin/connect-to-data/data-sources/singlestore.mdx index d1dfb627d65f8..8138ca4685984 100644 --- a/docs-mintlify/admin/connect-to-data/data-sources/singlestore.mdx +++ b/docs-mintlify/admin/connect-to-data/data-sources/singlestore.mdx @@ -8,7 +8,7 @@ high-throughput transactions (inserts and upserts) and low-latency analytics. -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). [Contact us](https://cube.dev/contact) for details. diff --git a/docs-mintlify/admin/deployment/byoc/aws/index.mdx b/docs-mintlify/admin/deployment/byoc/aws/index.mdx index 7fb2de74f3200..2008a02621741 100644 --- a/docs-mintlify/admin/deployment/byoc/aws/index.mdx +++ b/docs-mintlify/admin/deployment/byoc/aws/index.mdx @@ -11,7 +11,7 @@ the customer infrastructure on AWS and managed by the Cube Cloud Control Plane v -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). [Contact us](https://cube.dev/contact) for details. diff --git a/docs-mintlify/admin/deployment/byoc/aws/privatelink.mdx b/docs-mintlify/admin/deployment/byoc/aws/privatelink.mdx index c969d07bfe63b..9597f2121004b 100644 --- a/docs-mintlify/admin/deployment/byoc/aws/privatelink.mdx +++ b/docs-mintlify/admin/deployment/byoc/aws/privatelink.mdx @@ -8,7 +8,7 @@ Cube Cloud BYOC deployments on AWS support private connectivity for Cube API end -Available on the [Enterprise Premier plan](https://cube.dev/pricing) with BYOC deployments. +Available on the [Enterprise plan](https://cube.dev/pricing) with BYOC deployments. [Contact us](https://cube.dev/contact) for details. diff --git a/docs-mintlify/admin/deployment/byoc/index.mdx b/docs-mintlify/admin/deployment/byoc/index.mdx index 2e49ec0fa54bf..d640c1b977c2d 100644 --- a/docs-mintlify/admin/deployment/byoc/index.mdx +++ b/docs-mintlify/admin/deployment/byoc/index.mdx @@ -10,7 +10,7 @@ on a platform of choice (AWS/Azure/GCP) and managed by the Cube Cloud Control Pl -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). [Contact us](https://cube.dev/contact) for details. diff --git a/docs-mintlify/admin/deployment/encryption-keys.mdx b/docs-mintlify/admin/deployment/encryption-keys.mdx index 81f8292df3e26..82c460ba9ca41 100644 --- a/docs-mintlify/admin/deployment/encryption-keys.mdx +++ b/docs-mintlify/admin/deployment/encryption-keys.mdx @@ -5,7 +5,7 @@ description: "The Encryption Keys page in Cube Cloud allows to manage data-at-re -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). Also requires the M [Cube Store Worker tier](/admin/account-billing/pricing#cube-store-worker-tiers). diff --git a/docs-mintlify/admin/deployment/infrastructure.mdx b/docs-mintlify/admin/deployment/infrastructure.mdx index 9b1f7d4ba06f0..bb31ed3d1d936 100644 --- a/docs-mintlify/admin/deployment/infrastructure.mdx +++ b/docs-mintlify/admin/deployment/infrastructure.mdx @@ -79,7 +79,7 @@ processing highly critical business or personal information. -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). @@ -100,7 +100,7 @@ on a platform of choice (AWS/Azure/GCP) and managed by the Cube Cloud Control Pl -Available on the [Enterprise Premier plan](https://cube.dev/pricing). +Available on the [Enterprise plan](https://cube.dev/pricing). diff --git a/docs-mintlify/admin/deployment/limits.mdx b/docs-mintlify/admin/deployment/limits.mdx index 30998d1bb5f91..1641332a90b72 100644 --- a/docs-mintlify/admin/deployment/limits.mdx +++ b/docs-mintlify/admin/deployment/limits.mdx @@ -24,18 +24,18 @@ Each limit can be of one of the following types: The following resources are subject to limits, depending on [deployment types][ref-deployment-types] and [product tiers][ref-pricing]: -| Resource | Free Tier | Starter | Premium | Enterprise | Enterprise Premier | -| ----------------------------------------------------------------------------------- | :-------: | :-------: | :-------: | :--------: | :---------------------------: | -| Number of deployments | 2 | Unlimited | Unlimited | Unlimited | Unlimited | -| Number of API instances per deployment | 1 | 10 | 10 | 10 | [Contact us][cube-contact-us] | -| Number of Cube Store workers per deployment | 2 | 16 | 16 | 32 | [Contact us][cube-contact-us] | -| Queries per day for each [development instance][ref-dev-instance] | 1,000 | 10,000 | Unlimited | Unlimited | Unlimited | -| Queries per day for each [production cluster][ref-prod-cluster] | — | 50,000 | Unlimited | Unlimited | Unlimited | -| [Query History][ref-query-history] — retention period | 1 day | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | -| [Query History][ref-query-history] — queries processed per day for each deployment | 1,000 | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | -| [Audit Log][ref-audit-log] — retention period | — | — | — | — | 30 days | -| [Audit Log][ref-audit-log] — events collected | — | — | — | — | 10,000 | -| [Monitoring Integrations][ref-monitoring-integrations] — exported data | — | Depends on the [tier][ref-monitoring-integrations-tiers] | Depends on the [tier][ref-monitoring-integrations-tiers] | Depends on the [tier][ref-monitoring-integrations-tiers] | Depends on the [tier][ref-monitoring-integrations-tiers] | +| Resource | Free Tier | Starter | Premium | Enterprise | +| ----------------------------------------------------------------------------------- | :-------: | :-------: | :-------: | :--------: | +| Number of deployments | 2 | Unlimited | Unlimited | Unlimited | +| Number of API instances per deployment | 1 | 10 | 10 | [Contact us][cube-contact-us] | +| Number of Cube Store workers per deployment | 2 | 16 | 16 | [Contact us][cube-contact-us] | +| Queries per day for each [development instance][ref-dev-instance] | 1,000 | 10,000 | Unlimited | Unlimited | +| Queries per day for each [production cluster][ref-prod-cluster] | — | 50,000 | Unlimited | Unlimited | +| [Query History][ref-query-history] — retention period | 1 day | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | +| [Query History][ref-query-history] — queries processed per day for each deployment | 1,000 | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | +| [Audit Log][ref-audit-log] — retention period | — | — | — | 30 days | +| [Audit Log][ref-audit-log] — events collected | — | — | — | 10,000 | +| [Monitoring Integrations][ref-monitoring-integrations] — exported data | — | Depends on the [tier][ref-monitoring-integrations-tiers] | Depends on the [tier][ref-monitoring-integrations-tiers] | Depends on the [tier][ref-monitoring-integrations-tiers] | ### Number of deployments diff --git a/docs-mintlify/admin/deployment/vpc/aws/vpc-peering.mdx b/docs-mintlify/admin/deployment/vpc/aws/vpc-peering.mdx index daf0b4ad88b81..7a2ee388b9806 100644 --- a/docs-mintlify/admin/deployment/vpc/aws/vpc-peering.mdx +++ b/docs-mintlify/admin/deployment/vpc/aws/vpc-peering.mdx @@ -108,7 +108,7 @@ timeouts. If you are experiencing connection issues, please check the following: ## Using dedicated pre-aggregation storage -On the Enterprise Premier product tier, you get an option to supply your own S3 bucket to +On the Enterprise product tier, you get an option to supply your own S3 bucket to be used as an underlying storage for Cube Store pre-aggregated data. This allows you to keep all data at-rest fully within your infrastructure while still leveraging the full power of the Cube Cloud for managed compute. diff --git a/docs-mintlify/admin/monitoring/audit-log.mdx b/docs-mintlify/admin/monitoring/audit-log.mdx index 404537335cb12..093ea9b6d52d1 100644 --- a/docs-mintlify/admin/monitoring/audit-log.mdx +++ b/docs-mintlify/admin/monitoring/audit-log.mdx @@ -9,36 +9,19 @@ record of activity for compliance purposes. -Available on the [Enterprise Premier plan](https://cube.dev/pricing). -You can also choose an [Audit Log tier](/admin/account-billing/pricing#audit-log-tiers). +Available on the [Enterprise plan](https://cube.dev/pricing). Read below about [collected events](#event-types). Also, see how you can [enable](#configuration) Audit Log, [view events](#viewing-events), and [download](#downloading-events) them. -