Config

The default location for a project's rngo config is .rngo/config.yml. Usually it gets added to the repo by the rngo init command. It should be checked into version control.

streams

A map from stream names to stream objects. For example:

streams:
  users:
    outputs:
      - format: csv
    schema:
    #...

In this case, the name of the stream is users. Stream objects can have the following keys:

schema

A required JSON schema that defines the structure of the stream's data. For example:

streams:
  users:
    schema:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string

See Schema

systems

An optional map from of system names to stream-specific configuration. For example:

streams:
  users:
    systems:
      db:
        table: USER

In this case, the users stream is configured as part of the db system and the table parameter is set to USER.

If a stream belongs to a system, but does not define any parameters, set the value to {}:

streams:
  users:
    systems:
      db: {}

See Stream Systems .

outputs

An optional list of output formats for the stream's data. For example:

streams:
  users:
    outputs:
      - format: csv

See Outputs

systems

An optional map from system names to system objects. For example:

systems:
  db:
    type: postgres
    parameters:
      host:
        value: localhost

In this case, the name of the system is db. System objects can have the following keys:

type

A required string that specifies the type of the system. For example:

systems:
  db:
    type: postgres

Currently, postgres is the only supported value.

parameters

An optional map from parameter names to parameter objects. For example:

systems:
  db:
    type: postgres
    parameters:
      port:
        default: 5432

In this case, the db system has a port parameter with a default value of 5432. See System Parameters.