Database Documentation Generator

qStudio provides tools to help reverse engineer documentation from your kdb+ database.

Generating documentation from a kdb+ database

How to add Description Columns

To add description columns create a timestoredDescriptions table with the columns:

table - table name as symbol
column - optional column name as symbol
description - string field describing the table or column

Example

stock:([sym:`s#`AAPL`C`FB`MS] 
    sector:`Tech`Financial`Tech`Financial; 
    employees:12800 23000 4331 51726);
    
n:10200;

trade:([] dt:`s#asc n?2015.01.01; 
    sym:n?`C`MS`DBK`AAPL`MS; 
    price:n?99.; 
    size:n?999);
    
timestoredDescriptions:{
    // add stock table descriptions
    sD:"Table describing what sector a company operates in and the number of employees it has";
    secD:"An area of the economy in which businesses operate";
    secEmployees:"Number of full time employees as of April this year";
    tab:([] t:3#`stock; c:``sector`employees; description:(sD; secD; secEmployees));
    // add trade table description
    tD:"Each row represents a single trade";
    pD:"Price in GBP";
    tab,([] table:2#`trade; column:``price; description:(tD;pD))}[];

kdb+ Database Doc Generator

Database Documentation Generator

How to add Description Columns

Example

Output

See Also