Linked Data Event Streams

Living Standard,

This version:
https://w3id.org/ldes/specification
Issue Tracking:
GitHub
Editor:
Pieter Colpaert

Abstract

A Linked Data Event Stream is a collection of immutable objects (such as version objects, sensor observations or archived representations). Each object is described in RDF.

1. Introduction

A Linked Data Event Stream (LDES) (ldes:EventStream) is a collection of immutable objects, each object being described using a set of RDF triples ([rdf-primer]).

This specification uses the TREE specification for its collection and fragmentation (or pagination) features, which in its turn is compatible to other specifications such as [activitystreams-core], [VOCAB-DCAT-2], [LDP] or Shape Trees. For the specific compatibility rules, read the TREE specification.

An ldes:EventStream is an rdfs:subClassOf the tree:Collection class. It extends the tree:Collection class by saying all of its members are immutable, and you can thus only add members to the collection.

Note: When a client once processed a member, it should never have to process it again. A Linked Data Event Stream client can thus keep a list (or cache) of already processed member IRIs. A reference implementation of a client is available as part of the Comunica framework on NPM and Github.

The base URI for LDES is https://w3id.org/ldes#, and the preferred prefix is ldes:.

<C1> a ldes:EventStream ;
     tree:shape <shape1.shacl> ;
     tree:member <Obervation1> .

<Observation1> a sosa:Observation ;
               sosa:resultTime "2021-01-01T00:00:00Z"^^xsd:dateTime ;
               sosa:hasSimpleResult "..." .

A tree:shape SHOULD be defined with the ldes:EventStream instance as its subject. The shape of the collection defines its members: it tells clients all old and new members of the stream have been and will be validated by that shape. As a consequence of the immutability of the members, this shape MAY evolve, but it MUST always be backwards compatible to the earlier version.

Clients MAY use the shape of the ldes:EventStream for prioritizing its source selection.

Note: When you need to change an earlier version of an ldes:EventStream, there are two options: create a new version of the object with a new shape that is backward compatible, and add the new version of that object again as a member on the stream, or replicate and transform the entire collection into a new ldes:EventStream. You can indicate that the new ldes:EventStream is derived from

<C2> a ldes:EventStream ;
     tree:shape <shape2.shacl> ;
     tree:member <AddressRecord1/version1> .

<AddressRecord1/version1> dcterms:created "2021-01-01T00:00:00Z"^^xsd:dateTime ;
                          adms:versionNotes "First version of this address" ;
                          dcterms:isVersionOf <AddressRecord1> ;
                          dcterms:title "Streetname X, ZIP Municipality, Country" .

Note: in Example 1, we consider the Observation object ot be an immutable object and we can use the existing identifiers. In Example 2 however, we still had to create version IRIs in order to be able to link to immutable objects.

2. Fragmenting and pagination

The focus of an LDES is to allow clients to replicate the history of a dataset and efficiently synchronize with its latest changes. Linked Data Event Streams MAY be fragmented when their size becomes too big for 1 HTTP response. Fragmentations MUST be described using the features in the TREE specification. All relation types from the TREE specification MAY be used.

<C1> a ldes:EventStream ;
     tree:shape <shape1.shacl> ; # this shacl shape for as long as this collection exists will need to be backwards compatible.
     tree:member <Obervation1>, ... ;
     tree:view <?page=1> .

<?page=1> a tree:Node ;
    tree:relation [
        a tree:GreaterThanOrEqualToRelation ;
        tree:path sosa:resultTime ;
        tree:node <?page=2> ;
        tree:value "2020-12-24T12:00:00Z"^^xsd:dateTime
     ] .

An tree:importStream MAY be used to describe a publish-subscribe interface to subscribe to new members in the LDES.

Note: A 1-dimensional fragmentation based on creation time of the immutable objects is probably going to be the most interesting and highest priority fragmentation for an LDES, as only the latest page, once replicated, should be subscribed to for updates. However, it may happen that a time-based fragmentation cannot be applied. For example: the backend system on which the LDES has been built does not receive the events at the time they were created, due to human errors (forgetting to indicate that a change was made), external systems or just latency. Applying a time-based fragmentation in that situation will result in losing caching, due to the ever-changing pages. Instead, in the spirit of an LDES’s goal, the publisher should publish the events in the order they were received by the backend system (that order is never changing), trying to gave as many pages as possible an HTTP Cache-Control: public, max-age=604800, immutable header

Note: Cfr. the example in the TREE specification on “searching through a list of objects ordered in time”, also a search form can optionally make a one dimensional feed of immutable objects more searchable.

3. Retention policies

By default, an LDES MUST keep all data that has been added to the tree:Collection (or ldes:EventStream) as defined by the TREE specification. It MAY add a retention policy in which the server indicates data will be removed from the server. Third parties SHOULD read retention policies to understand what subset of the data is available in this tree:View, and MAY archive these member.

In the LDES specification, two types of retention policies are defined which can be used with a ldes:retentionPolicy with an instance of a tree:View as its subject:

  1. ldes:DurationAgoPolicy: a time-based retention policy in which data generated before a specific time is removed

  2. ldes:LatestVersionSubset: a version subset based on the latest versions of an entity in the stream

Different retention policies MAY be combined. When policies are used together, a server MUST store the members as long they are not all matched.

3.1. Time-based retention policies

A time-based retention policy can be introduced as follows:

<Collection> a ldes:EventStream ;
             tree:view <> .

<> ldes:retentionPolicy <P1> .

<P1> a ldes:DurationAgoPolicy ;
     tree:path prov:generatedAtTime ;
     tree:value "P1Y"^^xsd:duration . # Keep 1 year of data

A ldes:DurationAgoPolicy uses a tree:value with an xsd:duration-typed literal to indicate how long ago the timestamp, indicated by the tree:path, of the members that can be found via a tree:View can be compared to the current time on the server.

3.2. Version-based retention policies

In order to indicate you only keep 2 versions of an object referred to using dcterms:isVersionOf:
<Collection> a tree:EventStream ;
             tree:view <> .

<> ldes:retentionPolicy <P1> .

<P1> a ldes:LatestVersionSubset;
     ldes:amount 2 ; 
     ldes:versionKey ( dcterms:isVersionOf )
     .

A ldes:LatestVersionSubset SHOULD use two predicates: ldes:amount and the ldes:versionKey. The ldes:amount has a xsd:nonNegativeInteger datatype and indicated how many to keep that defaults to 1. The ldes:versionKey is an rdf:List of SHACL property paths indicating objects that MUST be concatenated together to find the key on which versions are matched. When the ldes:versionKey is not set or empty, the key is empty, and all members MUST be seen as a version of the same thing.

For sensor datasets the version key may get more complex, grouping observations by both the observed property as the sensor that made the observation.
<Collection> a tree:EventStream ;
             tree:view <> .

<> ldes:retentionPolicy <P1> .

<P1> a ldes:LatestVersionSubset;
     ldes:amount 2 ; 
     ldes:versionKey ( ( sosa:observedProperty ) ( sosa:madeBySensor ) ) .

Conformance

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

References

Normative References

[ACTIVITYSTREAMS-CORE]
James Snell; Evan Prodromou. Activity Streams 2.0. 23 May 2017. REC. URL: https://www.w3.org/TR/activitystreams-core/
[LDP]
Steve Speicher; John Arwe; Ashok Malhotra. Linked Data Platform 1.0. 26 February 2015. REC. URL: https://www.w3.org/TR/ldp/
[RDF-PRIMER]
Frank Manola; Eric Miller. RDF Primer. 10 February 2004. REC. URL: https://www.w3.org/TR/rdf-primer/
[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119
[VOCAB-DCAT-2]
Riccardo Albertoni; et al. Data Catalog Vocabulary (DCAT) - Version 2. 28 May 2019. WD. URL: https://www.w3.org/TR/vocab-dcat-2/