doc.md

Table of Contents

• Types
• API
  • createDataGraph
  • writeSQL
• Graph
  • nodes
  • getState
  • data
• Data
  • getState
  • transform
  • toSQL
  • values

Types

• See: Data Graph Types
• See: Transform Types

Library type definitions are declared in the flow-typed/ folder.

API

The exported module

createDataGraph

Creates a SQL data graph instance.

Parameters

• connector Connector
• initialState GraphState (optional, default {})

Returns Graph

writeSQL

Returns a SQL query string based on the DataState passed in.

Parameters

• state DataState

Returns string

Graph

An instance of a SQL data graph

nodes

Returns all data node instances of the graph.

Returns Array<DataNode>

getState

Returns the state of the graph.

Returns GraphState

data

Creates a data node instance.

Parameters

• state DataState

Returns DataNode

Data

A node in the graph that represents a set of data transformations.

getState

Returns the state of the data node.

Returns DataState

transform

Sets the transform state of the data node.

Parameters

• transform (Transform | Array<Transform>)

Returns DataNode

toSQL

Returns the SQL string representation of the set of data transformations the node embodies.

Returns string

values

Executes data node's SQL query representation and returns queried data as a promise.

Returns Promise<Array<any>>