@bonnard/cli 0.2.7 → 0.2.9

package/dist/docs/topics/workflow.query.md

@@ -1,198 +0,0 @@
-# Query
-
-> Query your deployed semantic layer using the Bonnard REST API. Send JSON query objects or SQL strings to retrieve measures and dimensions with filtering, grouping, and time ranges.
-
-## Overview
-
-After deploying with `bon deploy`, you can query the semantic layer using `bon query`. This tests that your cubes and views work correctly and returns data from your warehouse through Bonnard.
-
-## Query Formats
-
-Bonnard supports two query formats:
-
-### JSON Format (Default)
-
-The JSON format uses the REST API structure:
-
-```bash
-bon query '{"measures": ["orders.count"]}'
-
-bon query '{
-  "measures": ["orders.total_revenue"],
-  "dimensions": ["orders.status"],
-  "filters": [{
-    "member": "orders.created_at",
-    "operator": "inDateRange",
-    "values": ["2024-01-01", "2024-12-31"]
-  }]
-}'
-```
-
-**JSON Query Properties:**
-
-| Property | Description |
-|----------|-------------|
-| `measures` | Array of measures to calculate (e.g., `["orders.count"]`) |
-| `dimensions` | Array of dimensions to group by (e.g., `["orders.status"]`) |
-| `filters` | Array of filter objects |
-| `timeDimensions` | Time-based grouping with granularity |
-| `segments` | Named filters defined in cubes |
-| `limit` | Max rows to return |
-| `offset` | Skip rows (pagination) |
-| `order` | Sort specification |
-
-**Filter Operators:**
-
-| Operator | Use Case |
-|----------|----------|
-| `equals`, `notEquals` | Exact match |
-| `contains`, `notContains` | String contains |
-| `startsWith`, `endsWith` | String prefix/suffix |
-| `gt`, `gte`, `lt`, `lte` | Numeric comparison |
-| `inDateRange`, `beforeDate`, `afterDate` | Time filtering |
-| `set`, `notSet` | NULL checks |
-
-### SQL Format
-
-The SQL format uses the SQL API, where cubes are tables:
-
-```bash
-bon query --sql "SELECT status, MEASURE(count) FROM orders GROUP BY 1"
-
-bon query --sql "SELECT
-  city,
-  MEASURE(total_revenue),
-  MEASURE(avg_order_value)
-FROM orders
-WHERE status = 'completed'
-GROUP BY 1
-ORDER BY 2 DESC
-LIMIT 10"
-```
-
-**SQL Syntax Rules:**
-
-1. **Cubes/views are tables** — `FROM orders` references the `orders` cube
-2. **Dimensions are columns** — Include in `SELECT` and `GROUP BY`
-3. **Measures use `MEASURE()`** — Or matching aggregates (`SUM`, `COUNT`, etc.)
-4. **Segments are boolean** — Filter with `WHERE is_completed IS TRUE`
-
-**Examples:**
-
-```sql
--- Count orders by status
-SELECT status, MEASURE(count) FROM orders GROUP BY 1
-
--- Revenue by city with filter
-SELECT city, SUM(amount) FROM orders WHERE status = 'shipped' GROUP BY 1
-
--- Using time dimension with granularity
-SELECT DATE_TRUNC('month', created_at), MEASURE(total_revenue)
-FROM orders
-GROUP BY 1
-ORDER BY 1
-```
-
-## CLI Usage
-
-```bash
-# JSON format (default)
-bon query '{"measures": ["orders.count"]}'
-
-# SQL format
-bon query --sql "SELECT MEASURE(count) FROM orders"
-
-# Limit rows
-bon query '{"measures": ["orders.count"], "dimensions": ["orders.city"]}' --limit 10
-
-# JSON output (instead of table)
-bon query '{"measures": ["orders.count"]}' --format json
-```
-
-## Output Formats
-
-### Table Format (Default)
-
-```
-┌─────────┬───────────────┐
-│ status  │ orders.count  │
-├─────────┼───────────────┤
-│ pending │ 42            │
-│ shipped │ 156           │
-│ done    │ 892           │
-└─────────┴───────────────┘
-```
-
-### JSON Format
-
-```bash
-bon query '{"measures": ["orders.count"]}' --format json
-```
-
-```json
-[
-  { "orders.status": "pending", "orders.count": 42 },
-  { "orders.status": "shipped", "orders.count": 156 },
-  { "orders.status": "done", "orders.count": 892 }
-]
-```
-
-## Common Patterns
-
-### Time Series Analysis
-
-```bash
-bon query '{
-  "measures": ["orders.total_revenue"],
-  "timeDimensions": [{
-    "dimension": "orders.created_at",
-    "granularity": "month",
-    "dateRange": ["2024-01-01", "2024-12-31"]
-  }]
-}'
-```
-
-### Filtering by Dimension
-
-```bash
-bon query '{
-  "measures": ["orders.count"],
-  "dimensions": ["orders.city"],
-  "filters": [{
-    "member": "orders.status",
-    "operator": "equals",
-    "values": ["completed"]
-  }]
-}'
-```
-
-### Multiple Measures
-
-```bash
-bon query '{
-  "measures": ["orders.count", "orders.total_revenue", "orders.avg_order_value"],
-  "dimensions": ["orders.category"]
-}'
-```
-
-## Error Handling
-
-### Common Errors
-
-**"Projection references non-aggregate values"**
-- All dimensions must be in `GROUP BY`
-- All measures must use `MEASURE()` or matching aggregate
-
-**"Cube not found"**
-- Check cube name matches deployed cube
-- Run `bon deploy` if cubes changed
-
-**"Not logged in"**
-- Run `bon login` first
-
-## See Also
-
-- [workflow.deploy](workflow.deploy) - Deploy before querying
-- [cubes.measures](cubes.measures) - Define measures
-- [cubes.dimensions](cubes.dimensions) - Define dimensions
-- [views](views) - Create focused query interfaces

package/dist/docs/topics/workflow.validate.md

@@ -1,125 +0,0 @@
-# Validate
-
-> Run validation checks on your cubes and views before deploying to catch YAML syntax errors, missing references, circular joins, and other issues. Use `bon validate` from the CLI.
-
-## Overview
-
-The `bon validate` command checks your YAML cubes and views for syntax errors and schema violations. Run this before deploying to catch issues early.
-
-## Usage
-
-```bash
-bon validate
-```
-
-## What Gets Validated
-
-### YAML Syntax
-
-- Valid YAML format
-- Proper indentation
-- Correct quoting
-
-### Schema Compliance
-
-- Required fields present (name, type, sql)
-- Valid field values (known measure types, relationship types)
-- Consistent naming conventions
-
-### Reference Integrity
-
-- Referenced cubes exist
-- Referenced members exist
-- Join relationships are valid
-
-## Example Output
-
-### Success
-
-```
-✓ Validating YAML syntax...
-✓ Checking bonnard/cubes/orders.yaml
-✓ Checking bonnard/cubes/users.yaml
-✓ Checking bonnard/views/orders_overview.yaml
-
-All cubes and views valid.
-```
-
-### Errors
-
-```
-✗ Validating YAML syntax...
-
-bonnard/cubes/orders.yaml:15:5
-  error: Unknown measure type "counts"
-
-  Did you mean "count"?
-
-  14:   measures:
-  15:     - name: order_count
-  16:       type: counts  <-- here
-  17:       sql: id
-
-1 error found.
-```
-
-## Common Errors
-
-### Missing Required Field
-
-```yaml
-# Error: "sql" is required
-measures:
-  - name: count
-    type: count
-    # Missing: sql: id
-```
-
-### Invalid Type
-
-```yaml
-# Error: Unknown dimension type "text"
-dimensions:
-  - name: status
-    type: text    # Should be: string
-    sql: status
-```
-
-### Reference Not Found
-
-```yaml
-# Error: Cube "user" not found (did you mean "users"?)
-joins:
-  - name: user
-    relationship: many_to_one
-    sql: "{CUBE}.user_id = {user.id}"
-```
-
-### YAML Syntax
-
-```yaml
-# Error: Bad indentation
-measures:
-- name: count  # Should be indented
-  type: count
-```
-
-## Exit Codes
-
-| Code | Meaning |
-|------|---------|
-| 0 | All validations passed |
-| 1 | Validation errors found |
-
-## Best Practices
-
-1. **Run before every deploy** — `bon validate && bon deploy`
-2. **Add to CI/CD** — validate on pull requests
-3. **Fix errors first** — don't deploy with validation errors
-4. **Test connections** — connections are tested automatically during `bon deploy`
-
-## See Also
-
-- workflow
-- workflow.deploy
-- syntax