append_values_to_stream: Append a record, consisting of named parameters, to a stream.

Description Usage Arguments Value Examples

View source: R/append_to_stream.R

Description

Append a record, consisting of named parameters, to a stream. Each value must be an atomic vector of length one. If the data.world API returns an HTTP status of 429 (Too Many Requests), this function uses RETRY to retry the request.

Usage

1
2
3
4
5
6
7
8
append_values_to_stream(
  owner_id,
  dataset_id,
  stream_id,
  retry_times = 3,
  retry_quiet = FALSE,
  ...
)

Arguments

owner_id

User name and unique identifier of the creator of a dataset or project

dataset_id

Dataset unique identifier

stream_id

Stream unique identifier as defined by the user the first time the stream was used. Only lower case letters, numbers and dashes are allowed.

retry_times

the number of times to retry the request

retry_quiet

whether to suppress diagnostic messages during retries

...

named parameters giving the variables and values in the record to be streamed

Value

Server response message.

Examples

1
2
3
4
5
6
## Not run: 
  dwapi::append_values_to_stream(owner_id = 'user',
    dataset_id = 'dataset', stream_id = 'mystream',
    ID=1, Value='One')

## End(Not run)

datadotworld/dwapi-r documentation built on July 3, 2021, 3:40 a.m.