Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .cursor/rules/docs-example-data-model.mdc
Original file line number Diff line number Diff line change
@@ -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
16 changes: 1 addition & 15 deletions docs-mintlify/admin/account-billing/pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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_
Expand Down Expand Up @@ -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
Expand Down
22 changes: 1 addition & 21 deletions docs-mintlify/admin/account-billing/support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
[ref-enterprise-tier]: /admin/account-billing/pricing#enterprise
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ applications, ingesting data from [Apache Kafka](https://kafka.apache.org).

<Info>

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.

</Info>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ data warehouse.

<Info>

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.

</Info>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ high-throughput transactions (inserts and upserts) and low-latency analytics.

<Info>

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.

</Info>
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/deployment/byoc/aws/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ the customer infrastructure on AWS and managed by the Cube Cloud Control Plane v

<Info>

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.

</Info>
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/deployment/byoc/aws/privatelink.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Cube Cloud BYOC deployments on AWS support private connectivity for Cube API end

<Info>

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.

</Info>
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/deployment/byoc/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on a platform of choice (AWS/Azure/GCP) and managed by the Cube Cloud Control Pl

<Info>

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.

</Info>
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/deployment/encryption-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "The Encryption Keys page in Cube Cloud allows to manage data-at-re

<Info>

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).

</Info>
Expand Down
4 changes: 2 additions & 2 deletions docs-mintlify/admin/deployment/infrastructure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ processing highly critical business or personal information.

<Info>

Available on the [Enterprise Premier plan](https://cube.dev/pricing).
Available on the [Enterprise plan](https://cube.dev/pricing).

</Info>

Expand All @@ -100,7 +100,7 @@ on a platform of choice (AWS/Azure/GCP) and managed by the Cube Cloud Control Pl

<Info>

Available on the [Enterprise Premier plan](https://cube.dev/pricing).
Available on the [Enterprise plan](https://cube.dev/pricing).

</Info>

Expand Down
24 changes: 12 additions & 12 deletions docs-mintlify/admin/deployment/limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/deployment/vpc/aws/vpc-peering.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
32 changes: 1 addition & 31 deletions docs-mintlify/admin/monitoring/audit-log.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,19 @@ record of activity for compliance purposes.

<Info>

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).

</Info>

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.

<iframe
width="100%"
height="400"
src="https://www.youtube.com/embed/W7hQzLS3wPc"
title="YouTube video"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
/>

## Configuration

To enable Audit Log, navigate to the **Team & Security** page, open the
**Audit Log** tab, and turn the **Enable Audit Log** switch on.

<Info>

If you choose to disable Audit Log, your account will be billed for using it until the
end of the month.

</Info>

## Viewing events

### Table view
Expand All @@ -49,19 +32,13 @@ Audit Log displays events in a table with the following information for each eve
- Event name (see [event types](#event-types) for the full list).
- Deployment name, if applicable to a particular event.

<Frame>
<img src="https://ucarecdn.com/93cec1af-4307-402e-826e-930f39626071/" />
</Frame>

### Extended view

You can click on any event to view extended information:
- IP address from which an event was initiated.
- Event-specific attributes.

<Frame>
<img src="https://ucarecdn.com/43f0d225-0cde-40dd-867b-8705f3ee0ff2/" />
</Frame>

#### Sanitization

Expand All @@ -79,18 +56,11 @@ You can also customize the table view with filters on the top and in the right s
- Date range filter.
- Filters to narrow the view down to a specific user, event, or deployment.

<Frame>
<img src="https://ucarecdn.com/794dcf79-4268-46ad-8077-f2675dede9d0/" />
</Frame>

## Downloading events

You can use the **↓ CSV** button to download a CSV file with all events in the
current view:

<Frame>
<img src="https://ucarecdn.com/794dcf79-4268-46ad-8077-f2675dede9d0/" />
</Frame>

## Exporting events via API

Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/cube-core/running-in-production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ Store operations.

<Info>

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).

</Info>
Expand Down
Loading
Loading