@malloydata/malloyyo 0.2.53 → 0.2.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.js +101 -130
  2. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -7,7 +7,7 @@ import { resolve as resolve4 } from "node:path";
7
7
  // src/config.ts
8
8
  import { readFileSync, existsSync } from "node:fs";
9
9
  import { join } from "node:path";
10
- var KNOWN_KEYS = /* @__PURE__ */ new Set(["analytics", "targets", "image_hosts", "test_givens"]);
10
+ var KNOWN_KEYS = /* @__PURE__ */ new Set(["analytics", "targets", "image_hosts"]);
11
11
  function isTarget(v) {
12
12
  return typeof v === "object" && v !== null && typeof v.url === "string";
13
13
  }
@@ -215,7 +215,7 @@ var contentFiles = {
215
215
  "explore/restricted-queries.md": "# Restricted Query Explanation\n\nThe `query` tool runs your Malloy against a **published model**. You have that\nmodel's entire published surface to work with \u2014 and you can build on it. The\nmodel is an inentionally curated subset of the data available in the\ndatabase.\n\n## You can\n\n- Use everything the model defines: its **sources, dimensions, measures, views,\n joins, and named queries**. `describe_source` shows exactly what's there.\n- **Run a named query and refine it** \u2014\n `run: top_carriers + { where: dep_year = 2024 }`.\n- **Define your own** dimensions, measures, and **your own sources and joins** \u2014\n as long as they are *derived from the model's sources*. You are not limited to\n the author's fields; compose new ones from them.\n- Reference the model's `$NAME` givens and supply values via the `givens` map on\n the `query` call (use `execute: false` to discover which a query needs).\n- Use a model field that was itself defined with raw SQL \u2014 the author vouched\n for the model's own definitions.\n\n## What is \"Restricted\"\n\nIf you see `restricted-construct-forbidden`, the query used something that\nreaches *outside* the published model: pulling in another file (`import`),\nopening a raw connection (`connection.table(...)` / `connection.sql(...)`),\nwriting raw SQL (`name!type(...)` or the `sql_*` functions), declaring new\n`given:`s, or setting `##!` compiler flags.\n\nThe fix is never to work around it \u2014 express the answer in terms of what the\nmodel publishes (define derived sources, joins, dimensions, and measures from\nthe model's sources). If something fundamental is missing, that's feedback for\nthe model's author.\n",
216
216
  "language/malloy-language-reference.md": '<!-- Copied from malloy-cli (jrtipton/malloy-cli) skills/malloy-language-reference.md on 2026-06-11.\n Deliberate temporary fork \u2014 converge when the engine is extracted to @malloydata. -->\n---\ndescription: Malloy language reference \u2014 concepts, syntax, compilation model. Load this before writing or reviewing Malloy code.\n---\n# Malloy Language Reference\n\nMalloy is a semantic data modeling and query language. It compiles to SQL and runs against existing database engines (DuckDB, BigQuery, Snowflake, PostgreSQL, MySQL, Trino, Presto). It is not a SQL wrapper or abstraction layer \u2014 it has its own type system, scoping rules, expression semantics, and compilation pipeline.\n\nMalloy is designed around how humans think about data, not how data computations are mechanically accomplished. SQL is oriented around the machine \u2014 you specify joins, group-by columns, subqueries, and window functions in terms of what the database needs to do. Malloy is oriented around the analyst \u2014 you describe relationships, name computations, and compose questions in terms of what the data means. Malloy bridges the gap between these two by compiling the human-oriented description into correct, efficient SQL.\n\nA core design principle is that **most queries are themselves designing a new semantic model.** Formulating a question about data \u2014 choosing what to group by, what to aggregate, what to nest \u2014 is inherently an act of defining a new way to look at that data. Malloy is built around this idea: the output of every query is not just a result set but a new source with its own schema, and data comprehension is an ongoing iterative process where later stages want not only the data from a previous stage but how that data came into being. This is why query output carries metadata, why queries can be used as sources, and why views and pipelines compose naturally.\n\n## Documents and Statements\n\nA Malloy file (`.malloy`) is a sequence of statements, optionally separated by semicolons. There are five statement types:\n\n- **`import`** \u2014 import sources and queries from another `.malloy` file\n- **`source:`** \u2014 define a named, reusable data source with its schema and extensions\n- **`query:`** \u2014 define a named query (source + view) for reuse\n- **`run:`** \u2014 execute a query (the "do it now" statement)\n- **`given:`** \u2014 declare model-level parameters supplied at run time (experimental, see Givens)\n\n```malloy\nimport "shared_model.malloy"\n\nsource: flights is duckdb.table(\'flights.parquet\') extend {\n measure: flight_count is count()\n}\n\nquery: carrier_summary is flights -> {\n group_by: carrier\n aggregate: flight_count\n}\n\nrun: carrier_summary\n```\n\nComments use `//` or `--` (both are line comments).\n\n## Sources\n\nA **source** is anything you can hand a SQL database and get a schema back \u2014 a table name, a SQL SELECT, or the output of another Malloy query. The columns in that schema become the source\'s initial fields (all dimensions).\n\n```malloy\nsource: flights is duckdb.table(\'flights.parquet\')\nsource: limited is duckdb.sql("""SELECT * FROM flights LIMIT 100""")\nsource: carrier_facts is carrier_summary -- a query used as a source\n```\n\nWhat makes sources central to Malloy is **extension**. The `extend` block lets you layer on dimensions, measures, views, joins, filters, primary keys, field restrictions, and renames. These extensions travel with the source \u2014 any query against it gets them for free.\n\n```malloy\nsource: flights is duckdb.table(\'flights.parquet\') extend {\n primary_key: id\n\n dimension: distance_km is distance * 1.609344\n\n measure:\n flight_count is count()\n total_distance is sum(distance)\n\n join_one: carriers with carrier\n join_one: origin_airport is airports on origin_airport.code = origin\n\n where: dep_time > @2001\n\n view: by_carrier is {\n group_by: carrier\n aggregate: flight_count, total_distance\n }\n}\n```\n\nSources can extend other sources, creating a refinement chain:\n\n```malloy\nsource: ca_flights is flights extend {\n where: origin.state = \'CA\'\n}\n```\n\nField access control uses `accept:` (allowlist) or `except:` (denylist) to restrict which inherited columns are visible. Fields can be renamed with `rename: new_name is old_name`.\n\n## Joins\n\nJoins are declared in the source, not reconstructed in every query. This is a fundamental design difference from SQL: the graph structure of your data is a property of the model.\n\n```malloy\njoin_one: carriers with carrier -- FK \u2192 PK shorthand\njoin_one: origin_airport is airports on origin_airport.code = origin -- explicit ON\njoin_many: line_items on line_items.order_id = id -- one-to-many\njoin_cross: other_table on other_table.key = key -- cross join\n```\n\n- `join_one` \u2014 the joined source has at most one row per source row (many-to-one or one-to-one)\n- `join_many` \u2014 the joined source has potentially many rows per source row\n- `join_cross` \u2014 a full cross product\n\nThe `with` shorthand requires the joined source to have a declared `primary_key`. All joins are left outer by default. There is no right join \u2014 Malloy\'s graph model doesn\'t need one.\n\n**Choosing `join_one` vs `join_many`:** Ask "for a single row in the base source, can the joined source match more than one row?" If yes \u2192 `join_many`. If no (or at most one) \u2192 `join_one`. The common mistake is reaching for `join_many` when joining a *lookup or summary table* (e.g., joining an inventory snapshot to a purchase history on a wine key). Even though the joined table may have many rows overall, if each base row resolves to *at most one* joined row, use `join_one`. Use `join_many` only when the join genuinely fans out the base rows \u2014 e.g., joining line items to orders, or notes to a wine catalog.\n\nWhen you reference a joined source\'s fields, you use dot notation: `carriers.nickname`, `origin_airport.state`. This is one of Malloy\'s most important abstractions: **the access path to nested data is identical regardless of how the nesting is physically stored.** An array of records embedded in a column, a `join_many` to a separate table, a record-typed column \u2014 all are navigated with the same dot notation. The SQL required to traverse these different physical arrangements varies wildly (unnesting arrays, LEFT JOINs, correlated subqueries, ARRAY_AGG), but Malloy hides all of that. You think about the logical shape of your data \u2014 "flights have carriers, carriers have a nickname" \u2014 and write `carriers.nickname`. The compiler figures out what SQL is needed to get there. This means you can restructure your physical schema (normalize a nested array into a separate table, or denormalize a joined table into a record column) without changing any of the Malloy that references that data.\n\n## Fields\n\nMalloy has four kinds of fields: **dimensions**, **measures**, **views**, and **calculations**.\n\n### Dimensions\n\nScalar expressions \u2014 they compute a value per row. All columns inherited from a table are dimensions. Computed dimensions reference other dimensions or columns:\n\n```malloy\ndimension: full_name is concat(first_name, \' \', last_name)\ndimension: is_long_haul is distance > 1000\n```\n\n### Measures\n\nAggregate expressions \u2014 they compute a value across a set of rows. A field is a measure when its defining expression contains an aggregate function (`count`, `sum`, `avg`, `min`, `max`):\n\n```malloy\nmeasure:\n flight_count is count()\n total_distance is sum(distance)\n avg_distance is avg(distance)\n pct_delayed is count() { where: dep_delay > 30 } / count()\n```\n\n**`count(expr)` counts distinct values.** Unlike SQL\'s `COUNT(DISTINCT expr)`, Malloy uses `count(expr)` for distinct counting. The `count(distinct expr)` form is a deprecated syntax that will produce an error. Use `count()` for total row count, `count(field)` for distinct values of that field:\n\n```malloy\naggregate:\n total_rows is count() -- all rows\n unique_carriers is count(carrier) -- distinct carriers\n```\n\nMeasures can be filtered inline with `{ where: ... }`, which is how you build things like "percent of flights delayed" without subqueries.\n\n### Views\n\nA view is a query saved into the source \u2014 a reusable transformation:\n\n```malloy\nview: by_carrier is {\n group_by: carrier\n aggregate: flight_count, total_distance\n limit: 10\n}\n```\n\nViews can reference other views from the same source as a starting point, and can be extended with `+`.\n\n### Calculations\n\nWindow functions over the grouped result. Calculations can only be defined in a query stage with `calculate:`, never in a source definition, because they depend on the output columns of the query:\n\n```malloy\nrun: flights -> {\n group_by: carrier\n aggregate: flight_count\n calculate: carrier_rank is rank()\n}\n```\n\n## Queries and Views\n\nA query pairs a source with a view (the transformation). Everything after the first `->` is the view.\n\n```malloy\nrun: flights -> {\n group_by: carrier\n aggregate: flight_count\n}\n```\n\n### Reduction vs. Projection\n\nEach stage of a view performs exactly one of:\n\n- **Reduction** \u2014 uses `group_by:` and/or `aggregate:` to reduce grain. Analogous to `SELECT ... GROUP BY` in SQL.\n- **Projection** \u2014 uses `select:` to pick fields without aggregation. Analogous to `SELECT` without `GROUP BY`.\n\nThese cannot be mixed in a single stage. A stage with `group_by:` cannot have `select:`, and vice versa.\n\n### Source-level definitions vs. query-level operations\n\nThe same `name is expression` syntax defines fields in both sources and queries:\n\n```malloy\n-- In a source (reusable):\nsource: flights is ... extend {\n measure: flight_count is count() -- defines a measure in the model\n}\n\n-- In a query (ad hoc):\nrun: flights -> {\n aggregate: flight_count is count() -- defines the same measure inline\n}\n```\n\nWhen used in a source, `measure:` and `dimension:` are **definition statements** \u2014 they add named fields to the source\'s schema. When used in a query, `group_by:`, `aggregate:`, `select:`, `nest:`, and `calculate:` are **query operations** \u2014 they specify what the query does. The field definitions are syntactically identical in both contexts, but the enclosing keyword determines the role:\n\n| Source keyword | Query keyword | What it holds |\n|---|---|---|\n| `dimension:` | `group_by:` or `select:` | scalar expressions |\n| `measure:` | `aggregate:` | aggregate expressions |\n| `view:` | `nest:` | sub-queries |\n| _(n/a)_ | `calculate:` | window functions |\n\nThis is why `measure` and `aggregate` are separate keywords. `measure:` is a *modeling* statement \u2014 "this source has a reusable aggregate computation called X." `aggregate:` is a *query* statement \u2014 "in this query, include these aggregate values in the output." A query\'s `aggregate:` can reference a previously defined measure by name, or define one inline. The distinction parallels the separation between defining a dimension in a source and using it via `group_by:` in a query.\n\n### Multi-stage Pipelines\n\nStages chain with `->`. Each stage\'s output becomes the next stage\'s source:\n\n```malloy\nrun: flights -> {\n group_by: carrier\n aggregate: flight_count is count()\n} -> {\n where: flight_count > 1000\n select: *\n}\n```\n\n### Refinement with `+`\n\nThe refinement operator `+` merges query operations together. It works both within a view and at the top level on a named query:\n\n```malloy\n-- Refining a view within a query:\nrun: flights -> by_carrier + { limit: 5 } + { nest: by_destination }\n\n-- Refining a named query at the top level:\nrun: carrier_summary + { group_by: origin } -- add origin grouping to existing query\n```\n\nWhen a dimension name appears as a bare reference, it expands to `{ group_by: name }`. A measure name expands to `{ aggregate: name }`:\n\n```malloy\nrun: flights -> carrier + flight_count + { limit: 10 }\n-- equivalent to: flights -> { group_by: carrier; aggregate: flight_count; limit: 10 }\n```\n\nFor multi-stage queries, refinement semantics get more complex \u2014 but for single-stage queries, `+` straightforwardly merges operations into the stage.\n\n### Nesting\n\n`nest:` embeds an aggregating subquery inside a reduction. Each row of the outer query gets a subtable from the nested query. Nests can nest arbitrarily deep:\n\n```malloy\nrun: flights -> {\n group_by: carrier\n aggregate: flight_count\n nest: top_routes is {\n group_by: origin, destination\n aggregate: flight_count\n limit: 3\n }\n}\n```\n\n### Other query operations\n\n- **`where:`** \u2014 filter rows (pre-aggregation). Comma-separated filters are ANDed.\n- **`having:`** \u2014 filter groups (post-aggregation), like SQL\'s HAVING.\n- **`limit:`** / **`order_by:`** \u2014 limit and sort output.\n- **`extend`** \u2014 add fields or joins to a source inline within a query expression.\n\n## Aggregate Locality (Symmetric Aggregates)\n\nThis is one of Malloy\'s most important features. In SQL, when you join tables and aggregate, you risk double-counting (the "fan trap"). Malloy solves this with **aggregate locality** \u2014 you specify *where in the join graph* an aggregation should be computed.\n\n```malloy\nrun: flights -> {\n aggregate:\n -- avg seats weighted by number of flights (locality: source, i.e. flights)\n avg_seats_per_flight is source.avg(aircraft.aircraft_models.seats)\n -- avg seats per aircraft model (locality: aircraft_models)\n avg_seats_per_model is aircraft.aircraft_models.seats.avg()\n}\n```\n\nThree syntactic forms:\n\n- `avg(expr)` \u2014 aggregate at the current source (implicit locality)\n- `joined_source.avg(expr)` \u2014 aggregate at the specified join point (explicit locality)\n- `joined_source.field.avg()` \u2014 shorthand for aggregating the field at its parent source\n\nFor `sum` and `avg` (asymmetric aggregates), when the expression crosses a join boundary, Malloy *requires* explicit locality \u2014 it won\'t silently give you a wrong answer. For `min`, `max`, and `count` (symmetric), locality doesn\'t change the result, so implicit is always fine.\n\nMalloy implements this with a technique called **symmetric aggregates** \u2014 it internally de-duplicates rows based on primary keys at the appropriate join level, so aggregations are always mathematically correct regardless of join fan-out.\n\n## Ungrouped Aggregates\n\n`all()` and `exclude()` allow computing aggregates at different grouping levels within a single query:\n\n```malloy\nrun: airports -> {\n group_by: state, faa_region\n aggregate:\n airport_count is count()\n total_airports is all(count()) -- ungrouped: total across all rows\n region_airports is all(count(), faa_region) -- grouped only by faa_region\n pct_of_total is count() / all(count())\n}\n```\n\n`all(expr)` removes all grouping. `all(expr, dim1, dim2)` keeps only the specified grouping dimensions. `exclude(expr, dim)` removes the specified dimension from grouping.\n\n**Important:** `all(expr, dim)` takes the **local alias name** as defined in the query\'s `group_by:`, not a dotted path. If you want to partition by a joined field, alias it first:\n\n```malloy\n-- WRONG: all(count(), director.primaryName) -- dot paths don\'t work here\n-- RIGHT:\nrun: movies -> {\n group_by: director is director.primaryName -- alias it\n aggregate:\n movies is count()\n director_total is all(count(), director) -- reference the alias\n pct is count() / all(count(), director)\n}\n```\n\n## Expressions\n\nMalloy expressions include arithmetic, comparison, logical operators, function calls, type casts, and several Malloy-specific forms.\n\n### Evaluation Spaces\n\nEvery expression has an evaluation space: **literal**, **constant**, **input**, or **output**. Input expressions reference source columns/dimensions. Output expressions reference the results of the current query stage (used in `calculate:`). Some functions constrain their arguments \u2014 e.g., `lag(expr)` requires an output expression, `avg(expr)` requires an input expression.\n\n### Application and Partial Comparison\n\nThe `?` operator applies a condition to a value. Partial comparisons are conditions without a left-hand side:\n\n```malloy\nwhere: state ? \'CA\' | \'NY\' -- state is \'CA\' or \'NY\'\nwhere: distance ? > 500 & < 2000 -- distance between 500 and 2000\n```\n\n`|` is alternation (OR), `&` is conjunction (AND) within partials.\n\n### Pick Expressions\n\nMalloy\'s equivalent of CASE:\n\n```malloy\ndimension: size_bucket is\n pick \'short\' when distance < 500\n pick \'medium\' when distance < 1500\n else \'long\'\n```\n\n### Filtered Aggregate Expressions\n\nAny aggregate can be filtered inline:\n\n```malloy\nmeasure: ca_flights is count() { where: origin.state = \'CA\' }\n```\n\n### Type Casting\n\n```malloy\ntotal_distance::string -- Malloy type cast\nname::"VARCHAR(32)" -- database-native type cast\n```\n\n### Time Literals and Ranges\n\n```malloy\n@2003 -- the year 2003\n@2003-Q2 -- second quarter of 2003\n@2024-01-15 10:30:00 -- timestamp literal\ndep_time ? @2003 to @2005 -- range comparison\nnow -- current timestamp\n```\n\n## Data Types\n\nMalloy\'s type system: `string`, `number`, `boolean`, `date`, `timestamp`, `timestamptz`, `json`, and `sql native` (for unsupported database types). Compound types: `type[]` for arrays, `{ name :: type, ... }` for records, nesting arbitrarily: `{ x :: number, tags :: string[] }[]`.\n\n## Annotations and Tags\n\nThese are related but distinct concepts.\n\n### Annotations\n\nAnnotations are **text strings** attached to objects during compilation. They are metadata \u2014 they never affect query execution or SQL generation. An annotation starts with `#` and continues to end of line:\n\n```malloy\n# bar_chart\nview: by_carrier is { ... }\n```\n\n- `#` annotations attach to the next object defined below them\n- `##` annotations attach to the model (the file)\n- Block annotations use `#|` ... `|#` for multi-line content (closing delimiter must match the column position of the opener)\n\nAnnotations distribute over definition lists:\n\n```malloy\n# currency\nmeasure: -- all three measures get the # currency annotation\n revenue is sum(amount)\n # percent -- this measure also gets # percent\n margin is revenue / cost\n cost is sum(amount)\n```\n\n### Tags (a use of annotations)\n\nTags are the primary *consumer* of annotation strings. They interpret annotation text using a structured property language (MOTLY). The key distinction: **annotations are the transport mechanism (raw strings attached to objects), tags are the interpretation layer (parsed key-value properties).**\n\nNot all annotations are tags. An annotation is just text. Tags are annotations that happen to be written in the tag property language and parsed by an application.\n\n### Annotation prefixes (routing)\n\nThe character(s) immediately after `#` route the annotation to different consumers:\n\n- `# ` (hash-space) \u2014 renderer tags, parsed by the Malloy VS Code extension for visualization (`# bar_chart`, `# line_chart`, `# shape_map`; `# link { url_template="https://\u2026/$$" }` turns a field\'s cell into a clickable deep link \u2014 `$$` is the cell value, `field=other` links on a different (often `# hidden`) field; `# image { url_template=\u2026 }` renders it as an image)\n- `##!` \u2014 compiler directives (e.g., `##! experimental.parameters`, `##! experimental.givens`)\n- `#"` \u2014 reserved for documentation strings\n- `#(appName)` \u2014 application-specific tags (e.g., `#(docs) hidden`)\n\n```malloy\n# bar_chart size=large -- renderer tag: tells VS Code how to render\n##! experimental.parameters -- compiler tag: enables a feature flag\n#(myApp) priority=high -- custom app tag: ignored by renderer/compiler\n```\n\n### Tag property syntax\n\n```\ntName -- boolean flag (exists = true)\ntName=value -- set property value\ntName=[a, b, c] -- array value\ntName: { p1=v1 p2=v2 } -- nested properties (replaces)\ntName { p1=v1 } -- nested properties (merges)\n-tName -- delete a property\ntName.sub.path=value -- deep path assignment\n```\n\nValues can be unquoted identifiers, quoted strings, numbers, or typed values prefixed with `@` (`@true`, `@false`, `@2024-01-15`).\n\n## Givens (Model-Level Parameters)\n\n**Status: experimental, gated by `##! experimental.givens`.** Naming is provisional.\n\nGivens are values supplied at run time that the model can reference in any expression. The motivating use case is row-level access control \u2014 a model written once with `where: x.tenant_id = $TENANT` and the tenant supplied per API call \u2014 but they also fit configuration values, session context, and any "one compiled model, many invocations with varying context" pattern.\n\nGivens are model-wide: a single namespace, one value per name per compilation. They are *complementary to* source/query parameters (`source: foo(x :: string) is ...`), not a replacement. Use a parameter when you want two differently-bound copies of the same source side-by-side in one model; use a given when you want one value visible everywhere in the compilation.\n\n### Declaration\n\nThe `given:` top-level statement introduces givens, with a name, a type, and an optional default:\n\n```malloy\ngiven:\n TENANT :: string\n MAX_ROWS :: number is 1000\n CUTOFF_DATE :: date is @2024-01-01\n```\n\nType can be any Malloy atomic type or compound type, including `filter<T>`:\n\n```malloy\ngiven:\n ROLE :: string\n ALLOWED_ROLES :: string[]\n SESSION :: { user_id :: string, tenant :: string }\n TENANT_FILTER :: filter<string>\n```\n\nDefaults are expressions over constants and other givens. Annotations attach to given declarations the same way they attach to sources or measures.\n\n### Reference: the `$` sigil\n\nInside any expression, a given is referenced with a leading `$`:\n\n```malloy\nsource: orders_for_user is orders extend {\n where: orders.tenant_id = $TENANT\n}\n\nquery: recent_orders is orders_for_user -> {\n where: order_date >= $CUTOFF_DATE\n limit: $MAX_ROWS\n}\n```\n\n`$` appears *only* at expression references. The other three sites where a given\'s name appears \u2014 declaration, import, and supply (caller side) \u2014 use the bare name, because syntactic position already disambiguates. Givens share the top-level declaration namespace with sources/queries/views, so `source: x is ...` plus `given: x :: string` is a name-conflict error.\n\n### Set membership: `expr in $arrayGiven`\n\nThe RHS of `in` is either a parenthesized list of expressions (`in (1, 2, x, y * 7)`, same as SQL) or a given with an array value (`in $ARR`). A bare array-typed expression \u2014 a dimension, a joined array field, an inline `[a, b, c]` literal \u2014 is *not* legal on the RHS; arrays only reach the RHS via the given form.\n\nWhen a given has array type, `expr in $ARR` tests `expr` against the runtime-bound array; `not in $ARR` is the negation. The left-hand side must match the array\'s element type (`string in $string[]`, `number in $number[]`, etc.); mismatches are translate-time errors. Records and nested arrays are out of scope.\n\n```malloy\ngiven:\n ALLOWED_STATES :: string[]\n URGENT_STATUSES :: string[]\n\nsource: orders extend {\n where: state in $ALLOWED_STATES\n dimension: is_urgent is order_status in $URGENT_STATUSES\n}\n```\n\nAt SQL emit, the array\'s contents land in a generated `IN (...)` clause. Empty or `null` arrays collapse to the obvious result (`IN` \u2192 `FALSE`, `NOT IN` \u2192 `TRUE`). NULL elements inside a non-empty array follow standard SQL `IN` semantics.\n\nTo derive a value from an array \u2014 typically a boolean gate \u2014 *without* the array itself reaching row-position SQL, use an inline given (below).\n\n### Inline givens\n\nAn `inline` given is evaluated at **bind time**, before SQL is emitted: its default expression runs against the resolved given values and reduces to a literal, and that literal is what reaches SQL.\n\n```malloy\ngiven:\n CAPABILITIES :: string[]\n inline CAN_READ_ORDERS :: boolean is \'read_orders\' in $CAPABILITIES\n inline CAN_MUTATE :: boolean\n is \'write_orders\' in $CAPABILITIES or \'admin\' in $CAPABILITIES\n\nsource: orders extend {\n where: $CAN_READ_ORDERS -- SQL sees: WHERE ... AND TRUE (or FALSE)\n}\n```\n\nThis is the **row-level access-control gate** pattern: the host supplies a capability list as a regular given, an inline given derives a boolean from it, and only the boolean \u2014 not the list \u2014 crosses into row-position SQL. The query planner sees a constant predicate.\n\nRules:\n\n- An inline given **must** have a default. `inline FOO :: number` with no `is` clause is a translate-time error.\n- The default may use:\n - Boolean and comparison operators: `and`, `or`, `not`, `=`, `!=`, `<`, `<=`, `>`, `>=`\n - The `in $array` test against another given\n - Literals (string, number, boolean, null, array) and references to other givens\n- The default cannot call SQL functions, reference fields, or use any operator outside that list. Disallowed operators are reported at translate time with the offending operator names.\n- Inline givens are filtered out of `Model.givens` and `PreparedQuery.givens` \u2014 they\'re computed, not supplied \u2014 so introspection-driven UIs don\'t render editors for them. A caller can still shadow one by binding it explicitly (useful in tests).\n- `inline` is a context-sensitive modifier, not a reserved keyword: fields, sources, views, dimensions, and joins can still be named `inline`.\n\n### Imports\n\nGivens behave like every other top-level named thing under import:\n\n- **Bare import** (`import "b.malloy"`) brings B\'s full export surface in, including all of B\'s givens, under their original names.\n- **Selective import** (`import { source1 } from "b.malloy"`) brings in only what\'s listed. To surface a given to your callers, list it: `import { source1, MAX_ROWS } from "b.malloy"`.\n- **Rename** uses the existing `LOCAL is REMOTE` form: `import { CAP is MAX_ROWS } from "b.malloy"`.\n\nSurfacing controls *who can supply a value*, not whether internal references work. An imported source can reference a given the importer didn\'t surface; the reference still resolves internally, and at run time the unsurfaced given relies on its declaration-site default.\n\nA common project convention is a shared `tenant_givens.malloy` (declaring `$TENANT`, `$USER_ROLE`, etc.) that every root file bare-imports on line 1, so the project\'s given contract is visible at the top of any model.\n\n### Satisfiability\n\nA query referencing `$X` is satisfiable if either `$X` is in the model\'s namespace (so a caller can supply a value) or `$X` has a default at its declaration site. Otherwise the query is unsatisfiable and errors. Latent definitions (views, dimensions, measures) that reference `$X` are fine if no query actually invokes them \u2014 satisfiability is a property of running queries.\n\n### Supplying values\n\nValues can be supplied at two layers, which compose (per-query overrides per-runtime):\n\n**Per-runtime** \u2014 bound to a `Runtime`, applied as defaults to every query through it. Two paths:\n\n1. **`givensPath` in `malloy-config.json`** points at a JSON file of `name \u2192 value`:\n ```jsonc\n { "givensPath": "./local-givens.json" }\n // or env-var indirection (resolved at config load):\n { "givensPath": { "env": "GAME_STORE_GIVENS" } }\n ```\n The values file is a flat JSON map, keys are caller-facing surface names:\n ```jsonc\n { "TENANT": "acme", "USER_ROLE": "admin", "CUTOFF_DATE": "2024-01-01" }\n ```\n\n2. **Direct on the Runtime constructor** (for per-request multi-tenant servers, tests, scripts):\n ```typescript\n const runtime = new Runtime({\n config,\n givens: { TENANT: claims.tenant_id, USER_ROLE: claims.role },\n urlReader,\n });\n ```\n Constructor values *merge over* the file at `givensPath` per-key.\n\n**Per-query** \u2014 supplied on a single `.run({ givens: ... })` call:\n```typescript\nawait query.run({ givens: { STATE_FILTER: "CA", LIMIT_OVERRIDE: 50 } })\n```\nAvailable on every compile-or-run entry point (`runtime.loadQuery(...).run(options)`, `preparedQuery.getPreparedResult(options)`, `preparedQuery.getSQL(options)`).\n\nThe resolved per-runtime values are exposed on `runtime.givens` (read-only) for diagnostics.\n\n### Finalized givens (security primitive)\n\nA multi-tenant deployment usually wants `TENANT`/`USER_ROLE`/`REGION` to be runtime-bound and **un-overridable per-query** \u2014 otherwise a downstream endpoint that accidentally accepts user-controlled query params and plumbs them into `.run({ givens: ... })` becomes a tenant-leak vulnerability.\n\n`finalizeGivens` in the config locks names at the API surface:\n\n```jsonc\n{\n "givensPath": { "env": "GAME_STORE_GIVENS" },\n "finalizeGivens": ["TENANT", "USER_ROLE", "REGION"]\n}\n```\n\nFinalize doesn\'t change *what* a given resolves to \u2014 only *who* can supply it. A `.run({ givens: { TENANT: ... } })` for a finalized name throws at API entry (named, not silently dropped). Finalized givens are filtered out of `Model.givens` and `PreparedQuery.givens` so introspection-driven UIs don\'t render editors for locked names.\n\n### JS shapes for supplied values\n\nBoth the JSON values file and per-query `givens` maps accept the same per-type shapes:\n\n| Malloy type | JS |\n|---|---|\n| `string` | string |\n| `number` | `number`, `bigint`, or string (precision escape hatch) |\n| `boolean` | boolean |\n| `date` | ISO date string `"2024-01-15"` |\n| `timestamp` (naive) | ISO string without offset \u2014 *not* a JS `Date` |\n| `timestamptz` | JS `Date` or ISO string with offset (string preferred \u2014 makes TZ choice visible) |\n| `T[]` | JS array |\n| `{ name :: T, ... }` | JS object |\n| `filter<T>` | JS string (Malloy filter expression source) |\n\nNaive timestamp givens reject `Date` because `Date` represents a UTC instant, not a wall-clock value, and `new Date("2001-01-01T00:00:00")` silently picks up the system\'s local TZ. Type mismatches throw at the boundary with a path that points at the offending location (e.g., `givens.SESSION.user_id: expected string, got number`). `null` is legal for any given type.\n\n### Introspection\n\n`Model.givens` and `PreparedQuery.givens` expose, to the host, the supplyable givens \u2014 for whole-model parameter editors and per-query "run this" forms respectively. Each entry carries name, type, default expression (or undefined if the caller must supply), location, and access to declaration-site annotations via `tagParse`/`getTaglines`.\n\n## How a Malloy Query Becomes SQL\n\nThe compilation pipeline has two phases:\n\n### Phase 1: Translation (source code \u2192 IR)\n\n```\nMalloy source \u2192 ANTLR lexer/parser \u2192 parse tree \u2192 AST builder \u2192 AST \u2192 IR generator \u2192 IR\n```\n\nThe **Intermediate Representation (IR)** is a plain, serializable data structure (JSON-compatible) that fully describes the semantic model and query. Note that IR is *not* dialect-agnostic \u2014 the same Malloy source compiled against different databases can produce different IR, because schema information, type mappings, and available functions vary by backend. It can be cached, transmitted, and reused. Key IR types:\n\n- **`SourceDef`** \u2014 a source\'s complete definition: schema, fields, joins, filters\n- **`Query`** \u2014 a source paired with a pipeline of operations\n- **`FieldDef`** \u2014 definition of any field (dimension, measure, join, calculation)\n- **`Expr`** \u2014 expression tree (arithmetic, comparisons, aggregates, function calls, field references)\n\nThe translator handles all language-level semantics: scoping, name resolution, type checking, evaluation space validation.\n\n### Phase 2: Compilation (IR \u2192 SQL)\n\n```\nIR \u2192 query compiler \u2192 expression compiler \u2192 dialect-specific SQL generator \u2192 SQL + metadata\n```\n\nThe compiler walks the IR query pipeline, translating each stage into SQL constructs (CTEs, subqueries, GROUP BY, window functions). A **Dialect** layer handles database-specific SQL generation.\n\nThe compiler also produces **metadata** alongside the SQL \u2014 structural information needed to interpret the result set (column types, nesting structure, annotation data). This metadata is what allows Malloy renderers to reconstruct nested/hierarchical results from the flat SQL result set and apply visualization tags.\n\n### Key architectural consequences\n\n- Because the IR is serializable, it can be cached and reused across compilations (though IR is database-specific \u2014 the same source compiled against different backends may produce different IR).\n- Because joins are declared in the source (not the query), the compiler knows the full join graph and can compute symmetric aggregates correctly.\n- Because nested queries are first-class, the compiler generates the appropriate SQL (correlated subqueries or ARRAY_AGG patterns depending on dialect) automatically.\n- Because measures are typed as aggregates in the IR, the compiler can validate that they only appear in aggregate context and enforce locality rules.\n\n## Where to Go Deeper\n\nThis document is a conceptual reference \u2014 enough to reason about the language and its design, but not exhaustive. Here\'s where to find more detail.\n\n### Language Documentation\n\nThe full docs live at [https://docs.malloydata.dev](https://docs.malloydata.dev). Key pages by topic:\n\n| Topic | URL |\n|---|---|\n| Sources, extensions, joins, primary keys | [documentation/language/source](https://docs.malloydata.dev/documentation/language/source) |\n| Queries, views, reduction vs projection | [documentation/language/query](https://docs.malloydata.dev/documentation/language/query), [views](https://docs.malloydata.dev/documentation/language/views) |\n| Fields: dimensions, measures, views, calculations | [documentation/language/fields](https://docs.malloydata.dev/documentation/language/fields) |\n| Aggregate functions and aggregate locality | [documentation/language/aggregates](https://docs.malloydata.dev/documentation/language/aggregates) |\n| Ungrouped aggregates (`all`, `exclude`) | [documentation/language/ungrouped-aggregates](https://docs.malloydata.dev/documentation/language/ungrouped-aggregates) |\n| Nested views / aggregating subqueries | [documentation/language/nesting](https://docs.malloydata.dev/documentation/language/nesting) |\n| Joins | [documentation/language/join](https://docs.malloydata.dev/documentation/language/join) |\n| Expressions, operators, pick, apply | [documentation/language/expressions](https://docs.malloydata.dev/documentation/language/expressions) |\n| Evaluation spaces (literal, constant, input, output) | [documentation/language/eval_space](https://docs.malloydata.dev/documentation/language/eval_space) |\n| Filters and filter placement | [documentation/language/filters](https://docs.malloydata.dev/documentation/language/filters) |\n| Annotations and tags | [documentation/language/tags](https://docs.malloydata.dev/documentation/language/tags) |\n| Calculations and window functions | [documentation/language/calculations_windows](https://docs.malloydata.dev/documentation/language/calculations_windows) |\n| Data types | [documentation/language/datatypes](https://docs.malloydata.dev/documentation/language/datatypes) |\n| Time operations, ranges, timezones | [documentation/language/timestamp-operations](https://docs.malloydata.dev/documentation/language/timestamp-operations), [time-ranges](https://docs.malloydata.dev/documentation/language/time-ranges), [timezones](https://docs.malloydata.dev/documentation/language/timezones) |\n| Imports | [documentation/language/imports](https://docs.malloydata.dev/documentation/language/imports) |\n| Top-level statements and model structure | [documentation/language/statement](https://docs.malloydata.dev/documentation/language/statement) |\n| Functions reference | [documentation/language/functions](https://docs.malloydata.dev/documentation/language/functions) |\n\n### Examples and Patterns\n\nThe docs site includes worked examples of common analytical patterns at [documentation/patterns](https://docs.malloydata.dev/documentation/patterns/): percent-of-total, year-over-year, cohort analysis, sessionization, moving averages, nested subtotals, and more.\n\nEnd-to-end guides are at [documentation/user_guides](https://docs.malloydata.dev/documentation/user_guides/), including [Malloy by Example](https://docs.malloydata.dev/documentation/user_guides/malloy_by_example) (a comprehensive walkthrough) and a three-part series for SQL users ([part 1](https://docs.malloydata.dev/documentation/user_guides/sql_experts1), [part 2](https://docs.malloydata.dev/documentation/user_guides/sql_experts2), [part 3](https://docs.malloydata.dev/documentation/user_guides/sql_experts3)).\n\n### Source Code\n\nThe Malloy implementation lives at [github.com/malloydata/malloy](https://github.com/malloydata/malloy). Key entry points:\n\n| What | Where |\n|---|---|\n| ANTLR grammar (lexer + parser) | `packages/malloy/src/lang/grammar/` |\n| AST node hierarchy | `packages/malloy/src/lang/ast/` |\n| Parse tree \u2192 AST builder | `packages/malloy/src/lang/malloy-to-ast.ts` |\n| IR type definitions | `packages/malloy/src/model/malloy_types.ts` |\n| IR \u2192 SQL compiler | `packages/malloy/src/model/` |\n| Dialect-specific SQL generation | `packages/malloy/src/dialect/` |\n| Tag/annotation parsing (MOTLY) | `packages/malloy-tag/` |\n| Renderer | `packages/malloy-render/` |\n| Architecture overview | `CONTEXT.md` (root and in each package) |\n',
217
217
  "language/pick.md": "---\ndescription: pick expressions \u2014 Malloy's CASE/if-then-else\n---\n\n`pick` is Malloy's equivalent of SQL `CASE WHEN`. Each branch is its own\n`pick` keyword; the `else` clause catches the remainder.\n\nThere are two forms of pick. In the first the `when` expression is any\nboolean expression.\n\n```malloy\n pick 'Female' when upper(first_name) in ('JENNIFER', 'ELIZABETH', 'AMY', 'JESSICA')\n pick 'Male' when upper(first_name) in ('JAMES', 'JOHN', 'ROBERT', 'MICHAEL')\n else 'Unknown'\n```\n\n## Example usage in a query\n\n```malloy\nrun: payments -> {\n group_by: tier is\n pick 'high' when total_amount > 10000\n pick 'medium' when total_amount > 1000\n else 'low'\n aggregate: payment_count is count()\n}\n```\n\n## Common mistakes\n\n- **Every branch needs its own `pick` keyword** \u2014 there is no `when \u2026 then`:\n ```malloy\n -- WRONG:\n pick 'a' when x = 1 'b' when x = 2 else 'c'\n\n -- RIGHT:\n pick 'a' when x = 1\n pick 'b' when x = 2\n else 'c'\n ```\n\n- **`else` is required** when the branches don't cover all cases \u2014 omitting it\n returns `null` for unmatched rows.\n",
218
- "language/who-is-asking.md": "---\ndescription: Per-user data with $MALLOYYO_EMAIL \u2014 the reserved given this server fills from the signed-in user, how to declare it, and how to run the model locally\n---\n\n# Who is asking \u2014 `$MALLOYYO_EMAIL`\n\nA model can scope what a query returns to the person running it. Declare the\nreserved given, then use it like any other:\n\n```malloy\n##! experimental.givens\ngiven:\n MALLOYYO_EMAIL :: string is ''\n\nsource: orders is duckdb.table('orders.parquet') extend {\n where: owner_email = $MALLOYYO_EMAIL\n}\n```\n\nEvery query against that model \u2014 the `query` tool, a dashboard tile, a saved\nquery, an ltool link \u2014 binds it to the signed-in user's address. Nothing else\nchanges: no per-user models, no filtered copies, no query rewriting.\n\n**The declaration is the opt-in.** A model that does not declare it is\nuntouched, because supplying a given a model never declared is an error in\nMalloy rather than a no-op.\n\n## What a caller cannot do\n\nA caller may not set it. A `givens: { \"MALLOYYO_EMAIL\": \"someone@else.com\" }`\non a `query` call, a dashboard's `?MALLOYYO_EMAIL=` URL, a value baked into a\ncomponent \u2014 all dropped before the query compiles, and the signed-in address\nbound instead. That is the whole point of the feature; do not design around it.\n\nFor the same reason it is not offered as a filter: `query(execute:false)` does\nnot list it among the givens to supply, and a dashboard renders no control for\nit.\n\n## The `MALLOYYO_` prefix is reserved\n\n`MALLOYYO_EMAIL` is the only one that exists. Declaring any other\n`MALLOYYO_*` given is refused at publish \u2014 the prefix means \"a value this\nserver vouches for\", and a `$MALLOYYO_ROLE` the server does not fill would read\nas though it did. Name your own givens anything else.\n\n## Running it locally\n\nLocally there is no one asking, so the declaration default applies and a\ntenant-scoped query comes back empty \u2014 which looks exactly like a broken\ndashboard. Put a stand-in in `malloy-config.json`:\n\n```json\n{\n \"malloyyo\": {\n \"test_givens\": { \"MALLOYYO_EMAIL\": \"you@example.com\" }\n }\n}\n```\n\n`malloyyo dashboard dev`, `malloyyo lint` and the CLI's own MCP server bind it\nthe way the server binds the real one, so what you see locally is what a reader\ngets. Change the address to see another tenant's view.\n\nThe block is **local only** \u2014 the server never reads it. It travels with the\nrepo, so if it were honored a repo could name any address and read that\nperson's rows.\n\n## Not `malloyyo dashboard bundle`\n\nA bundled site has no one asking, and cannot have: there is no server, the\nmodel source is inlined into the page, and DuckDB-WASM fetches the data in the\nreader's own browser. `test_givens` does not travel into it either \u2014 the\nbundler only introspects, and the reserved givens are filtered out of what it\nwrites. So a tenant-scoped dashboard bundles to a page that shows nothing.\n\nDo not answer that by loosening the default. `MALLOYYO_EMAIL :: filter<string>\nis f'\u2026'` with anything permissive publishes every row to every visitor, and the\nraw data is one fetch away regardless. **A model that filters by who is asking\nbelongs on an instance, not in a static bundle.**\n\n## Notes\n\n- Give it a default and make sure the default is the SAFE answer. Watch the\n type: `:: string is ''` matches no rows, which is right, but\n `:: filter<string> is f''` is an EMPTY FILTER, which matches EVERY row. The\n server refuses to run a query when it cannot supply the value (an account\n with no address, say) rather than let a default like that through \u2014 but the\n default is still what a local `dashboard dev` run and any non-server path\n will use, so write one that shows nothing.\n- Filtering belongs in the source (`extend { where: \u2026 }`), not in each query \u2014\n that way it holds for every query anyone writes against it, including ones\n an agent composes later.\n- It is a string, not a verified claim about identity beyond sign-in: it is the\n address the signed-in account carries.\n",
218
+ "language/who-is-asking.md": "---\ndescription: Per-user data with $MALLOYYO_EMAIL \u2014 the reserved given this server fills from the signed-in user, how to declare it, and how to run the model locally\n---\n\n# Who is asking \u2014 `$MALLOYYO_EMAIL`\n\nA model can scope what a query returns to the person running it. Declare the\nreserved given, then use it like any other:\n\n```malloy\n##! experimental.givens\ngiven:\n MALLOYYO_EMAIL :: string is ''\n\nsource: orders is duckdb.table('orders.parquet') extend {\n where: owner_email = $MALLOYYO_EMAIL\n}\n```\n\nEvery query against that model \u2014 the `query` tool, a dashboard tile, a saved\nquery, an ltool link \u2014 binds it to the signed-in user's address. Nothing else\nchanges: no per-user models, no filtered copies, no query rewriting.\n\n**The declaration is the opt-in.** A model that does not declare it is\nuntouched, because supplying a given a model never declared is an error in\nMalloy rather than a no-op.\n\n## What a caller cannot do\n\nA caller may not set it. A `givens: { \"MALLOYYO_EMAIL\": \"someone@else.com\" }`\non a `query` call, a dashboard's `?MALLOYYO_EMAIL=` URL, a value baked into a\ncomponent \u2014 all dropped before the query compiles, and the signed-in address\nbound instead. That is the whole point of the feature; do not design around it.\n\nFor the same reason it is not offered as a filter: `query(execute:false)` does\nnot list it among the givens to supply, and a dashboard renders no control for\nit.\n\n## The `MALLOYYO_` prefix is reserved\n\n`MALLOYYO_EMAIL` is the only one that exists. Declaring any other\n`MALLOYYO_*` given is refused at publish \u2014 the prefix means \"a value this\nserver vouches for\", and a `$MALLOYYO_ROLE` the server does not fill would read\nas though it did. Name your own givens anything else.\n\n## Running it locally\n\nLocally there is no one asking, so a tenant-scoped query would come back\nempty \u2014 which looks exactly like a broken dashboard. Set the address in the\nenvironment instead:\n\n```bash\nMALLOYYO_EMAIL=you@example.com malloyyo dashboard dev\n```\n\n`malloyyo lint` needs nothing: it compiles, it does not run. Anything that\nactually runs a query refuses without a value and names the variable, rather\nthan showing you an empty page to debug. Change the address to see another\ntenant's view.\n\nNothing about the identity is committed. On a server the value comes from\nwhoever is signed in; the environment is only the local stand-in, because a\nserver's environment is ONE value for every request and would hand every user\nthe same tenant.\n\n## Not `malloyyo dashboard bundle`\n\nA bundled site has no one asking, and cannot have: there is no server, the\nmodel source is inlined into the page, and DuckDB-WASM fetches the data in the\nreader's own browser. Nothing supplies the identity there \u2014 the bundler only\nintrospects, and no environment travels into a static page. So a tenant-scoped\ndashboard bundles to a page that shows nothing.\n\nDo not answer that by loosening the default. `MALLOYYO_EMAIL :: filter<string>\nis f'\u2026'` with anything permissive publishes every row to every visitor, and the\nraw data is one fetch away regardless. **A model that filters by who is asking\nbelongs on an instance, not in a static bundle.**\n\n## Notes\n\n- Give it a default and make sure the default is the SAFE answer. Watch the\n type: `:: string is ''` matches no rows, which is right, but\n `:: filter<string> is f''` is an EMPTY FILTER, which matches EVERY row. The\n server refuses to run a query when it cannot supply the value (an account\n with no address, say) rather than let a default like that through \u2014 but the\n default is still what a local `dashboard dev` run and any non-server path\n will use, so write one that shows nothing.\n- Filtering belongs in the source (`extend { where: \u2026 }`), not in each query \u2014\n that way it holds for every query anyone writes against it, including ones\n an agent composes later.\n- It is a string, not a verified claim about identity beyond sign-in: it is the\n address the signed-in account carries.\n",
219
219
  "site/auto-update.md": '# Auto-update a data site weekly\n\nAdd a scheduled GitHub Actions job that rebuilds the data and commits it, so the\npublished Pages site stays current on its own. Use this **after** the site works\n(built with `yo_help("site/data-site")`). If the data never changes, skip this.\n\nThe worked example is `malloydata/malloyyo-imdb` \u2014 fetch and read its\n`scripts/build_data.sh` and `.github/workflows/refresh-data.yml`; adapt, don\'t\ncopy blindly.\n\n## Precondition: one command that rebuilds the data\n\nThe whole thing rests on a single script that turns the source URL(s) into the\ncommitted parquet \u2014 the same script you\'d run by hand. Keep it linear so it\nreads as a recipe:\n\n```bash\n# scripts/build_data.sh\nset -euo pipefail\ncd "$(dirname "$0")/.."\nbash data/get.sh # 1. download source URLs -> data/\nrm -f data/build.duckdb\nmalloy-cli -c malloy-build.json build transform.malloy # 2. transform\necho "ATTACH \'data/build.duckdb\' AS b (READ_ONLY); -- 3. export -> docs/*.parquet\n COPY b.thing TO \'docs/thing.parquet\' (FORMAT parquet)" | malloyyo sql\n```\n\n(If you used Path A \u2014 direct \u2014 the whole script is just the one\n`echo "COPY (FROM read_..(\'https://\u2026\')) TO \'docs/\u2026\'" | malloyyo sql` command.\nNo `data/get.sh`, `malloy-build.json`, `malloy-cli`, or transform needed \u2014 and\nno standalone `duckdb` either, since `malloyyo sql` uses the embedded one.)\n\nGitignore the working files: `data/*.gz`, `data/*.duckdb`, `MANIFESTS/`.\n\n## The workflow\n\n`.github/workflows/refresh-data.yml`:\n\n```yaml\nname: refresh-data\non:\n schedule:\n - cron: "0 6 * * 0" # weekly, Sunday 06:00 UTC\n workflow_dispatch: # ...and on demand from the Actions tab\njobs:\n refresh:\n runs-on: ubuntu-latest\n permissions:\n contents: write # so the job can commit + push\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with: { node-version: "20" }\n # malloyyo carries its own DuckDB (`malloyyo sql`), so no duckdb CLI to install.\n # Add `@malloydata/cli` only for a `#@ persist` transform (malloy-cli build).\n - run: npm install -g @malloydata/malloyyo @malloydata/cli\n - uses: actions/setup-python@v5 # only if an enrichment step needs it\n with: { python-version: "3.12" }\n - name: Build data\n run: bash scripts/build_data.sh\n - name: Commit refreshed data\n run: |\n git config user.name github-actions\n git config user.email github-actions@github.com\n git add docs/*.parquet\n git commit -m "refresh data $(date -u +%F)" || exit 0 # unchanged = clean no-op\n git push\n```\n\n## Hard-won details (these came from a real first run)\n\n- **`git commit \u2026 || exit 0`** \u2014 an unchanged week means nothing new upstream.\n That is success, not a failed job.\n- **Secondary/enrichment steps must be best-effort.** If the build has a step\n that can fail independently (an external API lookup, an optional metadata\n enrichment) and it isn\'t essential to the data, mark it\n `continue-on-error: true`. Otherwise one flaky API call throws away an\n otherwise-good data refresh \u2014 the commit step never runs and the fresh parquet\n is lost. (In `malloyyo-imdb` this bit us: a poster-image lookup with a missing\n secret failed the whole job until it was made non-blocking.)\n- **Secrets** go in repo settings (Settings \u2192 Secrets and variables \u2192 Actions,\n or `gh secret set NAME`), referenced as `${{ secrets.NAME }}`. A step reading\n a secret that isn\'t set gets an empty string \u2014 pair that with best-effort.\n- **No re-bundle needed for data changes.** The dashboards fetch parquet at\n runtime, so committing fresh parquet updates the live site. Only install\n `@malloydata/malloyyo` and run `malloyyo dashboard bundle` in CI if the job\n also needs to regenerate the HTML (i.e. dashboard code changed \u2014 rare for a\n data refresh).\n- **Test before trusting the schedule.** Push, then Actions tab \u2192 the workflow \u2192\n **Run workflow** (that\'s `workflow_dispatch`). Or `gh workflow run\n refresh-data.yml`, then `gh run watch <id> --exit-status`.\n\n## Git growth, and the flatten\n\nEach committed refresh adds the full parquet to history (~its file size per\nrun). That is intentional simplicity, not a leak. When history gets too big,\nflatten it to a single commit by hand \u2014 **not** as part of the weekly job:\n\n```bash\ngit checkout --orphan flat && git add -A && git commit -m "flatten history"\ngit branch -M flat main && git push -f origin main\n```\n\nOnly do this on a repo you solely own (it force-pushes; other clones must\n`git reset --hard origin/main`). Run it as often or as rarely as you like.\nDocument this in the repo\'s README so future-you remembers it\'s available.\n\n## Done when\n\n- The workflow file is on the default branch (so `workflow_dispatch` shows up)\n- A manual run goes green end-to-end and commits fresh `docs/*.parquet`\n- The Pages site shows the new data\n',
220
220
  "site/data-site.md": '# Build a public data site from a web data pointer\n\nGoal: given one or more **public data URLs**, produce a **GitHub Pages site** of\ninteractive Malloy dashboards that anyone can open in a browser. The data ends\nup as parquet in `docs/`; the dashboards are static HTML that query it\nclient-side with DuckDB-WASM \u2014 so there is no server, no database to run.\n\nTwo reference repos \u2014 read them, they are the ground truth for structure:\n\n- **`malloydata/malloyyo-babynames`** \u2014 the clean base pattern (one model file,\n a few dashboards, `docs/`). Data is static.\n- **`malloydata/malloyyo-imdb`** \u2014 the same, plus a `transform.malloy` that\n cleans raw source files into parquet, plus a **weekly auto-refresh** (that\n part is `yo_help("site/auto-update")`).\n\nFetch either with `gh api repos/<repo>/git/trees/HEAD?recursive=1` and read the\nfiles you need. Match their layout rather than inventing your own.\n\n## The shape of a finished repo\n\n```\nmalloy-config.json connection(s): duckdb (local), optionally md/gs mirrors\nindex.malloy the EXPORT SURFACE \u2014 only what this file exports is live\n<model>.malloy sources, measures, joins, givens (parameters)\nstorage.malloy sources point at the parquet \u2014 docs-local OR an https URL\n (or gs.malloy / md.malloy) same source names, swappable hosting (step 3)\ndashboards/*.malloy the query behind each dashboard\ndashboards/*.jsx the dashboard layout (grid of charts/tables)\ndocs/ PUBLISHED SITE \u2014 bundled HTML (+ the *.parquet if docs-local)\n *.parquet the data, when hosted docs-local (committed; served by Pages)\n *.html .nojekyll written by `malloyyo dashboard bundle`\n.mcp.json written by `malloyyo init` (author-mode Claude)\n```\n\n## Prerequisites (install once)\n\n```bash\nnpm install -g @malloydata/malloyyo # the `malloyyo` command\n```\n\nThat\'s the whole toolchain for the common case. `malloyyo` has **DuckDB built\nin** \u2014 `malloyyo sql` runs SQL (read a URL, `COPY` to parquet) through it, so you\ndo **not** need a standalone `duckdb` CLI.\n\nAdd `@malloydata/cli` (`malloy-cli`) **only** if you do a heavier transform with\nMalloy `#@ persist` (see Path B in `yo_help("site/data-to-parquet")`):\n\n```bash\nnpm install -g @malloydata/cli # only for #@ persist transforms\n```\n\n## Recipe\n\nWork top to bottom. After each step, prove it before moving on.\n\n### 1. Scaffold\n\n```bash\nmkdir my-site && cd my-site && git init\nmalloyyo init # writes .mcp.json (author-mode Claude) + index.malloy stub\n```\n\nCreate `malloy-config.json` with a local DuckDB connection (this is what reads\nthe parquet):\n\n```json\n{ "connections": { "duckdb": { "is": "duckdb" } } }\n```\n\n### 2. Get the web data into `docs/*.parquet`\n\nThis is the one dataset-specific step. Two paths \u2014 pick the simpler one that\nworks. Full detail and copy-paste commands: **`yo_help("site/data-to-parquet")`**.\n\n- **Direct** (default): `malloyyo sql` reads the URL and writes parquet in one\n shot, through the embedded DuckDB:\n ```bash\n echo "COPY (FROM read_csv_auto(\'https://\u2026/thing.csv\')) TO \'docs/thing.parquet\'" | malloyyo sql\n ```\n Use when the web data is already close to what you want to show.\n- **Transform** (when you need to clean / join / rank / reshape): write a\n `transform.malloy` with `#@ persist` sources and build it with `malloy-cli`,\n then export the tables to `docs/*.parquet`. This is the `malloyyo-imdb`\n pattern.\n\nVerify: `malloyyo sql -e "DESCRIBE SELECT * FROM \'docs/thing.parquet\'"` and a\n`SELECT count(*)`.\n\n### 3. Write the model\n\nA storage file \u2014 one source per parquet file \u2014 that the rest of the model builds\non. **Where the parquet lives is a choice** (the two examples differ here):\n\n- **docs-local** (the `malloyyo-imdb` way) \u2014 parquet committed in `docs/`,\n served same-origin by Pages. Self-contained; git carries the data. Address it\n by project-relative path so the same spelling works locally and published:\n ```malloy\n // storage.malloy\n source: thing_table is duckdb.table(\'docs/thing.parquet\') extend {}\n ```\n- **External URL** (the `malloyyo-babynames` way \u2014 it uses `import "gs.malloy"`)\n \u2014 parquet hosted on GCS / a CDN / any https URL; `docs/` holds only the HTML,\n so git stays small. DuckDB-WASM fetches the URL at runtime:\n ```malloy\n // gs.malloy\n source: thing_table is duckdb.table(\'https://storage.googleapis.com/\u2026/thing.parquet\') extend {}\n ```\n\nKeep the **source names identical** across storage files (as babynames does with\n`gs.malloy` / `md.malloy`) so switching hosting is a one-line import change in\nthe model. Start docs-local (simplest); move to a URL if git growth bites.\n\n`<model>.malloy` \u2014 build real sources on top: primary keys, measures, joins,\nand **givens** (the parameters that become the dashboard\'s filter controls).\n`index.malloy` \u2014 re-export exactly the sources/queries/givens the dashboards\nuse. **Only what `index.malloy` exports is visible** to dashboards, `dashboard\ndev`, and the hosted app.\n\nGive each exported source a `#"` doc string. It\'s what `list_sources` shows the\nhosted app and any MCP client, and it\'s the only place to record the things a\nconsumer can\'t infer \u2014 which source answers which question, and any measure\nwhose meaning is subtle.\n\nFor Malloy modeling and givens specifics, lean on the author MCP rather than\nguessing: the repo\'s `.mcp.json` wires `mcp__malloyyo_author__*`. Call\n`mcp__malloyyo_author__compile` to check files and\n`mcp__malloyyo_author__yo_help` for topics (`develop/working-with-models`).\n\nThree shapes that compile, pass `lint`, and still produce a dashboard that looks\nright and isn\'t:\n\n- **A stage-level `where:` zeroes measures that carry their own filters.**\n `count() { where: status = \'Sold\' }` needs the sold rows to reach it; a\n `where: in_cellar` on the stage removes them first and the measure reads 0\n everywhere. Constrain the output with `having:` instead.\n- **Grouping finer than the fact scatters the counts.** Group by an attribute\n that only applies to some rows and the measures over the others split across\n groups and read near-zero. Pick the grain the question is asked at; if you\n need both, group at the coarser one and `nest:` the finer.\n- **Detail tables default to raw field names and bare numbers.** `exit_date` and\n `829.57`, and a null renders as `\u2205`. Tag them \u2014 `# label="Opened"`,\n `# label="Paid" currency` \u2014 and `coalesce(field, \'\')` where empty is\n meaningful rather than missing.\n\nAggregate locality is NOT one of these: Malloy\'s symmetric aggregates keep\nmeasures honest through a `join_many` fan-out, and it warns (or errors) rather\nthan silently answering when an `avg`/`sum` crosses a join without explicit\nlocality. `notes.rating.avg()` already averages at the notes grain; ask for\n`source.avg(notes.rating)` only when you want the fan-out-weighted number. See\n`yo_help language/aggregate-locality-symmetric-aggregates`.\n\n### 4. Author dashboards and preview live\n\nEach dashboard is **one self-contained `dashboards/<name>.malloy`** \u2014 the query,\nits filtering, and the tags that lay it out. The filename is the dashboard\'s\nname and URL slug.\n\n**A `.jsx` is OPTIONAL and most dashboards don\'t need one.** The default form \u2014\nan inline query tagged `# artifact` + `# dashboard { columns=6 }` \u2014 renders KPI\ntiles and a card grid with no React at all. Reach for a sibling\n`dashboards/<name>.jsx` only when you want bespoke layout or presentation the\ntags can\'t express (a hand-built card, a picker, a Vega chart).\n\nAuthor with the `malloyyo_author` MCP and its `yo_help` topics \u2014 **read these,\ndon\'t guess the API**: `dashboards/authoring` (the dashboard file),\n`dashboards/grid-layout` (colspans), `dashboards/charts` (chart tags and their\nchannel rules), `dashboards/givens-and-controls` (filters),\n`dashboards/custom-components` and `dashboards/vega-charts` (only if you add a\n`.jsx`).\n\nPreview in a browser with live reload:\n\n```bash\nmalloyyo dashboard dev # serves at http://localhost:4173\n```\n\nTwo things about `dashboard dev` worth knowing:\n\n- It runs the queries **server-side**, through the same local DuckDB the CLI\n uses \u2014 the browser only renders results. So it works without DuckDB-WASM or\n its CDN extensions, and it is the only way to see a custom component render\n against real data short of publishing.\n- It holds **one long-lived connection set with a warm schema cache** (a\n deliberate tradeoff \u2014 refetching schemas per compile reads like a hang on a\n warehouse). The file watcher hot-reloads your `.malloy` edits and re-discovers\n `# artifact` tags, but nothing invalidates that cache, so a change to the\n DATA\'s shape \u2014 a new column in a parquet \u2014 needs a restart. The tell is\n `\'<column>\' is not defined` in the browser while the CLI and `lint` are green.\n\nIterate here until the dashboards look right. **Look at every dashboard before\nyou call it done**: `malloyyo lint` compiles the dashboards against the model but\ndoes not render them, so it cannot see a chart that throws at render time, a\ncomponent whose CSS resolved to nothing, or a column of raw field names.\n`malloyyo test` previews what the hosted claude.ai app would see.\n\n### 5. Build the static site\n\n```bash\nmalloyyo dashboard bundle --out docs\n# optional: add analytics + a title\nmalloyyo dashboard bundle --out docs --title "My Site" --analytics G-XXXXXXXXXX\n```\n\n`bundle` writes the HTML, `.nojekyll`, and assets into `docs/`, next to the\nparquet from step 2. The pages fetch `./*.parquet` relative to the site root, so\nthe data must already be in `docs/` \u2014 always run the data step before bundling.\n\n### 6. Publish on GitHub Pages\n\nCommit `docs/` and turn on Pages (Settings \u2192 Pages \u2192 Deploy from a branch \u2192\n`main` / `docs`). Full steps + gotchas: **`yo_help("site/github-pages")`**.\n\n### 7. (Optional) Keep it fresh automatically\n\nIf the data comes from a URL that updates over time and you want the site to\ntrack it, add a weekly GitHub Actions refresh \u2014 see\n**`yo_help("site/auto-update")`** (worked example: `malloydata/malloyyo-imdb`).\n\n## Done when\n\n- `malloyyo sql -e "SELECT count(*) FROM \'docs/<file>.parquet\'"` returns real rows\n- `malloyyo lint` passes\n- **you have LOOKED at every dashboard** in `malloyyo dashboard dev` \u2014 each one\n renders with no console errors, every tile has data, and the labels read like\n English rather than column names. `lint` passing is not this; a dashboard can\n compile and still throw at render time.\n- `docs/` has the bundled `*.html` + `.nojekyll` alongside the parquet\n- the Pages URL loads and the dashboards populate (data fetch succeeds)\n',
221
221
  "site/data-to-parquet.md": '# Getting web data into `docs/*.parquet`\n\nThe site queries parquet files (in `docs/`, or at an https URL \u2014 see the model\nstep). This is how you turn a public data URL into that parquet. Pick the\nsimplest path that produces clean data.\n\n`malloyyo sql` runs SQL through malloyyo\'s **embedded DuckDB** \u2014 no standalone\n`duckdb` binary. It takes SQL from `-e`, `-f <file>`, or stdin, and runs against\na connection from `malloy-config.json` (default `duckdb`).\n\n## Path A \u2014 Direct (default)\n\nOne command reads the URL and writes parquet. Best when the web data is already\nclose to what you want to display.\n\n```bash\n# CSV / TSV\necho "COPY (SELECT * FROM read_csv_auto(\'https://example.com/data.csv\'))\n TO \'docs/data.parquet\' (FORMAT parquet)" | malloyyo sql\n\n# TSV, gzipped, tab-delimited, header row (IMDb-style)\necho "COPY (SELECT * FROM read_csv_auto(\'https://example.com/data.tsv.gz\',\n delim=\'\\t\', header=true, all_varchar=true))\n TO \'docs/data.parquet\' (FORMAT parquet)" | malloyyo sql\n\n# JSON / NDJSON\necho "COPY (SELECT * FROM read_json_auto(\'https://example.com/data.json\'))\n TO \'docs/data.parquet\' (FORMAT parquet)" | malloyyo sql\n\n# Already parquet on the web \u2014 just fetch it\ncurl -fsSL -o docs/data.parquet \'https://example.com/data.parquet\'\n```\n\nFor anything longer than a line or two, put the SQL in a file and run it with\n`-f`, so it\'s re-runnable and diffable:\n\n```bash\nmalloyyo sql -f scripts/build.sql # a file of ;-separated statements\n```\n\nNotes:\n- DuckDB autoloads `httpfs` for `https://` reads.\n- Keep only the columns/rows the dashboards need \u2014 `SELECT` the columns and add a\n `WHERE` to drop noise. Smaller parquet = faster page loads.\n- Cast types here if the source is all-strings: `col::INT`, `col::DOUBLE`, etc.\n\n## Path B \u2014 Transform with Malloy (when you need to reshape)\n\nUse when the data needs cleaning, joining across files, ranking, or nesting \u2014\nthe `malloydata/malloyyo-imdb` case. You write the transform once in Malloy;\n`malloy-cli build` materializes it; you export the tables to parquet. This path\nalso needs `@malloydata/cli` (`npm install -g @malloydata/cli`).\n\n**1. A build connection** \u2014 `malloy-build.json` (a DuckDB db just for building):\n\n```json\n{ "connections": { "build": { "is": "duckdb", "databasePath": "data/build.duckdb" } } }\n```\n\n**2. `transform.malloy`** \u2014 read the raw source(s) through the `build`\nconnection and mark each output source with `#@ persist name="\u2026"`:\n\n```malloy\n##! experimental.persistence experimental.virtual_source\n\nsource: raw is build.sql("""\n SELECT * FROM read_csv_auto(\'data/raw.csv.gz\', delim=\'\\t\', all_varchar=true, header=true)\n""")\n\n#@ persist name="thing"\nsource: thing_base is raw -> {\n where: some_count::number > 100\n select: id, name, value is value::number\n calculate: rank is rank() { order_by: value::number desc }\n}\n```\n\nDownload the raw files first (a `data/get.sh` that `wget`s the URLs into `data/`,\ngitignored). Gitignore `data/`, `data/*.duckdb`, and `MANIFESTS/`.\n\n**3. Build, then export the persisted tables to `docs/`** \u2014 the export still\ngoes through `malloyyo sql` (no standalone duckdb needed):\n\n```bash\nrm -f data/build.duckdb\nmalloy-cli -c malloy-build.json build transform.malloy # -> tables in build.duckdb\necho "ATTACH \'data/build.duckdb\' AS b (READ_ONLY);\n COPY b.thing TO \'docs/thing.parquet\' (FORMAT parquet)" | malloyyo sql\n```\n\nThe persist `name=` is the table name inside `build.duckdb`; the `COPY` names the\nserved file (they can differ \u2014 e.g. `thing` \u2192 `docs/mysite_thing.parquet`).\n\nWrap steps 1\u20133 in a single `scripts/build_data.sh` so it is one command, by hand\nand in CI. That\'s exactly what `yo_help("site/auto-update")` automates weekly.\n\n## Either way, verify\n\n```bash\nmalloyyo sql -e "DESCRIBE SELECT * FROM \'docs/thing.parquet\'"\nmalloyyo sql -e "SELECT count(*) FROM \'docs/thing.parquet\'"\n```\n\nThen point a storage source at it (docs-local shown; an https URL works too \u2014\nsee the model step in SKILL.md):\n\n```malloy\nsource: thing_table is duckdb.table(\'docs/thing.parquet\') extend {}\n```\n',
@@ -1051,34 +1051,17 @@ function modelCatalogEntry(model_ref, model) {
1051
1051
  if (sources.length) entry.sources = sources;
1052
1052
  return entry;
1053
1053
  }
1054
- function isHostsToFill(name, host) {
1055
- return name in host.values || host.reservedPrefix !== void 0 && name.startsWith(host.reservedPrefix);
1054
+ function unreferencedGivens(required, referenced) {
1055
+ if (required.length === 0) return [];
1056
+ const seen = new Set(referenced);
1057
+ return required.filter((name) => !seen.has(name)).sort();
1056
1058
  }
1057
- function resolveHostGivens(caller, host, declared) {
1058
- if (!host) return { ok: true, givens: caller };
1059
- const missing = [...declared].filter((n) => isHostsToFill(n, host) && !(n in host.values)).sort();
1060
- if (missing.length > 0) return { ok: false, missing };
1061
- const out = {};
1062
- for (const [k, v] of Object.entries(caller ?? {})) {
1063
- if (isHostsToFill(k, host)) continue;
1064
- out[k] = v;
1065
- }
1066
- for (const [k, v] of Object.entries(host.values)) {
1067
- if (declared.has(k)) out[k] = v;
1068
- }
1069
- return { ok: true, givens: Object.keys(out).length > 0 ? out : void 0 };
1070
- }
1071
- var HOST_GIVEN_UNAVAILABLE = "host-given-unavailable";
1072
- function missingHostGivensMessage(missing) {
1073
- return `${missing.join(", ")}: filled by the host, not by the query, and no value is available for this request. Refused rather than run on the declaration default, which may not be restrictive.`;
1059
+ function unreferencedGivensMessage(missing) {
1060
+ return `${missing.join(", ")}: this data is scoped by ${missing.length > 1 ? "these givens" : "this given"}, and the query never references ${missing.length > 1 ? "them" : "it"}. A query here must run against a source that filters on ${missing.length > 1 ? "them" : "it"} \u2014 put the filter on the source (\`source: x is \u2026 extend { where: owner = $${missing[0]} }\`) so every query over it carries the scope.`;
1074
1061
  }
1075
1062
  function declaredGivenNames(model) {
1076
1063
  return new Set(model.givens?.keys() ?? []);
1077
1064
  }
1078
- function withoutHostGivens(specs, host) {
1079
- if (!host) return [...specs];
1080
- return specs.filter((s) => !isHostsToFill(s.name, host));
1081
- }
1082
1065
  var MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
1083
1066
  var MIN_SAFE = -MAX_SAFE;
1084
1067
  function narrowBigint(value) {
@@ -1105,6 +1088,26 @@ var DEFAULT_ROW_LIMIT = 1e4;
1105
1088
  async function executeMaterialized(query, opts, loadProblems, decorate = (p) => p, uri) {
1106
1089
  const rowLimit = opts.rowLimit ?? DEFAULT_ROW_LIMIT;
1107
1090
  const retry = opts.retry ?? ((op) => op());
1091
+ if (opts.requireGivens && opts.requireGivens.length > 0) {
1092
+ try {
1093
+ const pq = await query.getPreparedQuery();
1094
+ const missing = unreferencedGivens(opts.requireGivens, pq.givens.keys());
1095
+ if (missing.length > 0) {
1096
+ return {
1097
+ ok: false,
1098
+ problems: [
1099
+ ...loadProblems,
1100
+ codeProblem("given-not-referenced", unreferencedGivensMessage(missing), uri)
1101
+ ]
1102
+ };
1103
+ }
1104
+ } catch (e) {
1105
+ return {
1106
+ ok: false,
1107
+ problems: [...loadProblems, errorProblem(e, uri)]
1108
+ };
1109
+ }
1110
+ }
1108
1111
  const compileOpts = opts.givens ? { givens: opts.givens } : void 0;
1109
1112
  try {
1110
1113
  const t0 = Date.now();
@@ -1142,12 +1145,10 @@ async function run(runtime, entry, opts = {}) {
1142
1145
  let materializer;
1143
1146
  let modelQueries;
1144
1147
  let loadProblems;
1145
- let declared;
1146
1148
  try {
1147
1149
  materializer = runtime.loadModel(entry);
1148
1150
  const model = await materializer.getModel();
1149
1151
  modelQueries = { named: [...model.queries().named], unnamed: model.queries().unnamed };
1150
- declared = declaredGivenNames(model);
1151
1152
  loadProblems = mapProblems(model.problems);
1152
1153
  } catch (e) {
1153
1154
  if (e instanceof MalloyError2) {
@@ -1201,17 +1202,7 @@ async function run(runtime, entry, opts = {}) {
1201
1202
  }
1202
1203
  query = materializer.loadFinalQuery();
1203
1204
  }
1204
- const merged = resolveHostGivens(opts.givens, opts.hostGivens, declared);
1205
- if (!merged.ok) {
1206
- return {
1207
- ok: false,
1208
- problems: [
1209
- ...loadProblems,
1210
- codeProblem(HOST_GIVEN_UNAVAILABLE, missingHostGivensMessage(merged.missing), entry.href)
1211
- ]
1212
- };
1213
- }
1214
- return executeMaterialized(query, { ...opts, givens: merged.givens }, loadProblems, (p) => p, entry.href);
1205
+ return executeMaterialized(query, opts, loadProblems, (p) => p, entry.href);
1215
1206
  }
1216
1207
  async function queryGivens(q) {
1217
1208
  try {
@@ -1225,7 +1216,7 @@ async function queryGivens(q) {
1225
1216
  return void 0;
1226
1217
  }
1227
1218
  }
1228
- async function validateRestricted(runtime, entry, query, opts = {}) {
1219
+ async function validateRestricted(runtime, entry, query) {
1229
1220
  let loadProblems;
1230
1221
  let materializer;
1231
1222
  try {
@@ -1248,8 +1239,8 @@ async function validateRestricted(runtime, entry, query, opts = {}) {
1248
1239
  out.sql = (await q.getSQL()).trim();
1249
1240
  } catch {
1250
1241
  }
1251
- const givens = withoutHostGivens(await queryGivens(q) ?? [], opts.hostGivens);
1252
- if (givens.length > 0) out.givens = givens;
1242
+ const givens = await queryGivens(q);
1243
+ if (givens) out.givens = givens;
1253
1244
  }
1254
1245
  return out;
1255
1246
  } catch (e) {
@@ -1262,11 +1253,9 @@ async function validateRestricted(runtime, entry, query, opts = {}) {
1262
1253
  async function runRestricted(runtime, entry, query, opts = {}) {
1263
1254
  let loadProblems;
1264
1255
  let materializer;
1265
- let declared;
1266
1256
  try {
1267
1257
  materializer = runtime.loadModel(entry);
1268
1258
  const model = await materializer.getModel();
1269
- declared = declaredGivenNames(model);
1270
1259
  loadProblems = mapProblems(model.problems);
1271
1260
  } catch (e) {
1272
1261
  if (e instanceof MalloyError3) {
@@ -1276,17 +1265,7 @@ async function runRestricted(runtime, entry, query, opts = {}) {
1276
1265
  }
1277
1266
  try {
1278
1267
  const q = materializer.loadRestrictedQuery(query);
1279
- const merged = resolveHostGivens(opts.givens, opts.hostGivens, declared);
1280
- if (!merged.ok) {
1281
- return {
1282
- ok: false,
1283
- problems: [
1284
- ...loadProblems,
1285
- codeProblem(HOST_GIVEN_UNAVAILABLE, missingHostGivensMessage(merged.missing), entry.href)
1286
- ]
1287
- };
1288
- }
1289
- return await executeMaterialized(q, { ...opts, givens: merged.givens }, loadProblems, (p) => p, entry.href);
1268
+ return await executeMaterialized(q, opts, loadProblems, (p) => p, entry.href);
1290
1269
  } catch (e) {
1291
1270
  if (e instanceof MalloyError3) {
1292
1271
  return { ok: false, problems: [...loadProblems, ...mapProblems(e.problems)] };
@@ -1364,7 +1343,7 @@ function describeGivenSpec(name, g) {
1364
1343
  }
1365
1344
  return spec;
1366
1345
  }
1367
- async function dashboardGivenSpecs(runtime, entry, runExpr, opts = {}) {
1346
+ async function dashboardGivenSpecs(runtime, entry, runExpr) {
1368
1347
  try {
1369
1348
  const mm = runtime.loadModel(entry);
1370
1349
  const pq = await mm.loadQuery(`run: ${runExpr}`).getPreparedQuery();
@@ -1372,7 +1351,7 @@ async function dashboardGivenSpecs(runtime, entry, runExpr, opts = {}) {
1372
1351
  for (const [name, g] of pq.givens) {
1373
1352
  specs.push(describeGivenSpec(name, g));
1374
1353
  }
1375
- return { ok: true, givens: withoutHostGivens(specs, opts.hostGivens) };
1354
+ return { ok: true, givens: specs };
1376
1355
  } catch (e) {
1377
1356
  return { ok: false, error: e instanceof Error ? e.message : String(e) };
1378
1357
  }
@@ -1704,13 +1683,13 @@ async function executeQuery(m, args, fix, result) {
1704
1683
  const givens = argRecord(args, "givens");
1705
1684
  const rowLimit = Math.max(1, Math.min(1e4, argOptNumber(args, "max_rows") ?? DEFAULT_ROW_LIMIT));
1706
1685
  if (!execute) {
1707
- const v = await validateRestricted(m.runtime, m.entry, malloy, { hostGivens: m.hostGivens });
1686
+ const v = await validateRestricted(m.runtime, m.entry, malloy);
1708
1687
  return { ...v, problems: v.problems.map(fix) };
1709
1688
  }
1710
1689
  const full = await runRestricted(m.runtime, m.entry, malloy, {
1711
1690
  rowLimit,
1712
1691
  givens,
1713
- hostGivens: m.hostGivens
1692
+ requireGivens: m.requireGivens
1714
1693
  });
1715
1694
  const budgeted = await applyResultBudget(full, result, { toolName: "query", args });
1716
1695
  return { ...budgeted, problems: budgeted.problems.map(fix) };
@@ -2381,38 +2360,25 @@ async function withConnectionDiagnostics(fn) {
2381
2360
  }
2382
2361
  }
2383
2362
 
2384
- // src/test-givens.ts
2363
+ // src/server-givens.ts
2385
2364
  var RESERVED_PREFIX = "MALLOYYO_";
2386
- function testGivensFromConfig(configJson) {
2387
- const out = { givens: {}, warnings: [] };
2388
- if (!configJson) return out;
2389
- let raw;
2390
- try {
2391
- raw = JSON.parse(configJson);
2392
- } catch {
2393
- return out;
2394
- }
2395
- const block = raw?.malloyyo?.test_givens;
2396
- if (block === void 0) return out;
2397
- if (typeof block !== "object" || block === null || Array.isArray(block)) {
2398
- out.warnings.push('malloy-config.json: "test_givens" must be an object of name \u2192 value.');
2399
- return out;
2400
- }
2401
- for (const [name, value] of Object.entries(block)) {
2402
- if (!name.startsWith(RESERVED_PREFIX)) {
2403
- out.warnings.push(
2404
- `test_givens: ignoring "${name}" \u2014 only ${RESERVED_PREFIX}* givens are filled by the server, so only those need a local stand-in. Give an ordinary given a default in its declaration, or set it per dashboard with \`# artifact { givens { \u2026 } }\`.`
2405
- );
2406
- continue;
2407
- }
2408
- if (typeof value !== "string" && typeof value !== "number" && typeof value !== "boolean") {
2409
- out.warnings.push(`test_givens: ignoring "${name}" \u2014 value must be a string, number or boolean.`);
2410
- continue;
2411
- }
2412
- out.givens[name] = value;
2365
+ function serverFilledNames(declared) {
2366
+ return [...declared].filter((n) => n.startsWith(RESERVED_PREFIX)).sort();
2367
+ }
2368
+ function readServerGivens(declared, env = process.env) {
2369
+ const out = { givens: {}, missing: [] };
2370
+ for (const name of serverFilledNames(declared)) {
2371
+ const value = env[name]?.trim();
2372
+ if (value) out.givens[name] = value;
2373
+ else out.missing.push(name);
2413
2374
  }
2414
2375
  return out;
2415
2376
  }
2377
+ function missingServerGivensMessage(missing) {
2378
+ const example = missing.map((n) => `${n}=${n.endsWith("_EMAIL") ? "you@example.com" : "\u2026"}`).join(" ");
2379
+ return `${missing.join(", ")}: filled by a Malloyyo server from whoever is signed in, and unset here. This model is scoped by ${missing.length > 1 ? "them" : "it"}, so running without ${missing.length > 1 ? "them" : "it"} would show nothing at all. Set ${missing.length > 1 ? "them" : "it"} to whoever you want to look at the data as:
2380
+ ${example} malloyyo dashboard dev`;
2381
+ }
2416
2382
 
2417
2383
  // src/host.ts
2418
2384
  var ENTRY = "index.malloy";
@@ -2460,14 +2426,22 @@ async function makeRunner(root) {
2460
2426
  const reader = fsReader();
2461
2427
  let configPromise = null;
2462
2428
  const getConfig = () => configPromise ??= loadConfig(rootUrl, reader);
2463
- const testGivens = (() => {
2429
+ let scopePromise = null;
2430
+ const givenScope = () => scopePromise ??= (async () => {
2431
+ if (!fs2.existsSync(path3.join(abs, ENTRY))) return { givens: {}, finalize: [], missing: [] };
2432
+ const config = await getConfig();
2433
+ const { reader: prepared, entry } = prepareSource(reader, { url: path3.join(abs, ENTRY) });
2434
+ let model;
2464
2435
  try {
2465
- return testGivensFromConfig(fs2.readFileSync(path3.join(abs, "malloy-config.json"), "utf8"));
2436
+ model = await new Runtime({ config, urlReader: prepared }).loadModel(entry).getModel();
2466
2437
  } catch {
2467
- return { givens: {}, warnings: [] };
2438
+ return { givens: {}, finalize: [], missing: [] };
2468
2439
  }
2440
+ const declared = serverFilledNames(declaredGivenNames(model));
2441
+ if (declared.length === 0) return { givens: {}, finalize: [], missing: [] };
2442
+ const found = readServerGivens(declared);
2443
+ return { givens: found.givens, finalize: declared, missing: found.missing };
2469
2444
  })();
2470
- const hostGivens = { values: testGivens.givens, reservedPrefix: "MALLOYYO_" };
2471
2445
  let inFlight = 0;
2472
2446
  let idleTimer = null;
2473
2447
  const clearIdleTimer = () => {
@@ -2488,7 +2462,12 @@ async function makeRunner(root) {
2488
2462
  async function leaseIn(entryFile, fn) {
2489
2463
  const config = await getConfig();
2490
2464
  const { reader: prepared, entry } = prepareSource(reader, { url: path3.join(abs, entryFile) });
2491
- const runtime = new Runtime({ config, urlReader: prepared });
2465
+ const { givens: scoped } = await givenScope();
2466
+ const runtime = new Runtime({
2467
+ config,
2468
+ urlReader: prepared,
2469
+ ...Object.keys(scoped).length > 0 ? { givens: scoped } : {}
2470
+ });
2492
2471
  inFlight++;
2493
2472
  clearIdleTimer();
2494
2473
  try {
@@ -2499,25 +2478,14 @@ async function makeRunner(root) {
2499
2478
  }
2500
2479
  }
2501
2480
  const lease = (fn) => leaseIn(ENTRY, fn);
2502
- const withLocalHint = (r) => {
2503
- if (r.ok) return r;
2504
- const hit = (r.problems ?? []).some((p) => p.code === HOST_GIVEN_UNAVAILABLE);
2505
- if (!hit) return r;
2506
- return {
2507
- ...r,
2508
- problems: (r.problems ?? []).map(
2509
- (p) => p.code === HOST_GIVEN_UNAVAILABLE ? {
2510
- ...p,
2511
- message: `${p.message} Locally, set it in malloy-config.json: { "malloyyo": { "test_givens": { "MALLOYYO_EMAIL": "you@example.com" } } }`
2512
- } : p
2513
- )
2514
- };
2481
+ const runnableScope = async () => {
2482
+ const scope = await givenScope();
2483
+ if (scope.missing.length > 0) throw new Error(missingServerGivensMessage(scope.missing));
2484
+ return scope;
2515
2485
  };
2516
2486
  return {
2517
2487
  root: abs,
2518
2488
  entryExists: () => fs2.existsSync(path3.join(abs, ENTRY)),
2519
- /** Anything unusable in `malloyyo.test_givens`, for `lint` to report. */
2520
- testGivensWarnings: testGivens.warnings,
2521
2489
  async dispose() {
2522
2490
  clearIdleTimer();
2523
2491
  if (!configPromise) return;
@@ -2526,27 +2494,31 @@ async function makeRunner(root) {
2526
2494
  if (config) await config.shutdown("close").catch(() => {
2527
2495
  });
2528
2496
  },
2529
- run(runExpr, givens) {
2497
+ async run(runExpr, givens) {
2498
+ const { finalize } = await runnableScope();
2530
2499
  return lease(
2531
- (runtime, entry) => run(runtime, entry, { runExpr, givens, hostGivens, stableResult: true, rowLimit: 5e3 })
2532
- ).then(withLocalHint);
2500
+ (runtime, entry) => run(runtime, entry, { runExpr, givens, requireGivens: finalize, stableResult: true, rowLimit: 5e3 })
2501
+ );
2533
2502
  },
2534
- runIn(entryFile, runExpr, givens) {
2503
+ async runIn(entryFile, runExpr, givens) {
2504
+ const { finalize } = await runnableScope();
2535
2505
  return leaseIn(
2536
2506
  entryFile,
2537
- (runtime, entry) => run(runtime, entry, { runExpr, givens, hostGivens, stableResult: true, rowLimit: 5e3 })
2538
- ).then(withLocalHint);
2507
+ (runtime, entry) => run(runtime, entry, { runExpr, givens, requireGivens: finalize, stableResult: true, rowLimit: 5e3 })
2508
+ );
2539
2509
  },
2540
- runText(malloy, givens) {
2510
+ async runText(malloy, givens) {
2511
+ const { finalize } = await runnableScope();
2541
2512
  return lease(
2542
- (runtime, entry) => runRestricted(runtime, entry, malloy, { givens, hostGivens, stableResult: true, rowLimit: 5e3 })
2543
- ).then(withLocalHint);
2513
+ (runtime, entry) => runRestricted(runtime, entry, malloy, { givens, requireGivens: finalize, stableResult: true, rowLimit: 5e3 })
2514
+ );
2544
2515
  },
2545
- runTextIn(entryFile, malloy, givens) {
2516
+ async runTextIn(entryFile, malloy, givens) {
2517
+ const { finalize } = await runnableScope();
2546
2518
  return leaseIn(
2547
2519
  entryFile,
2548
- (runtime, entry) => runRestricted(runtime, entry, malloy, { givens, hostGivens, stableResult: true, rowLimit: 5e3 })
2549
- ).then(withLocalHint);
2520
+ (runtime, entry) => runRestricted(runtime, entry, malloy, { givens, requireGivens: finalize, stableResult: true, rowLimit: 5e3 })
2521
+ );
2550
2522
  },
2551
2523
  validateText(malloy) {
2552
2524
  return lease((runtime, entry) => validateRestrictedText(runtime, entry, malloy));
@@ -2555,13 +2527,10 @@ async function makeRunner(root) {
2555
2527
  return leaseIn(entryFile, (runtime, entry) => validateRestrictedText(runtime, entry, malloy));
2556
2528
  },
2557
2529
  givensForQuery(runExpr) {
2558
- return lease((runtime, entry) => dashboardGivenSpecs(runtime, entry, runExpr, { hostGivens }));
2530
+ return lease((runtime, entry) => dashboardGivenSpecs(runtime, entry, runExpr));
2559
2531
  },
2560
2532
  givensForQueryIn(entryFile, runExpr) {
2561
- return leaseIn(
2562
- entryFile,
2563
- (runtime, entry) => dashboardGivenSpecs(runtime, entry, runExpr, { hostGivens })
2564
- );
2533
+ return leaseIn(entryFile, (runtime, entry) => dashboardGivenSpecs(runtime, entry, runExpr));
2565
2534
  },
2566
2535
  artifacts() {
2567
2536
  return lease((runtime, entry) => artifactQueries(runtime, entry));
@@ -2576,7 +2545,7 @@ async function makeRunner(root) {
2576
2545
  return leaseIn(entryFile, async (runtime, entry) => {
2577
2546
  const byName = /* @__PURE__ */ new Map();
2578
2547
  for (const tile of tiles) {
2579
- const specs = await dashboardGivenSpecs(runtime, entry, tile, { hostGivens });
2548
+ const specs = await dashboardGivenSpecs(runtime, entry, tile);
2580
2549
  if (specs.ok) {
2581
2550
  for (const s of specs.givens) if (!byName.has(s.name)) byName.set(s.name, s);
2582
2551
  }
@@ -2589,7 +2558,7 @@ async function makeRunner(root) {
2589
2558
  const byName = /* @__PURE__ */ new Map();
2590
2559
  const out = [];
2591
2560
  for (const tile of tiles) {
2592
- const specs = await dashboardGivenSpecs(runtime, entry, tile, { hostGivens });
2561
+ const specs = await dashboardGivenSpecs(runtime, entry, tile);
2593
2562
  const gvs = specs.ok ? specs.givens : [];
2594
2563
  for (const s of gvs) if (!byName.has(s.name)) byName.set(s.name, s);
2595
2564
  out.push({
@@ -2830,9 +2799,6 @@ async function lintDashboards(root) {
2830
2799
  }
2831
2800
  async function runLint(abs, runner) {
2832
2801
  const dashboards = [];
2833
- if (runner.testGivensWarnings.length > 0) {
2834
- dashboards.push({ name: "malloy-config.json", errors: [], warnings: [...runner.testGivensWarnings] });
2835
- }
2836
2802
  if (runner.entryExists()) {
2837
2803
  const arts = await runner.artifacts();
2838
2804
  if (!arts.ok) dashboards.push({ name: "index.malloy", errors: [arts.error], warnings: [] });
@@ -3022,7 +2988,7 @@ function clearCreds(url6) {
3022
2988
  }
3023
2989
 
3024
2990
  // package.json
3025
- var version = "0.2.53";
2991
+ var version = "0.2.54";
3026
2992
 
3027
2993
  // src/http.ts
3028
2994
  var USER_AGENT = `malloyyo/${version}`;
@@ -5766,8 +5732,13 @@ async function publish(target, dir, opts) {
5766
5732
  console.log(`\u2713 created dataset ${out.dataset ?? t.dataset} (private) \u2014 ${t.url}/datasets/${out.dataset ?? t.dataset}`);
5767
5733
  }
5768
5734
  console.log(
5769
- `\u2713 published version ${out.version} \u2014 ${out.sources?.length ?? 0} source(s)` + (dashboards.length ? `, ${dashboards.length} dashboard(s)` : "")
5735
+ `\u2713 published version ${out.version} \u2014 ${out.sources?.length ?? 0} source(s)` + (dashboards.length ? `, ${dashboards.length} dashboard(s)` : "") + (out.requiredGivens?.length ? `, scoped by ${out.requiredGivens.join(", ")}` : "")
5770
5736
  );
5737
+ if (out.scopedNow?.length) {
5738
+ console.log(
5739
+ ` \u21B3 this publish SCOPED the dataset by ${out.scopedNow.join(", ")}. Every query must now filter on ${out.scopedNow.length > 1 ? "them" : "it"}, and only an admin can undo this.`
5740
+ );
5741
+ }
5771
5742
  }
5772
5743
  async function status(target, opts) {
5773
5744
  const t = resolveTarget(resolve4("."), target);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@malloydata/malloyyo",
3
- "version": "0.2.53",
3
+ "version": "0.2.54",
4
4
  "description": "Publish Malloy models to a Malloyyo instance",
5
5
  "license": "MIT",
6
6
  "repository": {