Run River

Description

This job runs a River in Rivery using this endpoint.

Use Cases

We recommend creating a Run River task for each Rivery River.

This way, you can use Orchestra to trigger your data ingestion on a manual or event based schedule. This has a number of advantages vs. using Rivery's in-built scheduler:

• You can coordinate tasks outside of Rivery, like other ingestion tools for connectors Rivery doesn't support, using Orchestra.

• You can coordinate multiple rivers in Rivery to occur at the same time. By creating the tasks in parallel in Orchestra you will only need to change the schedule in one place instead of modifying the schedule of each river individually in Rivery.

• When Rivery rivers run, both Rivery Pricing Unit Credits and Data Warehouse costs are incurred. Running these operations on a schedule you set explicitly ensures these costs do not go out of hand.

• We aggregate metadata from the Rivery Task in the same place as the metadata from other operations in your Pipeline

Parameters

These parameters are required to run the Run River task

Name	Data type	Restrictions	Example
River ID	String	N.A.	abcdefghi123456789

Error handling

Rate limiting

Rivery has strict throttling limits, so ensure your pipeline configuration in Orchestra will not surpass these limits. The below text is taken from the Rivery API documentation:

Throttling rules: * River can be executed up to 2 times per minute * Each user can execute a river up to 15 times per minute

API Requests

If we receive the following error codes from Rivery, we'll raise an error and the task will move to a failed state.

Status Code	Description	Handling
429	Rate limits exceeded	Orchestra fails your task. Rivers shouldn't be run this frequently
401	Invalid API token	Orchestra cannot start the River run
403	Invalid Account ID or Environment ID	Orchestra cannot start the River run
404	River ID is wrong	Orchestra cannot find the River to start