Realtime database¶
Kdb+tick is used to capture, store and analyze massive volumes of data in real time.
A standard setup might consist of
- a tickerplant to capture and log incoming data
- a historical database (HDB) to access all the data prior to the current day
- a real-time database (RDB) to store the current day’s data in memory and write it to the HDB at the end of day
As a minimum, it is recommended to have RAM of at least 4× expected data size, so for 5 GB data per day, the RDB machine should have at least 20 GB RAM. In practice, much larger RAM might be used.
Data feeds¶
Data feeds can be any market or other time-series data. A feedhandler converts the data stream into a format suitable for writing to kdb+. These are usually written in a compiled language, such as C, C++, Java or C#.
A Reuters RFA feedhandler is available.
In the example described here, the data feed is generated at random by a kdb+ process.
Tickerplant¶
The data feed could be written directly to the RDB. More often, it is written to a kdb+ process called a tickerplant, which will:
- write all incoming records to a log file
- push all data to the RDB
- push all or subsets of the data to other processes
Other processes would subscribe to a tickerplant to receive new data, and each would specify what data should be sent: all or a selection.
Example¶
The demo scripts run a simple tickerplant/RDB configuration.
The layout is:
feed
|
tickerplant
/ / | \ \ \
rdb vwap hlcv tq last show
/\ /\ /\ /\ /\
... client applications ...Where
- feed
-
is a demo feedhandler that generates random trades and quotes and sends them to the tickerplant. In practice, this would be replaced by real feedhandlers.
- tickerplant
-
gets data from feed and pushes it to clients that have subscribed. Once the data is written, it is discarded.
- rdb, vwap, hlcv, tq, last
-
are databases that have subscribed to the tickerplant. Note that these databases can be queried by a client application.
| database | role |
|---|---|
| rdb | has all of today’s data |
| vwap | has volume-weighted averages for selected stocks |
| hlcv | has high, low, close, volume for selected stocks |
| tq | has a trade and quote table for selected stocks; each row is a trade joined with the most recent quote |
| last | has the last entries for each stock in the trade and quote tables |
| show | counts the updates, and displays the counts periodically |
Note that all the client processes load the same script file cx.q, with a parameter that selects the corresponding code for the process in that file. Alternatively, each process could load its own script file, but since the definitions tend to be very short, it is convenient to use a single script for all. More examples:
KxSystems/kdb/tick/c.q
KxSystems/kdb/e/c.q
Running the demo¶
Install kdb+tick.
Install the demo scripts.
The demo displays each kdb+ process in its own window.
Run the start/tick/run.app application from Finder. (Consult the README as changes must be made to the default Terminal settings.)
start/tick/run.shstart/tick/run.batThe calls starting each process are essentially:
-
tickerplant – the
tick.qscript defines the tickerplant, and runs on port 5010q tick.q -p 5010 -
feed – the
feed.qscript connects to the tickerplant and sends a new batch every 507 millisecondsq feed.q localhost:5010 -t 507 -
rdb – the
r.qscript defines the real time databaseq tick/r.q -p 5011 -
show – the
showprocess, which does not need a portq cx.q show
Running processes manually¶
If the run scripts are unsuitable for your system, then you can call each process manually. In each case, open up a new terminal window, change to the QHOME directory and enter the appropriate command. The tickerplant should be started first.
Kdb+tick uses paths relative to the local directory. To run correctly, you should change directory such that tick.q is in the local directory. For example on macOS, for each of the following commands, open a new terminal, change directory to ~/q/start/tick, then:
~/q/start/tick$ ~/q/m32/q tick.q -p 5010
~/q/start/tick$ ~/q/m32/q feed.q localhost:5010 -t 107
~/q/start/tick$ ~/q/m32/q tick/r.q -p 5011Refer to run1.sh for the remaining processes.
Process examples¶
Set focus on the last window, and view the trade table. Note that each time the table is viewed, it will be updated with the latest data:
q)trade
sym | time price size stop cond ex
----| ------------------------------------
AAPL| 14:36:02.656 97.37 11 0 A N
AIG | 14:36:02.870 19.92 86 0 P O
AMD | 14:36:03.405 23.21 94 1 W N
...Set focus on the vwap window, and view the vwap table. Note that price is actually price*size. This can be updated much more efficiently than storing actual prices and sizes.
q)vwap
sym | price size
----| -------------------
AAPL| 6.70234e+07 705352
AMD | 1.998351e+07 699901
DOW | 1.709416e+07 705367
...To get the correct weighted-average price:
q)select sym,price%size,size from vwap
sym price size
--------------------
AAPL 95.02686 706049
AMD 28.54816 700441
DOW 24.23159 705727
...Kdb+tick modifications¶
The standard components of kdb+tick support various options. In the basic set-up outlined here, the tickerplant publishes all data immediately, and does not create a log file. Optional parameters of
~/q/m32/q tick.q [schema] [destination directory] [-t N] -p 5010can be supplied. If the destination directory is set, then the schema must also be defined. To modify the supplied example to create a tickerplant log file and to publish data in 1-second batches rather than immediately, start the process with:
~/q/m32/q tick.q sym ./hdb -t 1000 -p 5010Similarly the real-time database can be started with optional host:port:user:pass of the tickerplant and historic database to reload at end-of-day:
~/q/m32/q tick/r.q [tickerplant host:port] [hdb host:port] -p 5011e.g.
~/q/m32/q tick/r.q :5010 :5012 -p 5011Process communication¶
The qkdb+ processes communicate by sending a function with arguments using Interprocess communication.
For example, the tickerplant sends new data to the subscribers by calling the upd function with the table name and new data. In the last process, this is:
upd:{[t;x].[t;();,;select by sym from x]}]