Starlark transformation syntax for qri datasets
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
context
ds
qri
testdata
.gitignore
CHANGELOG.md
LICENSE
README.md
codecov.yml
entry_reader.go
entry_reader_test.go
http.go
package.json
startf.go
transform.go
transform_test.go

README.md

Qri GoDoc License Codecov CI Go Report Card

Qri Starlark Transformation Syntax

Qri ("query") is about datasets. Transformations are repeatable scripts for generating a dataset. Starlark is a scripting language from Google that feels a lot like python. This package implements starlark as a transformation syntax. Starlark tranformations are about as close as one can get to the full power of a programming language as a transformation syntax. Often you need this degree of control to generate a dataset.

Typical examples of a starlark transformation include:

  • combining paginated calls to an API into a single dataset
  • downloading unstructured structured data from the internet to extract
  • pulling raw data off the web & turning it into a datset

We're excited about starlark for a few reasons:

  • python syntax - many people working in data science these days write python, we like that, starlark likes that. dope.
  • deterministic subset of python - unlike python, starlark removes properties that reduce introspection into code behaviour. things like while loops and recursive functions are omitted, making it possible for qri to infer how a given transformation will behave.
  • parallel execution - thanks to this deterministic requirement (and lack of global interpreter lock) starlark functions can be executed in parallel. Combined with peer-2-peer networking, we're hoping to advance tranformations toward peer-driven distribed computing. More on that in the coming months.

Getting started

If you're mainly interested in learning how to write starlark transformations, our documentation is a better place to start. If you're interested in contributing to the way starlark transformations work, this is the place!

The easiest way to see starlark transformations in action is to use qri. This startf package powers all the starlark stuff in qri. Assuming you have the go programming language the following should work from a terminal:

# get this package
$ go get github.com/qri-io/startf

# navigate to package
$ cd $GOPATH/src/github.com/qri-io/startf

# run tests
$ go test ./...

Often the next steps are to install qri, mess with this startf package, then rebuild qri with your changes to see them in action within qri itself.

Starlark Special Functions

Special Functions are the core of a starlark transform script. Here's an example of a simple data function that sets the body of a dataset to a constant:

def transform(ds,ctx):
  ds.set_meta(["hello","world"])

Here's something slightly more complicated (but still very contrived) that modifies a dataset by adding up the length of all of the elements in a dataset body

def transform(ds, ctx):
  body = qri.get_body()
  if body != None:
    count = 0
    for entry in body:
      count += len(entry)
  ds.set_body([{"total": count}])

Starlark special functions have a few rules on top of starlark itself:

  • special functions always accept a transformation context (the ctx arg)
  • When you define a data function, qri calls it for you
  • All special functions are optional (you don't need to define them), except transform. transform is required.
  • Special functions are always called in the same order

More docs on the provide API is coming soon.

Running a transform

Let's say the above function is saved as transform.star. First, create a dataset file (saved as dataset.yaml, for example) with at least the minimal structure:

name: dataset_name
transform:
  scriptpath: transform.star
  config:
    org: qri-io
    repo: frontend

Then invoke qri:

qri save --file=config.yaml

Fun! More info over on our docs site