get_runs: Get a tibble of all runs for the provided instance/recipe

In MarHai/ScrapeBotR: Orchestrate Instances and Retrieve Data from a ScrapeBot Database

Description

A run represents one execution of a recipe on a certain instance. For this function to provide meaningful results, you need to ...

• specify only instance_uid to list all runs on a specific instance

• specify only recipe_uid to list all runs for a specific recipe

• specify both instance_uid and recipe_uid to list all runs of a specific recipe on a given instance

Usage

get_runs(connection, instance_uid = NULL, recipe_uid = NULL)

Arguments

connection	A connection object, as retrieved from connect_scrapebot().
instance_uid	Numeric UID or a vector of numeric UIDs of the instance to filter runs for. If NULL, recipe_uid has to be provided. Defaults to NULL.
recipe_uid	Numeric UID or a vector of numeric UIDs of the recipe to filter runs for. If NULL, instance_uid has to be provided. Defaults to NULL.

Details

The function will yield an error if neither one of instance/recipe is provided. Note that the resulting tibble might be rather large and the request could take some time.

Value

A tibble listing all runs including their UID, the UID of the run's recipe, the UID of the run's instance, the date when the run started, its runtime (in seconds), and the status (one of: success, error, config_error, command_not_found, in_progress).

See Also

get_run_data(), get_run_log()

Examples

## Not run: 

connection <- connect('my_db on localhost')
get_runs(connection, instance_uid = 42, recipe_uid = 21)
get_runs(connection, instance_uid = 42)
get_runs(connection, recipe_uid = 21)
disconnect(connection)

## End(Not run)

MarHai/ScrapeBotR documentation built on March 10, 2021, 10:10 a.m.