1. guides
prorm
  • prorm documentation
  • Known test gaps
  • Architecture
  • Core concepts
  • Database types & coverage
  • Getting started
  • Going further
  • compliance
    • Compliance
    • The security toolkit: `prorm audit`
    • Checklists by regulation
    • Declaring personal data
    • Evidence bundles
    • Evidence
    • Frameworks: `@Security`
    • Jurisdictions
    • Platform policies
    • Protecting data
    • The regulation dataset
    • Residency and cross-border transfers
    • Retention & integrity
    • Status
    • Subject rights
  • decorators
    • prorm with decorators
    • Models with decorators
    • Querying a decorated model
    • Relations with decorators
  • diagrams
    • Diagram generators
    • Chen diagram
    • Class diagram
    • Dependency diagram
    • ER diagram
    • Flow diagram
    • From your models to a diagram
    • Gantt diagram
    • Index diagram
    • Migration diagram
    • Model diagram
    • Package diagram
    • Crow’s-foot diagram
    • Schema documentation
    • Sequence diagram
    • State diagram
    • Tree diagram
  • dialects
    • SQL dialects
    • AlloyDB Dialect
    • AlloyDB Omni Dialect
    • Amazon Athena Dialect
    • Aurora DSQL Dialect
    • Amazon Aurora MySQL Dialect
    • Amazon Aurora PostgreSQL Dialect
    • Azure Database for MySQL Dialect
    • Azure Database for PostgreSQL Dialect
    • Azure SQL Database Dialect
    • Azure SQL Managed Instance Dialect
    • Google BigQuery Dialect
    • Citus Dialect
    • ClickHouse dialect
    • Cloud Authentication (`cloud-auth`)
    • Cloud SQL for SQL Server Dialect
    • Cloud SQL for MySQL Dialect
    • Cloud SQL for PostgreSQL Dialect
    • CockroachDB Dialect
    • Azure Cosmos DB for PostgreSQL Dialect
    • CrateDB Dialect
    • Cloudflare D1 Dialect
    • Databricks dialect
    • IBM Db2 Dialect
    • Dolt Dialect
    • Apache Doris Dialect
    • Druid Dialect
    • DuckDB Dialect
    • Exasol dialect
    • Microsoft Fabric Data Warehouse Dialect
    • Firebird Dialect
    • Greenplum Dialect
    • SAP HANA Dialect
    • MySQL HeatWave Dialect
    • Azure Data Explorer (Kusto) Dialect — T-SQL
    • MariaDB Dialect
    • Materialize Dialect
    • MonetDB Dialect
    • MotherDuck Dialect
    • Microsoft SQL Server Dialect
    • MySQL Dialect
    • Neon Dialect
    • OceanBase Dialect
    • openGauss Dialect
    • Oracle Dialect
    • Oracle Autonomous Database Dialect
    • ParadeDB Dialect
    • PolarDB Dialect
    • PostgreSQL Dialect
    • Presto Dialect
    • QuestDB Dialect
    • Aurora RDS Data API Dialect (`rdsdata`)
    • Amazon RDS for Db2 Dialect
    • Amazon RDS for MariaDB Dialect
    • Amazon RDS for SQL Server Dialect
    • Amazon RDS for MySQL Dialect
    • Amazon RDS for Oracle Dialect
    • Amazon RDS for PostgreSQL Dialect
    • Amazon Redshift
    • Amazon Redshift Data API Dialect
    • RisingWave Dialect
    • rqlite Dialect
    • SingleStore Dialect
    • Snowflake Dialect
    • Google Cloud Spanner Dialect
    • Spanner (PostgreSQL interface) Dialect
    • SQLite Dialect
    • StarRocks Dialect
    • Supabase Dialect
    • Azure Synapse Analytics (dedicated SQL pool)
    • Teradata Dialect
    • TiDB Dialect
    • TimescaleDB Dialect
    • Trino Dialect
    • Turso / libSQL Dialect
    • Vertica dialect
    • Vitess Dialect
    • Yellowbrick Dialect
    • YugabyteDB Dialect
  • guides
    • Access rules and behaviour profiles
    • ArangoDB (AQL)
    • Associations
    • Audit levels and escalation
    • Audit logging
    • In the browser
    • Bulk operations
    • Caching
    • Capabilities, tiers and team roles
    • CLI
    • Cloudflare
    • Compliance & data protection
    • Connection Pooling & Performance
    • Security in the console
    • Couchbase: structured N1QL queries
    • Data types
    • Decorators
    • Eager loading
    • Enums and constants
    • Error handling & error types
    • Extensions
    • External fields
    • Foreign data wrappers
    • Graph databases
    • Hooks & lifecycle events
    • Indexes & constraints
    • InfluxDB: structured Flux pipelines
    • klock-errors
    • klock — the `.klock` file
    • Local databases (`prorm db up`)
    • Structured log search — Splunk, Graylog, Papertrail, Sumo Logic
    • Logging
    • Grafana Loki: structured LogQL queries
    • MCP server
    • Migrate — the data transfer subsystem
    • Migrations & Schema Sync
    • Models from an existing database
    • Defining models
    • Multiple databases
    • OrientDB, Neptune and TigerGraph
    • Passwords
    • Importing a Prisma schema
    • Structured PromQL and MetricsQL
    • Query firewall
    • QueryInterface
    • Query operators reference
    • Query optimization
    • Composing find options with `pipe()` and `Q`
    • Query safety: the fail-closed WHERE guard
    • Querying
    • Raw Queries & Query Building
    • Read replicas
    • Schema diffing & migration generation
    • Views, triggers & other schema objects
    • Scopes & default scopes
    • Seeders
    • SPARQL / RDF triplestores
    • SQL constants
    • SQL features
    • SQL function builders
    • SQLite advanced features
    • StoreKey — a prod-orm database as the storage
    • Streaming results
    • Terraform
    • Transactions & Isolation Levels
    • Type mapping: legacy and modern
    • TypeScript types
    • Database users, roles & privileges
    • Validation & constraints
    • Virtual & Computed Fields
    • Writing docs
  • javascript
    • prorm in JavaScript
    • Models in JavaScript
    • Querying in JavaScript
    • Relations in JavaScript
  • runbooks
    • Operational runbooks
    • Connection failures
    • Credential rotation
    • Failover
    • Incident checklist
    • Deploying klock v2
    • Migration rollback
  • running-databases
    • Running databases in Docker
    • Running prorm under Bun in Docker
    • Running Cassandra in Docker with prorm
    • Running ClickHouse in Docker with prorm
    • Running CockroachDB in Docker with prorm
    • Running prorm under Deno in Docker
    • Running Elasticsearch in Docker with prorm
    • Running MariaDB in Docker with prorm
    • Running MongoDB in Docker with prorm
  • prorm control plane
    • Introduction
    • Authentication
    • Errors
    • Getting started
      • Service
        • Is it up
        • This description
    • Account
      • Sign-up and verification
        • Create an account
        • Exchange credentials for a token
        • Verify with the emailed code
        • Verify by clicking the emailed link
        • Name the parent or guardian
        • What a consent link is about
        • Give consent for a child's account
        • Ask the parent or guardian again
        • Send a new code and link
      • Family
        • Everyone this account is responsible for
        • One child, in detail
        • Turn a limit on or off
      • Profile
        • Who am I
        • Change the account
        • Every address on the account
        • Add an address
        • Confirm an address with the code mailed to it
        • Mail a fresh code to an unconfirmed address
        • Make an address primary
        • Remove an address
        • What this caller may do
    • Security
      • Sessions
        • Everywhere this account is signed in
        • Sign out everywhere else
        • Sign one out
        • A token for the CLI on a named machine
        • A token for the customer console, from the staff one
        • Park a sign-in for the CLI to collect
        • The CLI collecting its sign-in
        • The team's members' live sessions
        • Sign a member's session out
        • Sign an account out everywhere
        • Everywhere the account is signed in
        • Sign an account's session out
      • Single sign-on
        • Begin a single sign-on
        • The provider's return
        • Link the signed-in account to a team's provider
        • Which team an address signs in to
        • The team's single sign-on, as a member sees it
        • Set the team's OpenID Connect provider up, or change it
        • Remove the provider
        • The team's domain claims and the DNS record each needs
        • Prove a claimed domain
      • MFA and passwords
        • Start enrolling a second factor
        • Prove the app has it
        • Remove the second factor
        • Ask for a reset link
        • Set a new password with the emailed token
      • Klock
        • Open a device-bound klock session
        • Check in, for the next grant
        • Step up the session asking
        • Rotate the device key
        • Freeze a session
        • Unfreeze a session
        • A guest grant
        • The revocation feed
        • The published keyset
        • What this control plane supports
      • Devices
        • Your devices, or a team's
        • Approve a new device's pairing code
        • One device
        • Rename a device
        • Revoke a device
        • Suspend a device
        • Reinstate a suspended device
        • Wipe a device
        • Ask a device to rotate its key
        • The team's members' devices
        • Revoke a member's device
        • An account's devices
        • Revoke an account's device
        • Wipe an account's device
        • The device fleet
      • Access rules and behaviour
        • The access rules that bear on you
        • Add an access rule
        • This request, as the rules see it
        • One access rule
        • Remove an access rule
        • The behaviour profiles that bear on you
        • Add or change a behaviour profile
        • The profile presets
        • Your behaviour findings
        • Acknowledge a finding
        • One behaviour profile
        • Remove a behaviour profile
        • The team's access rules
        • Add a team access rule
        • Remove a team access rule
        • The team's behaviour profiles
        • Add or change a team behaviour profile
        • Remove a team behaviour profile
        • What the team's profiles caught
        • Acknowledge a team finding
      • Recovery and lockdown
        • Ask for a recovery link
        • Recover access with the emailed code
        • Is the account locked down
        • Lock the account down
        • Release a lockdown
        • Lock a member down
        • Release a member's lockdown
      • MCP tokens
        • Make a delegated token for one MCP client
        • The account's delegated tokens
        • Revoke a delegated token
        • What a delegated token may do now
        • Run one MCP tool with a delegated token
        • Run a device-signed MCP tool call relayed by the MCP Worker
      • Kerberos
        • Give the team its own Kerberos realm
        • The team's realm
        • Remove the team's realm
    • Logging and monitoring
      • Audit log
        • What has been done to the account
        • What has happened to this account
        • The account's audit trail
      • Operations
        • Everything that has been asked of this database
        • One, with its steps
        • Stop it
        • Put a failed one back in the queue
        • Every operation, across all accounts
      • Metrics and events
        • Every measurement, for a graph
        • Who did what to it
    • Billing
      • Plans and pricing
        • What the plans allow
        • The rate card
        • What one database would cost
        • What this account is paying for, itemised
      • Subscriptions and invoices
        • What this month's invoice will say
        • What this account is on
        • What it has been charged
        • Start a Stripe Checkout session
        • Open the customer portal
        • Stripe's events
        • Buy more connection pools
      • Team billing
        • The team's billing account
        • What the team has been charged
        • What this month's invoice will say
        • The team's cards
        • Add a card, through a Stripe-hosted setup session
        • Make a card the team's default
        • Remove a card
        • Start the team paying
        • Open the Stripe portal on the team's customer
        • Change the team's plan
        • Who receives the team's bills
        • How the team pays for transfers
    • Support
      • Support chat
        • My conversations
        • Start a conversation
        • Every support conversation, open first
        • A ticket for the socket
        • One conversation, with who is in it and who is connected
        • Rename a group; open or close a support conversation
        • The lines, oldest first
        • Say something
        • Add somebody
        • Mark read
    • Administration
      • Users
        • Every account
        • One account, with everything hanging off it
        • Grant or revoke admin
        • Verify an account by hand
        • Lock or unlock sign-in
        • Allow or hold provisioning
        • Send the verification mail again
        • Set the plan by hand
      • Platform
        • Every database and store, across all accounts
        • The counts worth putting on a dashboard
      • Staff and permissions
        • What kind of admin the caller is, and which scopes they hold
        • The admin presets
        • Every admin, and the scopes each resolves to
        • Make an account an admin of a kind
        • Change an admin's kind, or a custom admin's scopes
        • Revoke admin
      • Team administration
        • Every team, with its owner and size
        • One team in full — members with their accounts, and projects
        • Hand the team to another member
        • Put an account in the team, active at once
        • Change a member's role
        • Remove a member
      • Assumed identities
        • Assume an identity — act as a customer account
        • The identities the caller holds open
        • End an assumed identity
      • Support inbox
        • The platform's addresses
        • Add a platform address
        • One address, with its counts
        • Change an address's label, routing, or whether it accepts mail
        • Remove an address that holds no mail
        • Make, adopt or repair the address's routing rule
        • Every admin's personal address, made where missing
        • File a raw message, as if it had arrived
        • The inbox
        • One message, whole
        • Mark a message
        • Hand a message to an admin, or take it back
        • Leave an internal note
        • Reply, from the address the message came to
        • What is waiting
    • Databases
      • Databases
        • Data stores
          • Every data store on the account
          • Provision a data store
          • Change a data store that is already running
          • One data store
          • Deprovision it
          • Report what it is using
          • How to reach a data store
        • Connections and credentials
          • The api keys on a database
          • Issue a key
          • Revoke a key
          • The engine users we created
          • Create a user inside the database
          • Give a user a new password
          • Drop a user
          • How the database is reached
          • Set how it is reached
          • Revoke every api key on it
          • How to connect to it
          • The ssh keys that open its bastion
          • Add a key, or have one made
          • The private half of a generated key, once
          • Revoke an ssh key
        • Schema and objects
          • The SQL objects we put in it
          • Create one, and apply it
          • What is in the database, as the engine reports it
          • One table
          • What it would run, without running it
          • Redefine an object in place
          • Drop it
          • The extensions installed in it
        • Migrations
          • A plan compiled to statements, recording nothing
          • The migrations recorded for it
          • Record one
          • Apply everything recorded and not yet run
          • Apply everything pending, oldest version first
        • Lifecycle
          • Grow or shrink it
          • Stop it accepting connections
          • Start it again
          • Move it to another region
        • Backups and replicas
          • Take a backup
          • The backups it has
          • Restore one into it
          • What has been restored into it, and from where
          • Its read copies
          • Add one
        • Policies
          • The catalog
          • One policy
          • What this database is held to
          • Switch a policy on, or change its knobs
          • Switch it off
          • Mark the policies reviewed
          • Evaluate the periodic policies now
          • Who is behind a credential
        • Passwordless
          • The database's passwordless sessions
          • Issue a passwordless session (v1)
          • Revoke a passwordless session
          • Bind a session to a device key
          • Issue a v2 session for a host to bind
          • Redeem an enrolment ticket on the host
          • Check a passwordless credential
          • Run one described query under a passwordless credential
        • Database roles
          • The database's roles
          • Define a role
          • One role
          • Change what a role permits
          • Delete a role, and revoke every key granted it
          • Grant a role, which mints a key
          • Who holds a role
          • The api keys bound to a role
        • Pools
          • A database's connection pools, and how busy each is
          • Open another pool
          • Rename a pool or change its size
          • Close a pool
        • Data plane
          • Run a query against a database
          • Several statements, in order, over one connection
          • Is this database answering
          • What the proxy itself is holding
        • Transfers
          • The strategies this account's tier may use
          • Price a transfer without creating it
          • The account's transfer jobs, newest first
          • Create a transfer job
          • One job, and whether its certificate holds
          • Cancel an unfinished job
          • Start a created job, confirming its price
          • Report a job's status (the runner, or the owner's side of a local run)
        • Every database on the account
        • Provision a database
        • Change a database that is already running
        • One database
        • Deprovision it
        • Read or write it
        • Report what it is using
        • The engines this API will provision
        • Where a managed database can be put
    • Teams
      • Teams
        • Members
          • Who is on it
          • Invite somebody
          • Accept an invitation
          • Change somebody's role
          • Remove somebody
        • Projects
          • The projects a team runs
          • Start one
          • Rename a project, or move its environment
          • Delete a project
          • One project, and what is in it
          • Put a database or store in it
          • What is in a project
          • Take one out
        • The teams this account is on
        • Start one
        • The twelve roles, and what each may do
        • Rename a team
        • Close a team
        • One team
        • Hand the team to somebody else
        • Leave a team
    • Schemas
      • Error
      • ValidationErrors
      • Token
      • PolicyCategory
      • PolicySeverity
      • PolicyAction
      • PolicyTrigger
      • PolicyParam
      • Policy
      • PolicyCatalog
      • PolicyAssignment
      • PolicyOutcome
      • PolicyFiring
      • CredentialTrace
      • Relation
      • Restrictions
      • ChildSummary
      • SignupRequest
      • SigninRequest
      • UpdateMeRequest
      • User
      • Address
      • GeoPoint
      • D1Region
      • Usage
      • UsageReport
      • Resource
      • Database
      • DataStore
      • NewDatabase
      • NewDataStore
      • QueryRequest
      • DatabasePrivilege
      • ApiKey
      • DbUser
      • Access
      • AccessRequest
      • DatabaseObject
      • NewDatabaseObject
      • NewMigration
      • SchemaOperation
      • Migration
      • Operation
      • Session
      • AdminPowers
      • Admin
      • AuditEntry
      • TeamRole
      • Conversation
      • ChatMessage
      • TeamSso
      • Team
      • TeamMember
      • SshKey
      • ConnectionInfo
      • InboxAddress
      • InboxMailbox
      • InboxMessageSummary
      • InboxMessage
      • InboxNote
      • Page
      • Quote
      • Plan
      • ApiError
      • CapabilityRefusal
      • KlockErrorCode
      • PageWindow
      • SessionView
      • KlockStepUpRequest
      • KlockOpenRequest
      • KlockOpenedSession
      • UpdateMeResult
      • CapabilitiesView
      • SessionLimits
      • Device
      • DeviceListed
      • DeviceTeamRef
      • DeviceCommand
      • DeviceAuditLine
      • DeviceActionRequest
      • StaffActionRequest
      • ManagedSession
      • SessionRevoked
      • AccessRule
      • AccessRuleRequest
      • BehaviourProfile
      • BehaviourProfileRequest
      • BehaviourProfileSaved
      • BehaviourFinding
      • BehaviourFindingAck
      • StepUpProof
      • Removed
      • MemberLockdownRequest
      • McpClient
      • McpDelegatedView
      • McpToolCall
      • McpForwardRequest
      • PasswordlessScope
      • RoleScope
      • PasswordlessSession
      • PasswordlessTlsMaterial
      • PasswordlessKerberosMaterial
      • ServiceDeviceKeys
      • ServiceSession
      • DatabaseRole
      • TransferEndpoint
      • TransferJobRequest
      • TransferQuote
      • TransferStrategy
      • TransferJob
      • TransferJobAccess
      • Pool
      • PoolAllowance
      • BillingSubscription
      • Invoice
      • BillingContact
      • PaymentMethod
      • UpcomingCharges
      • TeamBilling
      • TeamKerberosRealm
      • TeamSsoDomain
      • TeamSsoResponse
      • StoreConnection
      • BatchFailure
      • ProxyStatus
  1. guides

InfluxDB: structured Flux pipelines

Source: src/nosql/influxdb/flux.ts · src/nosql/influxdb/index.ts · Tests: tests/nosql/influxdb-flux.test.ts, tests/nosql/influxdb-flux-store.test.ts
InfluxDBStore has always had a structured write surface — writePoint, writeMeasurement, create/bulkCreate, buffered line protocol with an explicit flush(). Reading was query(flux) / queryRaw(flux): the Flux script was a string you wrote by hand, which is exactly what this library's no-raw-query principle forbids. This page documents the structured read path that closes that gap.
query(), queryRows(), collectRows() and queryRaw() have not gone anywhere. They are the escape hatch for what Flux can express and this compiler deliberately will not, and every refusal below names the feature and points back at them.

The surface#

MethodDoes
store.buildFlux(spec)Compiles a FluxQuerySpec to a Flux script. Pure — nothing is sent.
store.runFlux(spec)Compiles, runs, collects every row into an array.
store.streamFlux(spec)Compiles, runs, yields rows lazily for for await.
store.rawFlux(spec)Compiles, runs, returns the annotated-CSV body.
compileFlux(spec, { bucket })The compiler on its own, with no store attached.
import { InfluxDBStore } from 'ts-prorm-orm/nosql/influxdb';

const store = new InfluxDBStore({ url: 'http://localhost:8086', token: process.env.INFLUX_TOKEN!, org: 'acme', bucket: 'telemetry' });
await store.connect();

const rows = await store.runFlux({
  range: { start: '-24h', stop: { now: true } },
  pipeline: [
    { op: 'filter', measurement: 'cpu', field: 'usage_user', tags: { host: 'web-1' } },
    { op: 'aggregateWindow', every: '5m', fn: 'mean', createEmpty: false },
    { op: 'sort', columns: ['_time'], desc: true },
    { op: 'limit', n: 100 },
  ],
  yield: 'cpu_5m',
});
from(bucket: "telemetry")
  |> range(start: -24h, stop: now())
  |> filter(fn: (r) => r._measurement == "cpu" and r._field == "usage_user" and r.host == "web-1")
  |> aggregateWindow(every: 5m, fn: mean, createEmpty: false)
  |> sort(columns: ["_time"], desc: true)
  |> limit(n: 100)
  |> yield(name: "cpu_5m")

Data model and pipeline#

InfluxDB stores points: a measurement, a set of indexed string tags, one or more fields and a timestamp. Every distinct measurement-plus-tag-set is a series. A Flux query streams tables of rows through stages, and each stage sees what the previous one emitted:

More pipelines, side by side#

import { Op } from 'ts-prorm-orm';
import { InfluxDBStore } from 'ts-prorm-orm/nosql/influxdb';

const store = new InfluxDBStore({ url: 'http://localhost:8086', token: process.env.INFLUX_TOKEN!, org: 'acme', bucket: 'telemetry' });
await store.connect();

try {
  // write two points; buffered until flush()
  store.writeMeasurement({ measurement: 'http', tags: { route: '/api/orders' }, fields: { duration_ms: 42, status: 200 }, intFields: ['status'] });
  store.writeMeasurement({ measurement: 'http', tags: { route: '/health' }, fields: { duration_ms: 1, status: 200 }, intFields: ['status'] });
  await store.flush();

  // 1. p95 latency per route in 15-minute windows
  const p95 = await store.runFlux({
    range: { start: '-6h' },
    pipeline: [
      { op: 'filter', measurement: 'http', field: 'duration_ms', where: { status: { [Op.gte]: 200 }, route: { [Op.ne]: '/health' } } },
      { op: 'group', columns: ['route'] },
      { op: 'aggregateWindow', every: '15m', fn: 'quantile', q: 0.95, createEmpty: false },
      { op: 'yield', name: 'p95' },
    ],
  });

  // 2. fields to columns, then a computed column
  const busy = await store.runFlux({
    range: { start: '-1h' },
    pipeline: [
      { op: 'filter', measurement: 'cpu', tags: { host: 'web-1' } },
      { op: 'pivot', rowKey: ['_time'], columnKey: ['_field'], valueColumn: '_value' },
      { op: 'map', columns: { busy: { arith: '-', left: { value: 100 }, right: { col: 'usage_idle' } } } },
      { op: 'keep', columns: ['_time', 'host', 'busy'] },
    ],
  });

  // 3. per-second rate of a counter, top five
  const top = await store.runFlux({
    range: { start: '-1h' },
    pipeline: [
      { op: 'filter', measurement: 'net', field: 'bytes_recv' },
      { op: 'derivative', unit: '1s', nonNegative: true },
      { op: 'top', n: 5, columns: ['_value'] },
    ],
  });

  console.log(p95.length, busy.length, top.length);
} finally {
  await store.disconnect(); // flushes and closes the write APIs
}
// 1.
from(bucket: "telemetry")
  |> range(start: -6h)
  |> filter(fn: (r) => r._measurement == "http" and r._field == "duration_ms" and (r.status >= 200.0 and r.route != "/health"))
  |> group(columns: ["route"])
  |> aggregateWindow(every: 15m, fn: (column, tables=<-) => tables |> quantile(q: 0.95, column: column), createEmpty: false)
  |> yield(name: "p95")

// 2.
from(bucket: "telemetry")
  |> range(start: -1h)
  |> filter(fn: (r) => r._measurement == "cpu" and r.host == "web-1")
  |> pivot(rowKey: ["_time"], columnKey: ["_field"], valueColumn: "_value")
  |> map(fn: (r) => ({r with busy: (100.0 - r.usage_idle)}))
  |> keep(columns: ["_time", "host", "busy"])

// 3.
from(bucket: "telemetry")
  |> range(start: -1h)
  |> filter(fn: (r) => r._measurement == "net" and r._field == "bytes_recv")
  |> derivative(unit: 1s, nonNegative: true)
  |> top(n: 5, columns: ["_value"])
Note r.status >= 200.0 in the first pipeline: numbers compile as floats unless you mark them, which is the subject of a section below.

The spec shape: a pipeline, not a findAll#

Flux is a piped dataflow language. Stage order is semantics, not sugar:
group |> aggregateWindow aggregates per group; aggregateWindow |> group aggregates first and groups the results. Different numbers.
pivot before a filter changes which columns that filter can even see, because pivot turns fields into columns.
limit before sort takes an arbitrary hundred rows and sorts them; sort before limit takes the top hundred.
A { where, order, limit } object has exactly one implied order, fixed by whoever wrote the compiler, so it cannot express any of that. The spec is therefore a source plus an ordered array of stages — which is what the language is:
interface FluxQuerySpec {
  bucket?: string;         // from(bucket:)   — falls back to the store's default
  bucketID?: string;       // from(bucketID:)
  union?: FluxQuerySpec[]; // union(tables: [...])
  join?: FluxJoinSpec;     // join(tables: {left, right}, on:)
  range?: FluxRange;       // range(start:, stop:) — required for a bucket source
  pipeline?: FluxStage[];  // the stages, in order
  yield?: string;          // shorthand for a trailing yield(name:)
}
The stages still read like familiar ideas — filter takes the ORM's own where, sort takes columns and a direction, limit takes n and offset — so the shape is honest about Flux without being alien.
union and join are heads, not stages, because union() and join() do not receive a piped table; they take whole streams as arguments and so cannot follow a |>. Their sub-queries are hoisted to _t0, _t1, … assignments:
compileFlux({
  union: [
    { bucket: 'a', range: { start: '-1h' }, pipeline: [{ op: 'filter', measurement: 'cpu' }] },
    { bucket: 'a', range: { start: '-1h' }, pipeline: [{ op: 'filter', measurement: 'mem' }] },
  ],
  pipeline: [{ op: 'sort', desc: true }],
});
_t0 = from(bucket: "a")
  |> range(start: -1h)
  |> filter(fn: (r) => r._measurement == "cpu")

_t1 = from(bucket: "a")
  |> range(start: -1h)
  |> filter(fn: (r) => r._measurement == "mem")

union(tables: [_t0, _t1])
  |> sort(columns: ["_time"], desc: true)

The stages#

opCompiles to
rangerange(start:, stop:) — narrow the window again mid-pipeline
filterfilter(fn: (r) => …, onEmpty:)
aggregateWindowaggregateWindow(every:, period:, offset:, fn:, column:, timeSrc:, timeDst:, createEmpty:)
aggregatea bare mean() / sum() / count() / quantile(q:) / …
first, last, max, minthe row selectors, with an optional column:
top, bottomtop(n:, columns:) / bottom(n:, columns:)
group, ungroupgroup(columns:, mode:) / group()
pivotpivot(rowKey:, columnKey:, valueColumn:)
sortsort(columns:, desc:)
limit, taillimit(n:, offset:) / tail(n:, offset:)
mapmap(fn: (r) => ({r with …}))
fillfill(column:, value:) or fill(usePrevious: true)
derivativederivative(unit:, nonNegative:, columns:, timeColumn:, initialZero:)
differencedifference(nonNegative:, columns:, keepFirst:, initialZero:)
movingAverage, exponentialMovingAverage, timedMovingAveragethe three moving averages
windowwindow(every:, period:, offset:, createEmpty:)
cumulativeSum, increaserunning totals
elapsedelapsed(unit:, timeColumn:, columnName:)
distinct, uniquedistinct(column:) / unique(column:)
keep, dropkeep(columns:) / drop(columns:)
rename, duplicate, setcolumn surgery
timeShifttimeShift(duration:, columns:)
toFloat, toInt, toUInt, toString, toBool_value type conversions
yieldyield(name:)
The aggregates usable bare or as aggregateWindow(fn:) are mean, median, sum, count, min, max, first, last, mode, spread, stddev, skew, quantile and integral. The two that take their own arguments cannot be named bare, so they are emitted in the lambda form aggregateWindow also accepts, with the window's column: threaded through:
|> aggregateWindow(every: 1h, fn: (column, tables=<-) => tables |> quantile(q: 0.99, column: column))

filter uses the ORM's own operators#

where is fed through normalizeWhere() from src/graph/types.ts — the single place the Op.* symbol and $string operators are folded into one tree, shared with the Couchbase N1QL and CQL compilers. Re-parsing WhereOptions here would be a second copy that drifts.
OperatorFlux
eq ne gt gte lt lter.x == v, !=, >, >=, <, <=
in / notIncontains(value: r.x, set: [...]), negated
between / notBetween(r.x >= a and r.x <= b), negated
isNull / isNotNullnot exists r.x / exists r.x — Flux has no NULL
like notLike iLike notILikean anchored regex, %→.* and _→.
startsWith endsWith substring (+ negations)strings.hasPrefix / hasSuffix / containsStr
regexp / notRegexpr.x =~ /…/ / !~
startsWith and friends deliberately do not compile to a regex: the caller supplied a literal, not a pattern, so a % or a . in it must stay itself. The strings package functions treat it as text, and the import "strings" line is added to the script automatically.
There are also shorthands, because measurement/field/tag filtering is most of what anyone writes:
{ op: 'filter', measurement: 'cpu', field: ['usage_user', 'usage_system'], tags: { host: 'web-1' } }
An array becomes contains(...); a scalar becomes ==. A filter with none of measurement / field / tags / where is refused rather than emitted, since an empty predicate silently matches everything.

Numbers are floats unless you say otherwise#

Flux is strictly typed and will not compare a float column to an int. This store's own writer defaults numeric fields to floatField, so a bare JavaScript number compiles to a float literal — 5 becomes 5.0. When the column really is an integer, say so:
{ op: 'filter', where: { retries: { [Op.gte]: { int: 3 } } } }
{ float }, { int }, { uint }, { duration }, { time } and { regex } are all accepted anywhere a value is.

Escaping is the whole safety story#

Flux has no bind parameters through this driver. @influxdata/influxdb-client@1.35 builds its query request as {query, dialect, type} — there is no params field, so InfluxDB's server-side params mechanism is unreachable here. The driver's fluxString / fluxDuration / flux `` helpers are client-side escapers, not bindings: they concatenate into the script exactly as this compiler does. So there is nothing to bind to, and correctness of escaping is the only thing between a caller's value and an altered script. src/graph/sparql/terms.ts is in the same position for SPARQL, and this module follows its discipline: one audited place where a JavaScript value becomes query text.
Escaped — strings, because a Flux string literal can carry anything once \, ", LF, CR and TAB are escaped. Two details that are easy to get wrong:
Other control characters are refused, not mangled: Flux's grammar has no escape form for them.
${ is escaped to \${, because a Flux string literal interpolates. "${r.token}" is an expression, not six characters. A value containing ${…} would otherwise be evaluated inside the script. The driver's own fluxString does not do this.
Validated and refused — everything that reaches the script unquoted, because there is no quoting form to escape to:
ThingRule
Durations (every, unit, offset, timeShift)-?(\d+(ns|us|ms|s|m|h|d|w|mo|y))+
Times (range.start, range.stop)a duration, RFC3339, a Date, epoch ms, or { now: true }
map output columns, rename source and target[A-Za-z_][A-Za-z0-9_]* — they are record keys
Aggregate function names, map function namesa fixed whitelist
mode, method, onEmpty, map modea fixed set of literals
n, offset, desc, createEmpty, …non-negative integers / real booleans
A bad identifier is rejected, never rewritten: silently turning user id into user_id would produce a column the caller never asked for.
Column names are escaped, because r["a b"] is a genuine string literal. The dot form r.host is used when the name is an identifier, purely for readability; the bracket form is the always-correct fallback, so any column name at all is expressible.
Regular expressions are both validated and escaped. / terminates a Flux regex literal, so every unescaped one is escaped; control characters are refused; the pattern must compile; and lookaround and backreferences are refused because Flux runs Go's RE2, which does not implement them — shipping one would only fail server-side. Patterns are capped at 1024 characters. RE2 is linear-time, so catastrophic backtracking is not reachable on the server, and this compiler only ever constructs a caller's pattern, never executes it, so it cannot backtrack here either.

What is refused, and why#

FluxCapabilityError — a typed error naming the feature, following the GraphCapabilityError pattern — rather than a script the server would reject:
RefusedReason
A bucket source with no rangeFlux requires range() immediately after from(). Emitting the from() alone would be a guaranteed server error.
A join method other than inneruniverse.join() documents the others but implements only inner; the newer join package (join.left, join.full, …) takes as: functions rather than an on: column list, a different shape this spec does not model.
An aggregate name outside the whitelistIt is emitted unquoted, so a closed set is the only safe design.
A map function outside the whitelistSame reason.
A stage op the compiler does not emitNamed in the error so you can see what to reach for query() for.
ValidationError covers the malformed rather than the impossible: a non-duration duration, a non-RFC3339 time, a record key that is not an identifier, a fill with both value and usePrevious (or neither), an empty filter, a union of fewer than two streams, a range on a union/join spec, q outside 0..1, a non-integer n.

Flux only — the InfluxQL decision#

InfluxDB 1.x speaks InfluxQL, 2.x speaks Flux and can speak InfluxQL through a 1.x compatibility endpoint, 3.x has moved to SQL over Flight. This compiler models Flux only, and the reason is the transport rather than taste:
@influxdata/influxdb-client posts to /api/v2/query with a request body whose type its own TypeScript declares as the literal 'flux' (QueryOptions.type?: 'flux').
The InfluxQL compatibility endpoint is a different HTTP path (/query) and needs DBRP mappings. This client cannot address it at all.
InfluxDB 3.x's SQL needs an entirely different client (@influxdata/influxdb3-client, over Flight).
An InfluxQL compiler here could never be executed by this store — it would be dead code with a test suite attached. If the store ever gains a 1.x or 3.x transport, that transport gets its own compiler beside this one rather than a mode flag inside it.

Not modelled, on purpose#

to() and other write stages. Reading and writing stay separate surfaces; the buffered write path is the one to use, and it is untouched.
location: on aggregateWindow/window. It takes a timezone record from the timezone package, a shape with its own import and semantics.
histogram / histogramQuantile / holtWinters / stateDuration. Real Flux functions, but each has enough of its own argument surface to deserve its own design pass rather than a hurried stage.
strings.* beyond the handful in the map whitelist, and the regexp, json, experimental and sql packages.
Arbitrary Flux variables, functions and option declarations. A script that defines its own functions is a program, not a query. query() is there for that.
The older findAll / aggregate / count methods on the store are unchanged. They remain a convenience shim with their own predicate pushdown (./flux-compiler); the pipeline API above is the one that covers Flux properly.

Verification status#

Unit / mock-verified only, like the rest of InfluxDBStore. tests/nosql/influxdb-flux.test.ts tests the compiler as a pure function — no driver at all — and tests/nosql/influxdb-flux-store.test.ts runs the compiled scripts against the in-memory driver mock.
Every construct asserts the whole compiled script, character for character. Every value-carrying position is fed a payload that tries to close its own literal and append |> drop(columns: [...]), and the result is asserted to be either exactly escaped or refused — again by exact match, because a test that only checked the payload "appears somewhere" would pass against a compiler that interpolated it.
Not verified: behaviour against a real InfluxDB 2.x server — in particular whether every emitted argument name exists on the target Flux version (Flux's function signatures have shifted across 0.x releases), and RE2's acceptance of a pattern that JavaScript's engine compiled.

Related reading#

src/nosql/influxdb/README.md — the store itself: connection lifecycle, points, and the write-buffering gotcha
Query operators — the Op.* surface being compiled
Couchbase (N1QL) — the same structured-query treatment for a document store
SPARQL / RDF triplestores — the other language here with no wire-level parameter binding
Modified at 2026-10-04 00:40:16
Previous
Indexes & constraints
Next
klock-errors
Built with