| Title: | Create and Emit 'OpenLineage' Events |
| Version: | 0.2.0 |
| Description: | Construct and validate run events that follow the 'OpenLineage' specification https://openlineage.io/. Model run lifecycles, datasets, and extensible facets with protocol-aware 'R' objects. Serialize events into deterministic JavaScript Object Notation (JSON) while preserving wire field names. Deliver events synchronously over Hypertext Transfer Protocol (HTTP) with authentication and retries, or use offline transports for local development and testing. |
| License: | MIT + file LICENSE |
| URL: | https://github.com/pedrobtz/openlineage, https://pedrobtz.github.io/openlineage/ |
| BugReports: | https://github.com/pedrobtz/openlineage/issues |
| Depends: | R (≥ 4.1.0) |
| Encoding: | UTF-8 |
| Language: | en-US |
| Suggests: | knitr (≥ 1.42), rmarkdown (≥ 2.20), testthat (≥ 3.2.2), withr (≥ 2.5.0) |
| Config/testthat/edition: | 3 |
| VignetteBuilder: | knitr |
| Imports: | cli (≥ 3.0.0), httr2 (≥ 1.2.0), jsonlite (≥ 1.8.0), R6 (≥ 2.5.0), S7 (≥ 0.2.0), uuid (≥ 1.1-0) |
| Config/roxygen2/version: | 8.1.1 |
| NeedsCompilation: | no |
| Packaged: | 2026-11-19 15:54:25 UTC; pbtz |
| Author: | Pedro Baltazar [aut, cre, cph] |
| Maintainer: | Pedro Baltazar <pedrobtz@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2026-11-19 18:00:02 UTC |
Create and Emit OpenLineage Events
Description
Build validated OpenLineage 2.0.2 run events, serialize them to the protocol wire format, and emit them through local or synchronous HTTP transports.
Main workflow
Create a Run, Job, and optional input/output datasets, then combine them in a RunEvent. An OpenLineageClient emits the event through an injected transport or through HTTP configured by constructor arguments or environment variables.
Facets and extensions
Typed facet constructors cover common metadata. Use ol_facet to attach a facet schema that does not yet have a typed R constructor.
Author(s)
Maintainer: Pedro Baltazar pedrobtz@gmail.com [copyright holder]
Authors:
Pedro Baltazar pedrobtz@gmail.com [copyright holder]
See Also
OpenLineageClient, RunEvent, local_transports, HttpTransport
Synchronous HTTP transport
Description
Sends OpenLineage events as JSON POST requests. The base url and
relative endpoint are joined with one slash; a URL that already ends in
the endpoint is not duplicated.
Supply api_key for Authorization: Bearer <key> authentication, or place
authentication headers in headers. Supplying both an API key and a custom
Authorization header is an error. All custom headers are redacted from
httr2 request printing.
HTTP 429, 500, 502, 503, and 504 responses and low-level connection
failures are retried up to max_retries times. The delay is the response's
Retry-After, in seconds or as an HTTP date, capped at 60 seconds;
otherwise it doubles from 1 second up to 30. HTTP 401 and 403 responses
are never retried. Redirects are not followed: a 3xx response raises an
openlineage_http_error, so that neither the event nor a credential
header is sent to another location.
Delivery is at least once. A retry after a timeout, or libcurl resending a request on a connection the server closed, can deliver an event twice, so consumers should deduplicate, as OpenLineage backends do by run ID, event type and event time.
Set verify_tls = FALSE only for controlled development environments;
doing so raises an openlineage_insecure_tls_warning.
Value
An R6 HTTP transport object.
Super class
OpenLineageTransport -> HttpTransport
Methods
Public methods
Inherited methods
OpenLineageTransport$close()
HttpTransport$new()
Create an HTTP transport.
Usage
HttpTransport$new( url, endpoint = "api/v1/lineage", api_key = NULL, headers = character(), timeout = 5, verify_tls = TRUE, max_retries = 3L )
Arguments
urlAn absolute HTTP or HTTPS base URL.
endpointA relative OpenLineage endpoint path.
api_keyAn optional bearer API key.
headersOptional custom headers as a named character vector.
timeoutA request timeout in seconds, between 0.001 and 2147483.
verify_tlsWhether to verify TLS certificates.
max_retriesA non-negative number of retries after the first request attempt.
Returns
A new HttpTransport object.
HttpTransport$emit()
Send an event to the configured OpenLineage HTTP endpoint.
Usage
HttpTransport$emit(event)
Arguments
eventA
RunEventmodel.
Returns
event, invisibly, after a successful HTTP response.
HttpTransport$print()
Print a redacted transport summary.
Usage
HttpTransport$print(...)
Arguments
...Unused.
Returns
The transport, invisibly.
HttpTransport$clone()
The objects of this class are cloneable with this method.
Usage
HttpTransport$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
See Also
Examples
transport <- HttpTransport$new("https://example.com")
transport
OpenLineage job
Description
Identifies a job within a producer-defined namespace.
Usage
Job(namespace, name, facets = list())
Arguments
namespace |
A non-empty namespace string. |
name |
A non-empty job name. |
facets |
A named list of job facets, or |
Value
A Job S7 object.
Examples
Job("example-scheduler", "daily-report")
OpenLineage client
Description
Coordinates event emission through an OpenLineage transport. Supply a
transport directly for local or custom delivery, or configure the built-in
HTTP transport with url and related arguments.
When an argument is absent, the client reads OPENLINEAGE_URL,
OPENLINEAGE_ENDPOINT, OPENLINEAGE_API_KEY, and
OPENLINEAGE_DISABLED. Explicit arguments take precedence over their
environment equivalents. OPENLINEAGE_DISABLED accepts only true or
false, ignoring case and surrounding whitespace.
A disabled client uses NoopTransport. An injected transport takes
precedence over HTTP environment variables. Supplying transport
together with url, api_key or any other HTTP argument is an error,
also when the client is disabled. If neither a transport nor URL
is configured, the client uses ConsoleTransport. Supplying partial HTTP
settings without a URL is an error.
Value
An R6 OpenLineage client object.
Public fields
transportThe configured OpenLineage transport.
Methods
Public methods
OpenLineageClient$new()
Create an OpenLineage client.
Usage
OpenLineageClient$new( transport = NULL, url = NULL, endpoint = "api/v1/lineage", api_key = NULL, headers = character(), timeout = 5, verify_tls = TRUE, max_retries = 3L, disabled = NULL )
Arguments
transportAn optional R6 transport with an
emit(event)method.urlAn optional HTTP or HTTPS base URL. If
NULL,OPENLINEAGE_URLis used when set.endpointA relative OpenLineage endpoint path. If omitted,
OPENLINEAGE_ENDPOINTis used when set.api_keyAn optional bearer API key. If
NULL,OPENLINEAGE_API_KEYis used when set.headersOptional custom HTTP headers as a named character vector.
timeoutA positive HTTP request timeout in seconds.
verify_tlsWhether to verify TLS certificates.
max_retriesA non-negative number of HTTP retries after the first request attempt.
disabledWhether to disable emission. If
NULL,OPENLINEAGE_DISABLEDis used when set.
Returns
A new OpenLineageClient object.
OpenLineageClient$emit()
Emit an OpenLineage event through the configured transport.
Usage
OpenLineageClient$emit(event)
Arguments
eventA
RunEventmodel.
Returns
event, invisibly, after successful delivery.
OpenLineageClient$close()
Close the transport, finishing any pending work. The built-in
transports have none. A custom transport without a close() method
is left as it is.
Usage
OpenLineageClient$close()
Returns
The value of the transport's close(), invisibly, or TRUE
when it has none.
OpenLineageClient$print()
Print a credential-free client summary.
Usage
OpenLineageClient$print(...)
Arguments
...Unused.
Returns
The client, invisibly.
OpenLineageClient$clone()
The objects of this class are cloneable with this method.
Usage
OpenLineageClient$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
See Also
local_transports, HttpTransport
Examples
transport <- AccumulatingTransport$new()
client <- OpenLineageClient$new(transport = transport, disabled = FALSE)
event <- RunEvent(
Run(new_run_id()),
Job("example", "task"),
event_type = "START"
)
client$emit(event)
length(transport$events)
OpenLineage run
Description
Identifies one execution of an OpenLineage job.
Usage
Run(run_id, facets = list())
Arguments
run_id |
A valid UUID string. |
facets |
A named list of run facets, or |
Value
A Run S7 object.
Examples
Run(new_run_id())
OpenLineage run event
Description
Describes a lifecycle transition for one job run and its input and output datasets.
Usage
RunEvent(
run,
job,
event_type = NULL,
event_time = new_event_time(),
inputs = list(),
outputs = list(),
producer = OPENLINEAGE_PRODUCER,
schema_url = OPENLINEAGE_RUN_EVENT_SCHEMA_URL
)
Arguments
run |
A |
job |
A |
event_type |
A |
event_time |
An RFC 3339 date-time string with a time-zone offset. |
inputs |
An unnamed list of |
outputs |
An unnamed list of |
producer |
A URI identifying the event producer. |
schema_url |
The RunEvent JSON Schema URL. |
Value
A RunEvent S7 object.
Examples
run <- Run(new_run_id())
job <- Job("example-scheduler", "daily-report")
RunEvent(
run,
job,
event_type = "START",
event_time = new_event_time(as.POSIXct("2026-01-02", tz = "UTC"))
)
OpenLineage run state
Description
A validated lifecycle state for an OpenLineage run.
Usage
RunState(value)
Arguments
value |
One of |
Value
A RunState S7 object.
Examples
RunState("START")
Convert an OpenLineage value to its wire representation
Description
Recursively converts OpenLineage S7 models to named R lists. Protocol field
names are applied here, RunState values are unwrapped, and NULL
properties are omitted. Object key order is deterministic; array order is
preserved.
Usage
as_openlineage_list(x)
Arguments
x |
An OpenLineage model or supported nested value. |
Value
A named list for a model, or the corresponding wire value for a nested value.
Examples
run <- Run("019c0000-0000-7000-8000-000000000001")
as_openlineage_list(run)
Column-lineage dataset facet
Description
Constructors for column-level lineage: which input columns each output column of a dataset was computed from, and which input columns affect the whole dataset.
Usage
ColumnLineageTransformation(
type,
subtype = NULL,
description = NULL,
masking = NULL
)
ColumnLineageInputField(namespace, name, field, transformations = list())
ColumnLineageDatasetFacet(
fields = list(),
dataset = list(),
producer = OPENLINEAGE_PRODUCER,
deleted = NULL
)
Arguments
type |
The transformation type, such as |
subtype |
An optional transformation subtype, such as |
description |
An optional description of the transformation. May be empty, as the specification allows. |
masking |
An optional flag: whether the transformation masks the data. |
namespace, name |
The input dataset namespace and name. |
field |
The input column name. |
transformations |
An unnamed list of |
fields |
A named list keyed by output column name. Each element is an
unnamed list of |
dataset |
An unnamed list of |
producer |
A URI identifying the facet producer. |
deleted |
Whether this facet deletes a previously emitted facet. |
Details
fields is keyed by output column name. Each element is an unnamed list
of ColumnLineageInputField objects, possibly empty, and serializes as
{"inputFields": [...]}. The facet is usually attached to an output
dataset under the key columnLineage.
The specification describes type as "DIRECT" or "INDIRECT" and
leaves subtype free. OpenLineage documents "IDENTITY",
"TRANSFORMATION" and "AGGREGATION" for direct transformations and
"JOIN", "GROUP_BY", "FILTER", "SORT", "WINDOW" and
"CONDITIONAL" for indirect ones. Both are typed as free strings in the
JSON schema, so other values are accepted, as in the Python client. The
deprecated per-column transformationDescription and
transformationType properties are not supported.
Value
A column-lineage facet, input-field or transformation S7 object.
See Also
https://openlineage.io/spec/facets/1-2-0/ColumnLineageDatasetFacet.json
Examples
direct <- ColumnLineageTransformation("DIRECT", "IDENTITY", masking = FALSE)
filter <- ColumnLineageTransformation("INDIRECT", "FILTER")
customers <- function(field, transformation) {
ColumnLineageInputField(
"postgres://warehouse",
"public.customers",
field,
list(transformation)
)
}
facet <- ColumnLineageDatasetFacet(
fields = list(customer_name = list(customers("name", direct))),
dataset = list(customers("active", filter))
)
OutputDataset(
"postgres://warehouse",
"analytics.customers",
facets = list(columnLineage = facet)
)
Typed dataset facets
Description
Constructors for dataset-level schema, data-source, and tag metadata.
Usage
SchemaField(
name,
type = NULL,
description = NULL,
ordinal_position = NULL,
fields = list()
)
SchemaDatasetFacet(
fields = list(),
producer = OPENLINEAGE_PRODUCER,
deleted = NULL
)
DatasourceDatasetFacet(
name = NULL,
uri = NULL,
producer = OPENLINEAGE_PRODUCER,
deleted = NULL
)
Arguments
name |
A field or data-source name. |
type |
An optional field type. |
description |
An optional field description. |
ordinal_position |
An optional one-based field position. |
fields |
For |
producer |
A URI identifying the facet producer. |
deleted |
Whether this facet deletes a previously emitted facet. |
uri |
An optional data-source URI. |
Value
A typed dataset facet or schema-field S7 object.
Examples
field <- SchemaField("order_id", "INTEGER", ordinal_position = 1L)
SchemaDatasetFacet(list(field))
DatasourceDatasetFacet("warehouse", "postgres://warehouse")
OpenLineage datasets
Description
Dataset identifies a dataset. InputDataset and OutputDataset add
lifecycle-specific facet maps and are the only dataset types accepted by a
RunEvent.
Usage
Dataset(namespace, name, facets = list())
InputDataset(namespace, name, facets = list(), input_facets = list())
OutputDataset(namespace, name, facets = list(), output_facets = list())
Arguments
namespace |
A non-empty namespace string. |
name |
A non-empty dataset name. |
facets |
A named list of dataset facets, or |
input_facets |
A named list of input facets, or |
output_facets |
A named list of output facets, or |
Value
A Dataset, InputDataset, or OutputDataset S7 object.
Examples
Dataset("postgres://warehouse", "analytics.orders")
InputDataset("postgres://warehouse", "raw.orders")
OutputDataset("postgres://warehouse", "analytics.orders")
Input and output statistics facets
Description
Input and output statistics facets
Usage
InputStatisticsInputDatasetFacet(
row_count = NULL,
size = NULL,
file_count = NULL,
producer = OPENLINEAGE_PRODUCER
)
OutputStatisticsOutputDatasetFacet(
row_count = NULL,
size = NULL,
file_count = NULL,
producer = OPENLINEAGE_PRODUCER
)
Arguments
row_count |
The optional number of rows read or written. |
size |
The optional number of bytes read or written. |
file_count |
The optional number of files read or written. |
producer |
A URI identifying the facet producer. |
Value
A typed input- or output-dataset facet S7 object.
Examples
InputStatisticsInputDatasetFacet(row_count = 100L)
OutputStatisticsOutputDatasetFacet(row_count = 100L, size = 2048L)
Typed job facets
Description
Constructors for SQL, source location, and job-type metadata.
Usage
SQLJobFacet(
query,
dialect = NULL,
producer = OPENLINEAGE_PRODUCER,
deleted = NULL
)
SourceCodeLocationJobFacet(
type,
url,
repo_url = NULL,
path = NULL,
version = NULL,
tag = NULL,
branch = NULL,
pull_request_number = NULL,
producer = OPENLINEAGE_PRODUCER,
deleted = NULL
)
EmissionPattern(event_trigger, event_content_mode, window_duration = NULL)
JobTypeJobFacet(
processing_type,
integration,
job_type = NULL,
emission_pattern = NULL,
producer = OPENLINEAGE_PRODUCER,
deleted = NULL
)
Arguments
query |
The SQL query text. |
dialect |
An optional SQL dialect. |
producer |
A URI identifying the facet producer. |
deleted |
Whether this facet deletes a previously emitted facet. |
type |
The source-control system type. |
url |
The full source-code URL. |
repo_url, path, version, tag, branch, pull_request_number |
Optional source location details. |
event_trigger |
When events are emitted. |
event_content_mode |
Whether events accumulate or contain snapshots. |
window_duration |
An optional positive duration in seconds. |
processing_type |
The processing type, such as |
integration |
The integration name, such as |
job_type |
An optional integration-specific job type. |
emission_pattern |
An optional |
Value
A typed job facet or emission-pattern S7 object.
Examples
SQLJobFacet("SELECT 1", dialect = "ansi")
SourceCodeLocationJobFacet(
"git",
"https://github.com/example/project/blob/main/job.R"
)
pattern <- EmissionPattern("EVENT_BASED", "COMPLETE_SNAPSHOT")
JobTypeJobFacet("BATCH", "R", emission_pattern = pattern)
Local OpenLineage transports
Description
Offline transports for testing, local development, and disabled emission.
Every emit(event) method accepts a RunEvent model and returns that event
invisibly after success.
Details
AccumulatingTransport stores emitted models in its public events list.
Its clear() method removes all accumulated events and returns the transport
invisibly.
ConsoleTransport writes one indented JSON event to stream. Set
pretty = FALSE for single-line output.
NoopTransport validates an event but performs no output or storage.
All transports provide close(), which returns TRUE invisibly because the
local transports have no pending work.
Value
An R6 transport object.
Super class
OpenLineageTransport -> AccumulatingTransport
Public fields
eventsEmitted
RunEventmodels in emission order.
Methods
Public methods
Inherited methods
OpenLineageTransport$close()
AccumulatingTransport$new()
Create an empty accumulating transport.
Usage
AccumulatingTransport$new()
Returns
A new AccumulatingTransport object.
AccumulatingTransport$emit()
Store an event.
Usage
AccumulatingTransport$emit(event)
Arguments
eventA
RunEventmodel.
Returns
event, invisibly.
AccumulatingTransport$clear()
Remove all stored events.
Usage
AccumulatingTransport$clear()
Returns
The transport, invisibly.
AccumulatingTransport$clone()
The objects of this class are cloneable with this method.
Usage
AccumulatingTransport$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Super class
OpenLineageTransport -> ConsoleTransport
Methods
Public methods
Inherited methods
OpenLineageTransport$close()
ConsoleTransport$new()
Create a console transport.
Usage
ConsoleTransport$new(stream = stdout(), pretty = TRUE)
Arguments
streamAn open, writable R connection.
prettyWhether JSON should be indented.
Returns
A new ConsoleTransport object.
ConsoleTransport$emit()
Serialize and write an event to the configured connection.
Usage
ConsoleTransport$emit(event)
Arguments
eventA
RunEventmodel.
Returns
event, invisibly.
ConsoleTransport$clone()
The objects of this class are cloneable with this method.
Usage
ConsoleTransport$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Super class
OpenLineageTransport -> NoopTransport
Methods
Public methods
Inherited methods
OpenLineageTransport$close()
NoopTransport$emit()
Validate an event without emitting it.
Usage
NoopTransport$emit(event)
Arguments
eventA
RunEventmodel.
Returns
event, invisibly.
NoopTransport$clone()
The objects of this class are cloneable with this method.
Usage
NoopTransport$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
transport <- AccumulatingTransport$new()
event <- RunEvent(
Run(new_run_id()),
Job("example", "task"),
event_type = "START"
)
transport$emit(event)
length(transport$events)
console <- ConsoleTransport$new(pretty = FALSE)
noop <- NoopTransport$new()
noop$emit(event)
Format an OpenLineage event time
Description
Converts an R date-time to an ISO 8601 UTC timestamp with millisecond
precision, suitable for the eventTime field of an OpenLineage event.
Usage
new_event_time(time = Sys.time())
Arguments
time |
A single, non-missing |
Details
Sub-millisecond digits are truncated, not rounded, as in the OpenLineage Python client. The year must be between 0001 and 9999, the range that RFC 3339 can express.
Value
A single UTC timestamp string.
Examples
time <- as.POSIXct("2026-01-02 03:04:05", tz = "UTC")
new_event_time(time)
Generate a run identifier
Description
Generates a random UUID suitable for the runId field of an OpenLineage
run. The UUID version is an implementation detail and may change.
Usage
new_run_id()
Value
A single UUID string.
Examples
new_run_id()
Create a generic OpenLineage facet
Description
Creates a facet for extensions or facet schemas without a typed constructor.
Names supplied through ... are preserved exactly at the JSON boundary.
Usage
ol_facet(..., schema_url, producer = OPENLINEAGE_PRODUCER, deleted = NULL)
Arguments
... |
Named facet fields using their OpenLineage wire names, and the
schema URL as the one unnamed argument when |
schema_url |
The URI of the facet's JSON Schema definition. |
producer |
A URI identifying the facet producer. |
deleted |
Whether this facet deletes a previously emitted job or
dataset facet. Use only where the target schema supports |
Details
The schema URL is either named schema_url or given as the one unnamed
argument, usually the first. schema_url, producer and deleted come
after ..., so they are matched only by their full names: a field such as
schema or prod is a field, never a partial match for an argument.
Field values map to JSON as follows:
A length-1 vector is a JSON scalar. Wrap it in
I()(I("only")) or alist()to write a one-element array. Longer vectors are arrays.A named list is an object and an unnamed list is an array. An empty unnamed
list()is[]; usesetNames(list(), character())for{}.-
NULLfields are omitted, so a JSONnullcannot be written. Integer-valued numbers up to 2^53 are written exactly; other numbers with the fewest digits that read back as the same double.
A
POSIXctvalue is written as an event time (new_event_time()), aDateasYYYY-MM-DDand a factor as its labels.Missing values,
NaN, infinite numbers, complex and raw vectors, named atomic vectors, lists with repeated or empty names, text that is not valid UTF-8 and other classed objects raise anopenlineage_validation_errorwhen the facet is serialized.
Value
A generic OpenLineage facet accepted in any facet map.
Examples
facet <- ol_facet(
"https://example.com/CustomRunFacet.json",
customValue = "example",
tags = I("nightly")
)
Run(new_run_id(), facets = list(custom = facet))
Create an OpenLineage tag
Description
Create an OpenLineage tag
Usage
ol_tag(key, value, source = NULL, field = NULL)
Arguments
key |
The tag key. |
value |
The tag value. |
source |
An optional tag source. |
field |
An optional dataset field to which the tag applies. |
Value
A tag record for a typed tags facet.
Examples
ol_tag("environment", "production", source = "USER")
OpenLineage protocol constants
Description
Constants used by openlineage when constructing OpenLineage events.
OPENLINEAGE_SCHEMA_URL identifies the schema document, while
OPENLINEAGE_RUN_EVENT_SCHEMA_URL identifies its RunEvent definition.
Usage
OPENLINEAGE_SCHEMA_VERSION
OPENLINEAGE_SCHEMA_URL
OPENLINEAGE_RUN_EVENT_SCHEMA_URL
OPENLINEAGE_PRODUCER
Format
Character scalars.
Examples
OPENLINEAGE_SCHEMA_VERSION
OPENLINEAGE_SCHEMA_URL
OPENLINEAGE_RUN_EVENT_SCHEMA_URL
OPENLINEAGE_PRODUCER
Typed run facets
Description
Constructors for commonly used OpenLineage run facets.
Usage
NominalTimeRunFacet(
nominal_start_time,
nominal_end_time = NULL,
producer = OPENLINEAGE_PRODUCER
)
ParentRunFacet(run, job, root = NULL, producer = OPENLINEAGE_PRODUCER)
ErrorMessageRunFacet(
message,
programming_language,
stack_trace = NULL,
producer = OPENLINEAGE_PRODUCER
)
ProcessingEngineRunFacet(
version,
name = NULL,
openlineage_adapter_version = NULL,
producer = OPENLINEAGE_PRODUCER
)
Arguments
nominal_start_time |
The nominal start as an RFC 3339 date-time. |
nominal_end_time |
An optional nominal end date-time. |
producer |
A URI identifying the facet producer. |
run |
The parent |
job |
The parent |
root |
Optional |
message |
A human-readable error message. |
programming_language |
The language that produced the error. |
stack_trace |
An optional stack trace. |
version |
The processing engine version. |
name |
The optional processing engine name. |
openlineage_adapter_version |
The optional adapter version. |
Value
A typed run facet S7 object.
Examples
NominalTimeRunFacet("2026-01-02T03:00:00.000Z")
parent_run <- Run(new_run_id())
parent_job <- Job("example", "parent")
ParentRunFacet(parent_run, parent_job)
ErrorMessageRunFacet("Query failed", "R")
ProcessingEngineRunFacet("4.6.0", name = "R")
Typed tags facets
Description
Typed tags facets
Usage
TagsJobFacet(tags = list(), producer = OPENLINEAGE_PRODUCER, deleted = NULL)
TagsRunFacet(tags = list(), producer = OPENLINEAGE_PRODUCER)
TagsDatasetFacet(
tags = list(),
producer = OPENLINEAGE_PRODUCER,
deleted = NULL
)
Arguments
tags |
An unnamed list created with |
producer |
A URI identifying the facet producer. |
deleted |
Whether a job or dataset facet is being deleted. |
Value
A typed tags facet S7 object.
Examples
tag <- ol_tag("environment", "production")
TagsJobFacet(list(tag))
TagsRunFacet(list(tag))
TagsDatasetFacet(list(
ol_tag("sensitivity", "restricted", field = "customer_id")
))
Serialize an OpenLineage value to JSON
Description
Serialize an OpenLineage value to JSON
Usage
to_openlineage_json(x, pretty = FALSE)
Arguments
x |
An OpenLineage model or supported nested value. |
pretty |
Whether to add indentation and line breaks. |
Value
A single JSON string.
Examples
event <- RunEvent(
Run("019c0000-0000-7000-8000-000000000001"),
Job("example", "task"),
event_type = "START",
event_time = "2026-01-02T03:04:05.000Z"
)
to_openlineage_json(event)