npmpackage.info

Gathering detailed insights and metrics for @malloydata/malloy-query-builder

Other packages similar to @malloydata/malloy-query-builder

@malloydata/malloy-explorer

0.0.295-dev250710213205

Malloy visual query builder

Gathering detailed insights and metrics for @malloydata/malloy-query-builder

@malloydata/malloy-query-builder - 0.0.295 | npmpackage.info

@malloydata/malloy-query-builder

Malloy is an experimental language for describing data relationships and transformations.

0.0.295

2,184

MIT

TypeScript

862.23 kB

6.5

Installations

npm install @malloydata/malloy-query-builder

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=20

Node Version

20.19.3

NPM Version

10.8.2 Pull Requests

Open

40

Total

1,746

Closed

195

Merged

1,511

Issues

Open

327

Total

617

Closed

290

Releases

v0.0.214

Updated on Nov 15, 2024

v0.0.207

Updated on Nov 05, 2024

v0.0.206

Updated on Nov 01, 2024

Add MalloySQLParseResults to exports

v0.0.144

Updated on Apr 26, 2024

View All 4 releases

Languages

TypeScript

ANTLR

Thrift

Shell

CSS

JavaScript

Nearley

HTML

PEG.js

MDX

Nix

TypeScript (97.82%)

ANTLR (0.6%)

Thrift (0.39%)

Shell (0.33%)

CSS (0.28%)

JavaScript (0.26%)

Nearley (0.2%)

HTML (0.06%)

PEG.js (0.05%)

MDX (0.02%)

Developer

malloydata

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2,184 Stars

4,683 Commits

95 Forks

26 Watchers

310 Branches

49 Contributors

Updated on Jul 10, 2025

Maintainers

View All 49 Contributors

Package Meta Information

Latest Version

0.0.295

Package Id

@malloydata/malloy-query-builder@0.0.295

Unpacked Size

862.23 kB

Size

86.34 kB

File Count

NPM Version

10.8.2

Node Version

20.19.3

Published on

Jul 10, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@malloydata/malloy-filter @malloydata/malloy-interfaces @malloydata/malloy-tag

Dev Dependencies

http-server rimraf typedoc

Malloy Query AST

Get started with the {@link ASTQuery} class.

Serialize itself to a Malloy Query string

{@link ASTQuery.toMalloy}

1query.setSource('flights');
2query.setView('by_carrier');
3query.toMalloy();

run: flights -> by_carrier

Provide an interface to walk the tree

This is for the Explorer, e.g., to create the query summary UI

To the empty query, add a starting point which is either a new literal view or a view reference which can later be refined

{@link ASTQuery.getOrAddDefaultSegment}

1query.setSource('flights');
2query.getOrAddDefaultSegment().addGroupBy("carrier");

run: flights -> { group_by: carrier }

{@link ASTQuery.setViewToEmptySegment}

1query.setSource('flights');
2query.setViewToEmptySegment().addGroupBy("carrier");

run: flights -> { group_by: carrier }

{@link ASTQuery.setView}

1query.setSource('flights');
2query.setView('by_carrier');

run: flights -> by_carrier

Determine if the query can be run

{@link ASTSegmentViewDefinition.isRunnable}

run: flights -> { }

1query.isRunnable() // false

Add a new field to a particular literal view

{@link ASTSegmentViewDefinition.addGroupBy} {@link ASTSegmentViewDefinition.addAggregate} {@link ASTSegmentViewDefinition.addNest}

1const segment = query.getOrAddDefaultSegment();
2segment.addGroupBy('carrier');
3segment.addAggregate('flight_count');
4segment.addNest('by_origin');

run: flights -> {
  group_by: carrier
  aggregate: flight_count
  nest: by_origin
}

A field reference

A time truncation of a field reference

{@link ASTSegmentViewDefinition.addDateGroupBy} {@link ASTSegmentViewDefinition.addTimestampGroupBy}

1const segment = query.getOrAddDefaultSegment();
2segment.addTimestampGroupBy('dep_time', 'month');

run: flights -> {
  group_by: dep_time.month
}

A measure reference with filters

Rename/delete a field

{@link ASTGroupByViewOperation.delete} {@link ASTAggregateViewOperation.delete} {@link ASTNestViewOperation.delete} {@link ASTGroupByViewOperation.rename} {@link ASTAggregateViewOperation.rename} {@link ASTNestViewOperation.rename}

run: flights -> {
  group_by: carrier
  aggregate: flight_count
}

1groupBy.delete();
2aggregate.rename("flight_count_2");

run: flights -> { aggregate: flight_count_2 is flight_count }

Check if a field is present

{@link ASTSegmentViewDefinition.hasField}

1query.getOrAddDefaultSegment().hasField('carrier');

Add/edit/delete order by

{@link ASTOrderByViewOperation.delete}

run: flights -> {
  group_by: carrier
  order_by: carrier desc
}

1orderBy.delete();

run: flights -> { group_by: carrier }

{@link ASTOrderByViewOperation.setField}

run: flights -> {
  group_by:
    carrier
    flight_count
  order_by: carrier desc
}

1orderBy.setField("flight_count");

run: flights -> {
  group_by:
    carrier
    flight_count
  order_by: flight_count desc
}

{@link ASTOrderByViewOperation.setDirection}

run: flights -> {
  group_by: carrier
  order_by: carrier desc
}

1orderBy.setDirection(Malloy.OrderByDirection.ASC);

run: flights -> {
  group_by: carrier
  order_by: flight_count asc
}

Add/edit/delete filter

{@link ASTSegmentViewDefinition.addWhere}
{@link ASTFilterWithFilterString.setFilterString}
{@link ASTFilterWithFilterString.setFilter}
{@link ASTFilterWithFilterString.getFilter}
{@link ASTWhereViewOperation.delete}
{@link ASTWhere.delete}

1query.getOrAddDefaultSegment().addWhere("carrier", "WN, AA");

run: flights -> { where: carrier ~ f`WN, AA` }

Add/edit/delete limit

{@link ASTSegmentViewDefinition.setLimit}
{@link ASTLimitViewOperation.delete}

1query.getOrAddDefaultSegment().setLimit(10);

run: flights -> { limit: 10 }

Create new nest with name

{@link ASTSegmentViewDefinition.addEmptyNest}

1query.getOrAddDefaultSegment().addEmptyNest("by_origin");

run: flights -> { nest: by_origin is { } }

Reorder fields

To a particular nesting level (literal view or view + refinements), reorder fields

For a particular literal view, list the fields which can be added

{@link ASTSegmentViewDefinition.getInputSchema}

1query.getOrAddDefaultSegment().getInputSchema();

{
  fields: [
    { kind: "measure", name: "flight_count", type: { kind: "string_type" }}
    ...
  ]
}

To a particular view reference, add a new literal view as a refinement

{@link IASTViewDefinition.addEmptyRefinement}

1const view = query.setView("by_carrier");
2const segment = view.addEmptyRefinement();
3segment.setLimit(10);

run: flights -> by_carrier + { limit: 10 }

To a particular view reference, add a new view reference as a refinement

{@link IASTViewDefinition.addViewRefinement}

1const view = query.setView("by_carrier");
2view.addViewRefinement("top10");

run: flights -> by_carrier + top10

To a particular view (literal or reference), specify the order of fields by way of adding/editing an annotation

{@link ASTQuery.reorderFields} {@link ASTView.reorderFields}

If the view or query is a simple segment, it will automatically reorder the clauses.

run: flights -> {
  group_by: carrier
  aggregate: flight_count
}

1query.reorderFields(['flight_count', 'carrier']);

run: flights -> {
  aggregate: flight_count
  group_by: carrier
}

Otherwise, it will add an annotation:

run: flights -> by_carrier

1query.reorderFields(['flight_count', 'carrier']);

# field_order = [flight_count, carrier]
run: flights -> by_carrier

To a particular aggregate field in the query, add/edit/delete filter

{@link ASTAggregateViewOperation.addWhere}
{@link ASTFilterWithFilterString.setFilter}
{@link ASTWhere.delete}

1query.getOrAddDefaultSegment().addAggregate('flight_count').addWhere('carrier', 'WN, AA');

run: flights -> { aggregate: flight_count { where: carrier ~ f`WN, AA`} }

Specify or remove source parameter value

{@link ASTReferenceQueryArrowSource.setParameter}

1query.definition.as.ArrowQueryDefinition().source.as.ReferenceQueryArrowSource().parameters.setParameter("param", 1)

run: flights(param is 1) ->

List parameters of the source and whether they are required

{@link ASTReferenceQueryArrowSource.getSourceParameters}

1query.definition.as.ArrowQueryDefinition().source.as.ReferenceQueryArrowSource().getSourceParameters();

To a particular field in the query (including nests), add/edit/delete annotation

{@link IASTAnnotatable.setTagProperty} {@link IASTAnnotatable.removeTagProperty}

1query
2  .getOrAddDefaultSegment()
3  .addGroupBy('carrier');
4  .setTagProperty(['a', 'b', 'c'], 10);

run: flights -> {
  # a.b.c = 10
  group_by: carrier
}

1// Assume that 'by_carrier' has, in the model, a tag "bar_chart"
2query
3  .getOrAddDefaultSegment()
4  .addNest('by_carrier');
5  .removeTagProperty(['bar_chart']);

run: flights -> {
  # -bar_chart
  nest: by_carrier
}

To a particular field, ask which annotations come from the input field vs in the query itself

{@link IASTAnnotatable.getIntrinsicTag} {@link IASTAnnotatable.getInheritedTag}

1query
2  .getOrAddDefaultSegment()
3  .addGroupBy('carrier');
4  .getIntrinsicTag()
5  .has('some_tag');
6query
7  .getOrAddDefaultSegment()
8  .addGroupBy('carrier');
9  .getInheritedTag()
10  .has('some_tag');

To the query itself, add/edit/delete annotation

1query.setTagProperty(['bar_chart']);
2query.setSource('flights');
3query.setView('by_carrier');

# bar_chart
run: flights -> by_carrier

After any operation of a QueryBuilder, perform a partial validation of the query

This is only ever a partial validation: cube resolution, aggregate validation, and expression validation (and possibly other validation) must happen in the translator, and will not be replicated in the QueryBuilder We will do as much validation as we can do, but it is possible some queries will only generate errors when you do a full translation (probably when you run it)

Given a filter string and a field type, parse it into a StableFilterDef

Given a StableFilterDef, serialize it into a filter string

Automatically determine where in a literal view is most appropriate to place a new field

This happens automatically when you call {@link ASTSegmentViewDefinition.addGroupBy}, {@link ASTSegmentViewDefinition.addAggregate}, {@link ASTSegmentViewDefinition.addNest}, {@link ASTSegmentViewDefinition.addWhere}, {@link ASTSegmentViewDefinition.addOrderBy}, {@link ASTSegmentViewDefinition.setLimit}, etc..

Finding the default place in the tree to put a new field

{@link ASTQuery.getOrAddDefaultSegment}

1query.setSource('flights');
2query.getOrAddDefaultSegment().addGroupBy("carrier");

run: flights -> { group_by: carrier }

run: flights -> by_carrier

1query.setSource('flights');
2query.getOrAddDefaultSegment().setLimit(10);

run: flights -> by_carrier + { limit: 10 }

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

SAST

Determines if the project uses static code analysis.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 6

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-bigquery.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-bigquery.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-bigquery.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-bigquery.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/db-bigquery.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-bigquery.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-duckdb-wasm.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-duckdb-wasm.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-duckdb-wasm.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-duckdb-wasm.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-duckdb.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-duckdb.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-duckdb.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-duckdb.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-motherduck.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-motherduck.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-motherduck.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-motherduck.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-mysql.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-mysql.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-mysql.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-mysql.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-postgres.yaml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-postgres.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-postgres.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-postgres.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-presto.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-presto.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-presto.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-presto.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-publisher.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-publisher.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-publisher.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-publisher.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-snowflake.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-snowflake.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-snowflake.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-snowflake.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-trino.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-trino.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/db-trino.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/db-trino.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/main.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yaml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/main.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yaml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/main.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prerelease.yaml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/prerelease.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prerelease.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/prerelease.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/release.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/run-tests.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/malloydata/malloy/run-tests.yaml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/release.yaml:67
Info: 0 out of 26 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned
Info: 13 out of 14 npmCommand dependencies pinned

5

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.5

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More