FerricStore.Flow.QueryProjection (ferricstore_sdk v0.6.2)

Copy Markdown View Source

Builds bounded, source-aware sparse return projections for FQL1 queries.

The input query must start with FROM runs or FROM events and must not already contain a RETURN clause.

Summary

Types

field()
shape()

Functions

project(query, shape, fields)

Types

field()

@type field() ::
  atom()
  | {:attribute, binary()}
  | {:state_meta, binary(), binary()}
  | {:event_field, binary()}

shape()

@type shape() :: :record | :records

Functions

project(query, shape, fields)

@spec project(binary(), shape(), [field()]) ::
  {:ok, binary()} | {:error, {:invalid_flow_query_projection, atom()}}