Joins in Continuous Queries

Joins are a common and well-understood operation in batch data processing to connect the rows of two relations. However, the semantics of joins on dynamic tables are much less obvious or even confusing.

Because of that, there are a couple of ways to actually perform a join using either Table API or SQL.

For more information regarding the syntax, please check the join sections in Table API and SQL.

Regular Joins

Regular joins are the most generic type of join in which any new records or changes to either side of the join input are visible and are affecting the whole join result. For example, if there is a new record on the left side, it will be joined with all of the previous and future records on the right side.

  1. SELECT * FROM Orders
  2. INNER JOIN Product
  3. ON Orders.productId = Product.id

These semantics allow for any kind of updating (insert, update, delete) input tables.

However, this operation has an important implication: it requires to keep both sides of the join input in Flink’s state forever. Thus, the resource usage will grow indefinitely as well, if one or both input tables are continuously growing.

Interval Joins

A interval join is defined by a join predicate, that checks if the time attributes of the input records are within certain time constraints, i.e., a time window.

  1. SELECT *
  2. FROM
  3.   Orders o,
  4.   Shipments s
  5. WHERE o.id = s.orderId AND
  6.       o.ordertime BETWEEN s.shiptime - INTERVAL '4' HOUR AND s.shiptime

Compared to a regular join operation, this kind of join only supports append-only tables with time attributes. Since time attributes are quasi-monotonic increasing, Flink can remove old values from its state without affecting the correctness of the result.

Join with a Temporal Table Function

A join with a temporal table function joins an append-only table (left input/probe side) with a temporal table (right input/build side), i.e., a table that changes over time and tracks its changes. Please check the corresponding page for more information about temporal tables.

The following example shows an append-only table Orders that should be joined with the continuously changing currency rates table RatesHistory.

Orders is an append-only table that represents payments for the given amount and the given currency. For example at 10:15 there was an order for an amount of 2 Euro.

  1. SELECT * FROM Orders;
  3. rowtime amount currency
  4. ======= ====== =========
  5. 10:15        2 Euro
  6. 10:30        1 US Dollar
  7. 10:32       50 Yen
  8. 10:52        3 Euro
  9. 11:04        5 US Dollar

RatesHistory represents an ever changing append-only table of currency exchange rates with respect to Yen (which has a rate of 1). For example, the exchange rate for the period from 09:00 to 10:45 of Euro to Yen was 114. From 10:45 to 11:15 it was 116.

  1. SELECT * FROM RatesHistory;
  3. rowtime currency   rate
  4. ======= ======== ======
  5. 09:00   US Dollar   102
  6. 09:00   Euro        114
  7. 09:00   Yen           1
  8. 10:45   Euro        116
  9. 11:15   Euro        119
  10. 11:49   Pounds      108

Given that we would like to calculate the amount of all Orders converted to a common currency (Yen).

For example, we would like to convert the following order using the appropriate conversion rate for the given rowtime (114).

  1. rowtime amount currency
  2. ======= ====== =========
  3. 10:15        2 Euro

Without using the concept of temporal tables, one would need to write a query like:

  1. SELECT
  2.   SUM(o.amount * r.rate) AS amount
  3. FROM Orders AS o,
  4.   RatesHistory AS r
  5. WHERE r.currency = o.currency
  6. AND r.rowtime = (
  7.   SELECT MAX(rowtime)
  8.   FROM RatesHistory AS r2
  9.   WHERE r2.currency = o.currency
  10.   AND r2.rowtime <= o.rowtime);

With the help of a temporal table function Rates over RatesHistory, we can express such a query in SQL as:

  1. SELECT
  2.   o.amount * r.rate AS amount
  3. FROM
  4.   Orders AS o,
  5.   LATERAL TABLE (Rates(o.rowtime)) AS r
  6. WHERE r.currency = o.currency

Each record from the probe side will be joined with the version of the build side table at the time of the correlated time attribute of the probe side record. In order to support updates (overwrites) of previous values on the build side table, the table must define a primary key.

In our example, each record from Orders will be joined with the version of Rates at time o.rowtime. The currency field has been defined as the primary key of Rates before and is used to connect both tables in our example. If the query were using a processing-time notion, a newly appended order would always be joined with the most recent version of Rates when executing the operation.

In contrast to regular joins, this means that if there is a new record on the build side, it will not affect the previous results of the join. This again allows Flink to limit the number of elements that must be kept in the state.

Compared to interval joins, temporal table joins do not define a time window within which bounds the records will be joined. Records from the probe side are always joined with the build side’s version at the time specified by the time attribute. Thus, records on the build side might be arbitrarily old. As time passes, the previous and no longer needed versions of the record (for the given primary key) will be removed from the state.

Such behaviour makes a temporal table join a good candidate to express stream enrichment in relational terms.

Usage

After defining temporal table function, we can start using it. Temporal table functions can be used in the same way as normal table functions would be used.

The following code snippet solves our motivating problem of converting currencies from the Orders table:

  1. SELECT
  2.   SUM(o_amount * r_rate) AS amount
  3. FROM
  4.   Orders,
  5.   LATERAL TABLE (Rates(o_proctime))
  6. WHERE
  7.   r_currency = o_currency
  1. Table result = orders
  2.     .joinLateral("rates(o_proctime)", "o_currency = r_currency")
  3.     .select("(o_amount * r_rate).sum as amount");
  1. val result = orders
  2.     .joinLateral(rates('o_proctime), 'r_currency === 'o_currency)
  3.     .select(('o_amount * 'r_rate).sum as 'amount)

Note: State retention defined in a query configuration is not yet implemented for temporal joins. This means that the required state to compute the query result might grow infinitely depending on the number of distinct primary keys for the history table.

Processing-time Temporal Joins

With a processing-time time attribute, it is impossible to pass past time attributes as an argument to the temporal table function. By definition, it is always the current timestamp. Thus, invocations of a processing-time temporal table function will always return the latest known versions of the underlying table and any updates in the underlying history table will also immediately overwrite the current values.

Only the latest versions (with respect to the defined primary key) of the build side records are kept in the state. Updates of the build side will have no effect on previously emitted join results.

One can think about a processing-time temporal join as a simple HashMap<K, V> that stores all of the records from the build side. When a new record from the build side has the same key as some previous record, the old value is just simply overwritten. Every record from the probe side is always evaluated against the most recent/current state of the HashMap.

Event-time Temporal Joins

With an event-time time attribute (i.e., a rowtime attribute), it is possible to pass past time attributes to the temporal table function. This allows for joining the two tables at a common point in time.

Compared to processing-time temporal joins, the temporal table does not only keep the latest version (with respect to the defined primary key) of the build side records in the state but stores all versions (identified by time) since the last watermark.

For example, an incoming row with an event-time timestamp of 12:30:00 that is appended to the probe side table is joined with the version of the build side table at time 12:30:00 according to the concept of temporal tables. Thus, the incoming row is only joined with rows that have a timestamp lower or equal to 12:30:00 with applied updates according to the primary key until this point in time.

By definition of event time, watermarks allow the join operation to move forward in time and discard versions of the build table that are no longer necessary because no incoming row with lower or equal timestamp is expected.

Join with a Temporal Table

A join with a temporal table joins an arbitrary table (left input/probe side) with a temporal table (right input/build side), i.e., an external dimension table that changes over time. Please check the corresponding page for more information about temporal tables.

Attention Users can not use arbitrary tables as a temporal table, but need to use a table backed by a LookupableTableSource. A LookupableTableSource can only be used for temporal join as a temporal table. See the page for more details about how to define LookupableTableSource.

The following example shows an Orders stream that should be joined with the continuously changing currency rates table LatestRates.

LatestRates is a dimension table that is materialized with the latest rate. At time 10:15, 10:30, 10:52, the content of LatestRates looks as follows:

  1. 10:15> SELECT * FROM LatestRates;
  3. currency   rate
  4. ======== ======
  5. US Dollar   102
  6. Euro        114
  7. Yen           1
  9. 10:30> SELECT * FROM LatestRates;
  11. currency   rate
  12. ======== ======
  13. US Dollar   102
  14. Euro        114
  15. Yen           1
  18. 10:52> SELECT * FROM LatestRates;
  20. currency   rate
  21. ======== ======
  22. US Dollar   102
  23. Euro        116     <==== changed from 114 to 116
  24. Yen           1

The content of LastestRates at time 10:15 and 10:30 are equal. The Euro rate has changed from 114 to 116 at 10:52.

Orders is an append-only table that represents payments for the given amount and the given currency. For example at 10:15 there was an order for an amount of 2 Euro.

  1. SELECT * FROM Orders;
  3. amount currency
  4. ====== =========
  5.      2 Euro             <== arrived at time 10:15
  6.      1 US Dollar        <== arrived at time 10:30
  7.      2 Euro             <== arrived at time 10:52

Given that we would like to calculate the amount of all Orders converted to a common currency (Yen).

For example, we would like to convert the following orders using the latest rate in LatestRates. The result would be:

  1. amount currency     rate   amout*rate
  2. ====== ========= ======= ============
  3.      2 Euro          114          228    <== arrived at time 10:15
  4.      1 US Dollar     102          102    <== arrived at time 10:30
  5.      2 Euro          116          232    <== arrived at time 10:52

With the help of temporal table join, we can express such a query in SQL as:

  1. SELECT
  2.   o.amout, o.currency, r.rate, o.amount * r.rate
  3. FROM
  4.   Orders AS o
  5.   JOIN LatestRates FOR SYSTEM_TIME AS OF o.proctime AS r
  6.   ON r.currency = o.currency

Each record from the probe side will be joined with the current version of the build side table. In our example, the query is using the processing-time notion, so a newly appended order would always be joined with the most recent version of LatestRates when executing the operation. Note that the result is not deterministic for processing-time.

In contrast to regular joins, the previous results of the temporal table join will not be affected despite the changes on the build side. Also, the temporal table join operator is very lightweight and does not keep any state.

Compared to interval joins, temporal table joins do not define a time window within which the records will be joined. Records from the probe side are always joined with the build side’s latest version at processing time. Thus, records on the build side might be arbitrarily old.

Both temporal table function join and temporal table join come from the same motivation but have different SQL syntax and runtime implementations:

  • The SQL syntax of the temporal table function join is a join UDTF, while the temporal table join uses the standard temporal table syntax introduced in SQL:2011.
  • The implementation of temporal table function joins actually joins two streams and keeps them in state, while temporal table joins just receive the only input stream and look up the external database according to the key in the record.
  • The temporal table function join is usually used to join a changelog stream, while the temporal table join is usually used to join an external table (i.e. dimension table).

Such behaviour makes a temporal table join a good candidate to express stream enrichment in relational terms.

In the future, the temporal table join will support the features of temporal table function joins, i.e. support to temporal join a changelog stream.

Usage

The syntax of temporal table join is as follows:

  1. SELECT [column_list]
  2. FROM table1 [AS <alias1>]
  3. [LEFT] JOIN table2 FOR SYSTEM_TIME AS OF table1.proctime [AS <alias2>]
  4. ON table1.column-name1 = table2.column-name1

Currently, only support INNER JOIN and LEFT JOIN. The FOR SYSTEM_TIME AS OF table1.proctime should be followed after temporal table. proctime is a processing time attribute of table1. This means that it takes a snapshot of the temporal table at processing time when joining every record from left table.

For example, after defining temporal table, we can use it as following.

  1. SELECT
  2.   SUM(o_amount * r_rate) AS amount
  3. FROM
  4.   Orders
  5.   JOIN LatestRates FOR SYSTEM_TIME AS OF o_proctime
  6.   ON r_currency = o_currency

Attention It is only supported in Blink planner.

Attention It is only supported in SQL, and not supported in Table API yet.

Attention Flink does not support event time temporal table joins currently.