Kerf
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
external
include
manual
papers
scripts
.gitignore
README.md
repl-header.png
watch.gif

README.md

REPL

What is Kerf?

Kerf is a columnar tick database and time-series language for Linux/OSX/BSD/iOS/Android. It is written in C and natively speaks JSON and SQL. Kerf can be used for trading platforms, feedhandlers, low-latency networking, high-volume analysis of realtime and historical data, logfile processing, and more.

Manual

The manual, currently in progress, is here:

https://github.com/kevinlawler/kerf/tree/master/manual

The manual covers much more than the whirlwind guide below.

Guides

Kerf Screencast - Stock Basics https://youtu.be/CcJP8TX7CVc
Kerf Screencast - Stock Basics II: Stats https://youtu.be/Pi6FXIYvTkk
Kerf Screencast - CSV & Text Tricks: https://youtu.be/aDETohEScJM
Kerf Screencast - Bloomberg B-PIPE Datafeed: https://youtu.be/eVu50oSBZAE

Time Bars - https://getkerf.wordpress.com/2016/06/21/time-bars/

Whirlwind Language Guide:

TYPES

  CHAR 
         "abc" or 'abc'
  
  INT  
          1
  
  FLOAT
          2.0 or 1e6 or 1.2E+01
  
  STAMP
          2015.03.31 or 01:23:45.877 or 2015.03.31T01:23:45.123
  
  NULL
          null
  
  ARRAY 
          [5, 6, 7, 8]
  
  MAP  
          {b:2, c:3, d:4}
  
  TABLE   
         {{b:2, c:3, d:4}}

There are a few other types which we'll skip discussing for now.

OPERATIONS

Let's look at some good ways to make arrays. 'Range' comes directly from Python and accepts 1, 2, or 3 arguments:

range(4)
  [0, 1, 2, 3]

range(2, 6)
  [2, 3, 4, 5]

range(0, 20, 3)
  [0, 3, 6, 9, 12, 15, 18]

'Rand' accepts 0, 1, or 2 arguments:

rand()       //FLOAT from [0,1)
  0.164771

rand(5)      //INT
  2

rand(9.0)    //FLOAT
  8.86153

rand(4, 3.0) //4x FLOAT
  [2.44598, 2.87178, 1.14531, 0.676305]

rand(4, [11, 22]) //from a list
  [22, 11, 11, 22]

Rand may return different values for you.

Now let's look ahead:

The exponentiation operator ** comes from Ruby and Python.

range(10**6) //a big list

timing true
sum(range(10**6))  //sum first million numbers
  499999500000

Now back to basic arithmetic:

+ - * / ** plus minus times divide pow
        //wait, which is the operation and which is the name?
2 + 2
plus(2, 2)
        //I guess they both work
2 plus 2
        //and that works too

This is nice because parenthesized prefix notation disambiguates dyadic/binary infix operations.

        //oh, one of those guys

Then the ambiguous-appearing

0.5 * x**2 

becomes

times(1/2, x**2) 
        //well that's not so bad
        //
        //actually, I like that better... I wonder why?

Or, emphasizing the center operation:

(divide(1, 2) * pow(x,2))

Neither of these are ambiguous. Of course, you can always fall back to parentheses:

((1 / 2) * (x**2))

Format code as if order-of-operations does not exist.

I find the "functional" notation for arithmetic also helps when the arguments are arrays or maps instead of scalars. This can cue the reader that something heavier-duty is happening.

Other common operators are present. The exclamation point '!' is not, the percent sign '%' is modulo, and so on.

!0
 1
not 0
 1

-33 % 4
  3  //mathematical definition
-33 mod 4
  3

.Math.TAU / 2
  3.14159

JSON

Kerf speaks JSON:

eval('1+1')
  2

a: [[1, 2, 3], {a:"alpha", b:"bravo", c:"3pO"}, null]
match(a, eval(json_from_kerf(a)))
  1

ASSIGNMENT

Assignment is ':', the colon character. It's colon and not '=' because:

  1. JSON uses : for assignment, as in {a:1}
  2. SQL uses = for comparison, as in WHERE user_id=456
  3. Kerf is a superset of both JSON and SQL.

Which looks like

a: [11, 22, 33, 44]
a[2]
    33

We could force assignment to be '=' but I don't think it improves the language.

a[0]:5
a
  [5, 22, 33, 44]

Indexing into maps:

a: {b:2, c:3}
a['c']
  3
{b:2, c:3}['c']
  3

VECTOR OPERATIONS

Arrays vectorize automatically. This means CHAR, INT, FLOAT, and STAMP types are fast and efficient in lists of the same kind. Arrays also mostly keep track of when they're sorted. This means Kerf will invisibly use binary search or interpolation search if it appears advantageous.

The following notion of conformability comes from K:

Adding a single value to a longer list applies it like so: 100 + [0, 10, 20] gives [100, 110, 120]

Kerf extends this notion to work with lists of length 1 as well:

[100] + [0, 10, 20]

gives

  [100, 110, 120]

This also works piecewise:

  [100, 110, 120] + [40, 50, 60]

gives

    [140, 160, 180]

Conformability extends all the way down. This

[[1], [1,1,1]] + [[2], [2, 2, 2]]

gives

  [[3], [3, 3, 3]]

Flatten? Sure

flatten [[3], [3, 3, 3]]
  [3, 3, 3, 3]

Works with maps and tables, too.

{a:2, b:20} + {a:3, b:30, c:100}
  {a:5, b:50, c:100}

Some operations yield array-wise results.

![0, 1, 0]
  [1, 0, 1]

[2, 3, 4, 4, 4] <= [3, 3, 3, 3, 3]
  [1, 1, 0, 0, 0]

Operations are optimized for vectors

timing 1
a: range(10**6)
sum(a)
a+a
min(a)

TABLES

Kerf extends JSON to include the concept of tables. Tables are created just like maps except you use double curly-braces. The names of the keys in that case are instead the names of the columns. So {{a:1, b:2}} is a table and {a:1, b:2} is a map. The convenience constructor {{a,b,c}} also creates a table. This table will have empty arrays for columns. Table columns are always arrays. If you pass something that isn't an array it will be coerced into an array.

The following are all equivalent ways to make a table:

  {{id:1, time:now(), brightness:48.6}}
is the same as 
  {{id:[1], time:[now()], brightness:[48.6]}}
is the same as 
  INSERT INTO {{id, time, brightness}} VALUES [[1], [now()], [48.6]] //bulk insert/append
is the same as
  INSERT INTO {{id, time, brightness}} VALUES {id:1, time:now(), brightness:48.6}   //insert map
is the same as
  INSERT INTO {{id, time, brightness}} VALUES {{id:1, time:now(), brightness:48.6}} //append table
is the same as
  INSERT INTO {{}} VALUES {id:1, time:now(), brightness:48.6} //empty tables are special
is the same as
  a:{{}}
  INSERT INTO a VALUES {id:1, time:now(), brightness:48.6}
is the same as
  id:[1]
  time:[now()]
  brightness:[48.6]
  {{id:id, time:time, brightness:brightness}}

They are all printed as

┌──┬───────────────────────┬──────────┐
│id│time                   │brightness│
├──┼───────────────────────┼──────────┤
│ 1│2015.07.06T16:23:50.509│      48.6│
└──┴───────────────────────┴──────────┘

SQL inserts and updates are forms of assignment: they are always "saved". Bulk inserts are much faster than single inserts. The columns id, time, and brightness are vectorized as INT, STAMP, and FLOAT vectors respectively. The preceding tables all exist in-memory only.

READS/WRITES

You can read and write arbitrary objects, including in-memory tables, using the following functions. These are not really designed for transactional reads and writes, more like per-session reads and writes.

  read_from_path('path.to.file')
  write_to_path('path.to.file', object);

For an on-disk table that handles transactional writes, you'll want a mapped object. On Linux, OSX, BSD and other systems, the virtual memory limit for mapped objects is slightly less than 47-bits, or 128T, which for most people is effectively unlimited.

Apple's iOS operating system restricts virtual memory allocations to something less than 2G in size, even on devices with 64-bit pointers. So mapping very large tables will not get far around the memory limitations of the mobile device. Apple really should look into raising it: it may be a legacy restriction from some now-outdated concerns. On OS X the virtual memory limit is effectively unrestricted.

You can open tables on disk via the open_table(filepath) call. Here it is via the Objective-C API:

NSString *path = [[kerf suggestedTableDirectoryPath] stringByAppendingPathComponent:@"my.table"];
[kerf jsonObjectFromCall:@"a: open_table($1)" withArgumentArray:@[path]]
[kerf jsonObjectFromCall:@"insert into a values {{id: 4}}"]);
[kerf jsonObjectFromCall:@"a"]

Modifications to the variable cause the inserts to persist to the disk. They will be there the next time you open the table. Most variables in Kerf use reference counting or copy-on-write to ensure uniqueness. Mapped values like opened tables are different: all reference the same open item. Changes to one affect the other.

CSV/TSV/ETC LOADING

Loading CSVs into tables should be easy. The function for reading a CSV into an in-memory table is read_table_from_csv, and it is used in this way:

read_table_from_csv(csv_file, fields, header_rows)

so that

csv_file: 'my_logs01.csv'
fields: 'SFI'
header_rows: 1
table: read_table_from_csv(csv_file, fields, header_rows)

will load a file that looks like:

Racer, Max Speed, Wins
Mario, 30.01, 10
Luigi, 28.02, 12
Toad,  25.00,  7

as so:

KeRF> t: read_table_from_csv('my_logs01.csv', 'SFI', 1)
┌─────┬─────────┬────┐
│Racer│Max Speed│Wins│
├─────┼─────────┼────┤
│Mario│    30.01│  10│
│Luigi│    28.02│  12│
│ Toad│     25.0│   7│
└─────┴─────────┴────┘

The currently supported list of field identifiers is "IFSEGNZz*" integers floats strings enumerated-strings guids/uuids ips custom-datetime custom-datetime2 skipped-field. IP addresses are converted to integers using inet_pton. The custom datetime parser format is set like this

.Parse.strptime_format: '%d-%b-%y %H:%M:%S'  //format for 'Z'
.Parse.strptime_format2:'%d-%b-%y %H:%M:%S'  //format for 'z'

and relies directly on the system strptime format.

Similar functions exist for TSVs and for arbitrary character-delimited files (e.g., pipe-delimited):

read_table_from_tsv('prices.tsv', "SFFF", 1)
read_table_from_delimited_file('\t', 'prices.tsv', "SFFF", 1)
read_table_from_delimited_file('|',  'prices.psv', "SFFF", 1)

┌─────────┬──────┬──────┬──────┐
│id       │rent_1│rent_2│rent_3│
├─────────┼──────┼──────┼──────┤
│E01004236│1100.0│1275.0│1500.0│
│E01004237│1150.0│1550.0│1725.0│
│E01004234│1050.0│1375.0│1650.0│
│E01004235│1025.0│1300.0│1500.0│
│E01004232│ 975.0│1300.0│2025.0│
│E01004233│1050.0│1425.0│1800.0│
│E01004230│1125.0│1300.0│2025.0│
│E01004231│1175.0│1550.0│1725.0│
│       ..│    ..│    ..│    ..│
└─────────┴──────┴──────┴──────┘

Once you've stored such a table in a variable in memory, you can write it to disk for later use using write_to_path:

 t: read_table_from_csv('prices.csv', 'SFF', 1)
 write_to_path('prices.table', t);

To open such a table later call

t: read_from_path('prices.table')  //in-memory only version table
or
t: open_table('prices.table')      //on-disk memory-mapped version of table

CSV/TSV/ETC WRITING

There are two methods for writing delimited files. The first is a convenience method for CSVs:

write_csv_from_table

path: 'my_logs01.csv'
table: my_table
write_csv_from_table(path, table)

The second is the generalized method that lets you specify the delimiter:

write_delimited_file_from_table

path: 'my_logs01.csv'
table: my_table
write_delimited_file_from_table("\t", path, table) //for TSV

write_delimited_file_from_table("|",  path, table) //for PSV

All of these methods require your data to be collected in a table before writing. This simplifies the output process considerably.

FIXED-WIDTH FILE LOADING

Kerf supports fixed-width file loading. The motivating use-case for this is the NYSE TAQ fixed-width format. Perhaps the best way to understand how this works is to look at the NYSE TAQ loading example script. In addition to the fields supported by the CSV-style readers, the fixed-width reader supports the fields "QR", representing NYSE's strange timestamp format, and an enumerated NYSE dot-delimited symbol column.

To invoke the fixed-width field reader, use:

file:'path/to/file.ext'
attributes: {fields: 'Q*R*IF******',  widths: 9 1 16 4 9 11 1 2 16 1 1 2}
read_table_from_fixed_file(file, attributes)

The "attibutes" argument is map. Relevant keys are "fields widths titles header_rows line_limit". "Titles" are column titles. Some keys, such as "line_limit" are not required.

SCRIPTS

Kerf code can be stored in scripts. The suggested extension is .kerf for Kerf scriptfiles. You can load scripts from the console using load, so that if a file myscript.kerf contains the code

a:11
b:22
c:a+b

Then a terminal session that loads the script might look as follows:

KeRF> load 'myscript.kerf'
KeRF> c
  33

Scripts following the binary's name on the command line will be executed in order.

$ ./kerf myscript.kerf b.kerf c.kerf

If a script named "startup.kerf" is present in Kerf's working directory, then it will be executed at startup, before any other command-line scripts. Scripts may be loaded from other scripts.

FLAGS

The -x flag executes and prints its argument. The -e flag executes its argument without printing.

$ ./kerf -x '1+1'
2
$ ./kerf -e '1+1'

The -q or quiet flag starts Kerf without a banner. It has no arugment. The -p flag opens an IPC port on its argument.

Logging is enabled using the -l flag. Currently this logs all incoming network requests to the file kerf.log for possible future replay.

EXITING

From the console, pressing ctrl+d will exit the process. (This sends an end-of-transmission control character.) The Kerf function exit() will end the process via code execution. If you like, you can optionally pass an argument to exit that will be returned by the Kerf process to the shell.

exit()
exit(0)
exit(-1)

TIME MATH

We previously saw absolute time stamps of the form

2015.04.01 or 2015.03.31T01:23:45.877

We can compare them

2015.04.02 < 2015.05.01 
  1

We can modify them using relative times of the form 1y or 1y3d or 4h55i06s and so on. So

2015.04.01 + 1y1m1d
  2016.05.02

Or alternatively as

  2015.04.01 + 1y + 1m + 1d
    2016.05.02

And 2015.04.01 + 1h2i3s gives 2015.04.01T01:02:03.000.

now_date() + 1d
  2015.04.02

now_time()
  21:36:00.762

minus(now_time(), 25 * 1h)
  20:36:02.005

The current list of possibilities is: ymdhis year month day hour minute second.

Note that while minus could be perfectly well defined as an operation on absolute STAMPs (for a given reduced form, it could return a relative stamp), at least for the time being in Kerf it throws a type error. This is easy to get around, do

  2015.04.07 + 1d <= 2015.04.08

instead of

  (2015.04.08 - 2015.04.07) <= 1d 

The reason you might want to avoid producing relative times is that the full range of useful relative dates and times exceeds a 64-bit width and so is not vectorized.

Timestamps are nanosecond granularity. By default only millisecond precision is displayed. But this is cosmetic.

  2001.01.01T01:01:01.012345678['nanosecond']
12345678

To extract individual parts from times, use

a: 2015.03.16T04:05:06.7890123456
a: [a, a] //optional, to see how it works in vector form

a['date']   //stamp
a['time']   //stamp
a['year']   //int
a['month'] 
a['day']
a['hour']
a['minute']
a['second']
a['millisecond']
a['nanosecond'] 

SQL (SELECT)

Kerf is a superset of SQL. This means Kerf speaks SQL, and you can write SQL anywhere inside of Kerf code. Let's start by building a suitable table.

n: 10**4
ids: range(1, n+1)
stamps: plus(NOW(), 1s + mapright range(n))
heartrates: 80 + rand(n, 100.0)  
labels: range(6)
lanes: take(n, join(labels, reverse labels))
running: {{id: ids, stamp: stamps, heartrate: heartrates, lane: lanes}} 


┌──┬───────────────────────┬─────────┬────┐
│id│stamp                  │heartrate│lane│
├──┼───────────────────────┼─────────┼────┤
│ 1│2015.07.06T16:24:55.543│  96.4771│   0│
│ 2│2015.07.06T16:24:56.543│  107.397│   1│
│ 3│2015.07.06T16:24:57.543│  108.356│   2│
│ 4│2015.07.06T16:24:58.543│  92.2126│   3│
│ 5│2015.07.06T16:24:59.543│  125.115│   4│
│ 6│2015.07.06T16:25:00.543│  161.533│   5│
│ 7│2015.07.06T16:25:01.543│  175.726│   5│
│ 8│2015.07.06T16:25:02.543│  118.177│   4│
│..│                     ..│      .. │  ..│
└──┴───────────────────────┴─────────┴────┘

Someone is running a zigzag across a six-lane track with a random heartbeat. This is not exactly realistic data but let's go with it. We can count the number of rows in the table:

select count(*) as rows from running
┌─────┐
│rows │
├─────┤
│10000│
└─────┘

And there's no reason we can't run SQL inside of JSON:

[{a:1, b: select count(*) from running}, select count(*) from running]

Let's verify the count of the table:

equal(count(running), n)

Peek at the first 3 rows:

first(3, running)
┌──┬───────────────────────┬─────────┬────┐
│id│stamp                  │heartrate│lane│
├──┼───────────────────────┼─────────┼────┤
│ 1│2015.07.06T16:24:55.543│  96.4771│   0│
│ 2│2015.07.06T16:24:56.543│  107.397│   1│
│ 3│2015.07.06T16:24:57.543│  108.356│   2│
└──┴───────────────────────┴─────────┴────┘

Get the bounds on the time:

select first(stamp), last(stamp) from running
┌───────────────────────┬───────────────────────┐
│stamp                  │stamp1                 │
├───────────────────────┼───────────────────────┤
│2015.07.06T16:24:55.543│2015.07.06T19:11:34.543│
└───────────────────────┴───────────────────────┘

Alternatively

[first(running.stamp), last(running.stamp)]
[2015.04.01T19:13:33.917, 2015.04.01T22:00:12.917]

And perform GROUP BY and WHERE queries:

select avg(heartrate) from running where heartrate > 100 group by lane
┌────┬─────────┐
│lane│heartrate│
├────┼─────────┤
│   1│  139.192│
│   2│  140.283│
│   4│  139.772│
│   5│   140.24│
│   3│  140.167│
│   0│  138.541│
└────┴─────────┘

Nested subqueries:

select * from (select avg(heartrate) from running where heartrate > 100 group by lane) where heartrate = max(heartrate)
┌────┬─────────┐
│lane│heartrate│
├────┼─────────┤
│   2│  140.283│
└────┴─────────┘

We can store the results of queries in other variables.

b: select max(heartrate) from running where lane = 2
┌─────────┐
│heartrate│
├─────────┤
│  179.976│
└─────────┘

And retrieve the cell value only like so:

first(b.heartrate)
  179.952

The supported SQL WHERE comparison methods currently are:

  < > = <= >= == != <> 

Conjunction in a WHERE clause is indicated using commas, e.g.:

select from running where lane = 2, heartrate = 108.356

┌──┬───────────────────────┬─────────┬────┐
│id│stamp                  │heartrate│lane│
├──┼───────────────────────┼─────────┼────|
│ 3│2015.07.06T16:24:57.543│  108.356│   2│
└──┴───────────────────────┴─────────┴────┘

In Kerf "and" and "or" have different meanings and will operate on the columns prior to serving them up for consideration as indices. When using "or" or "and", be sure to parenthesize the subexpressions. So

select from running where (lane = 2) or (heartrate = 108.356)

The following also works:

select from running where or(lane = 2, heartrate = 108.356)

The supported SQL GROUP BY aggregation methods currently are:

  min max sum count first last avg std var

Kerf can use our nicely sorted ID range to perform fast lookups even without an index. Table traits are undocumented at this point.

LEFT JOIN

A basic left join can be accomplished with the left_join function.

t:{{a:1 2 2 3, b:10 20 30 40}}
u:{{a:2 3, c:1.5 3}}
left_join(t,u,"a")

┌─┬──┬───┐
│a│b │c  │
├─┼──┼───┤
│1│10│nan│
│2│20│1.5│
│2│30│1.5│
│3│40│3.0│
└─┴──┴───┘

The third argument indicates the key or keys to match on. The argument is a string or an array of strings.

u:{{a:2 3, b:30 40, c:1.5 3}}
left_join(t,u,["a","b"])

┌─┬──┬───┐
│a│b │c  │
├─┼──┼───┤
│1│10│nan│
│2│20│nan│
│2│30│1.5│
│3│40│3.0│
└─┴──┴───┘

If your tables don't match on column names, no sweat, use a map.

t:{{a:1 2 2 3, b:10 20 30 40}}
u:{{z:2 3, c:1.5 3}}
left_join(t, u, {'a':'z'})

┌─┬──┬───┐
│a│b │c  │
├─┼──┼───┤
│1│10│nan│
│2│20│1.5│
│2│30│1.5│
│3│40│3.0│
└─┴──┴───┘

ASOF JOIN

One useful time-series operation is the asof join, which is predictably called using the asof_join function. The function accepts four arguments. The first three are the same as in the case of left join, and operate similarly. The third argument indicates columns whose items must match exactly. The fourth argument is a string or array of strings indicating column names. Typically these refer to time columns, though that is not required.

If the columns in the third argument require "exact" matches, then the columns in the fourth argument accept "fuzzy" matches: they'll match on any value up to and including the time in question. Perhaps this is best illustrated with an example. This style of matching is useful for seeing what the latest value at a specific time was, when in reality the last update may have occured some time in the past.

//Example taken from timestored.com
KeRF> trades: {{time: 07:00 08:30 09:59 10:00 12:00 16:00, sym:enum['a','a','a','a','b','a'], price: .9 1.5 1.9 2 9 10, size: 100 700 200 400 500 800}}

┌────────────┬───┬─────┬────┐
│time        │sym│price│size│
├────────────┼───┼─────┼────┤
│07:00:00.000│  a│  0.9│ 100│
│08:30:00.000│  a│  1.5│ 700│
│09:59:00.000│  a│  1.9│ 200│
│10:00:00.000│  a│  2.0│ 400│
│12:00:00.000│  b│  9.0│ 500│
│16:00:00.000│  a│ 10.0│ 800│
└────────────┴───┴─────┴────┘

KeRF> quotes: {{time: 08:00 09:00 10:00 11:00 12:00 13:00 14:00 15:00, sym:enum['a','b','a','b','b','a','b','a'], bid: 1 9 2 8 8.5 3 7 4}}

┌────────────┬───┬───┐
│time        │sym│bid│
├────────────┼───┼───┤
│08:00:00.000│  a│1.0│
│09:00:00.000│  b│9.0│
│10:00:00.000│  a│2.0│
│11:00:00.000│  b│8.0│
│12:00:00.000│  b│8.5│
│13:00:00.000│  a│3.0│
│14:00:00.000│  b│7.0│
│15:00:00.000│  a│4.0│
└────────────┴───┴───┘

KeRF> asof_join(trades, quotes, ['sym'], ['time'])                                                                                            
┌────────────┬───┬─────┬────┬───┐
│time        │sym│price│size│bid│
├────────────┼───┼─────┼────┼───┤
│07:00:00.000│  a│  0.9│ 100│nan│
│08:30:00.000│  a│  1.5│ 700│1.0│
│09:59:00.000│  a│  1.9│ 200│1.0│
│10:00:00.000│  a│  2.0│ 400│2.0│
│12:00:00.000│  b│  9.0│ 500│8.5│
│16:00:00.000│  a│ 10.0│ 800│4.0│
└────────────┴───┴─────┴────┴───┘

Time-series events are necessarily logged at discrete times. Asof Join is a tool that lets us treat a discrete series as if it were continuous.

SQL (DELETE)

The major tradeoff in using columnar storage is that deletes take O(n) time. For millions of rows in memory, this will take in the milliseconds, and so doesn't matter. For on-disk storage, you may want to avoid an architecture that incorporates repeated deletes.

KeRF> n:10**6; t:{{a:range(n), b:rand(n,100.0)}}

┌─┬───────┐
│a│b      │
├─┼───────┤
│0│16.4771│
│1│27.3974│
│2│28.3558│
│3│12.2126│
│4│45.1148│
│5│81.5326│
│6│ 95.726│
│7│38.1769│
│.│     ..│
└─┴───────┘

    14 ms

KeRF> count t
  1000000

KeRF> delete from t where b between [0,50]
  "t"

KeRF> count t
  499326

ADVANCED TYPES

There are two advanced types which we can use for specialized columns:

ENUM (HASH)
              enum ['red', 'blue', 'red']  or hash ['red', 'blue', 'red']
INDEX (SORT)
              index [1, 2, 3]

Both are variations on ARRAYs or VECTORs. An enum is like a "local" string interning object. It keeps only one reference to each object and stores appearances as fixed-width indices. It is useful for storing repetitions of strings and lists, which cannot otherwise efficiently be stored as vectors. In all other respects an enum appears to be an array.

An index is like an array except with an attached b-tree. This can make lookups and range queries more efficient. (The storage format of the index will be breaking after the alpha.) Don't use an index for data you can guarantee will always be sorted ascending, such as autoincrementing primary keys: Kerf will track sorted arrays and doesn't need a special index.

Lambdas are also a type which can be stored.

There is another hypothetical advanced type called an ATLAS, which is the schemaless NoSQL equivalent of a table. Atlases are automatically indexed in such a way that all key-queries are indexed.

INTERPROCESS COMMUNICATION

Kerf instances are designed to be networked. The data structures serialize directly without any intermediate conversion.

To start a Kerf server on port 1234 execute the command:

./kerf -p 1234

You can communicate with this instance either via a Kerf client or via the Kerf SDK/API from another program (e.g., Python or Java or Objective-C).

A client can be a plain old Kerf instance:

./kerf

Note: the server and the client should be separate instances. In the client paste each of the lines individually:

socket: open_socket("localhost","1234")

send_async(socket, "table: {{sym:hash[], time:[], price:[]}}")

do(100) {send_async(socket, "insert into table values {sym:$1, time:$2, price:$3}", [rand(["AAPL","MSFT","IBM"]), now(),  20.0 + rand(10.0) ])}

Then in the server execute:

root

table

select avg(price) from table group by sym

Then in the client execute

close_socket(socket)

Currently IPC requires the user to store the socket handle. Probably what will happen is we will remove this and have all IPC calls use the server and port. It would be simple for Kerf to manage a hashtable of hosts and ports pointing to socket handles, and to keep or refresh them as necessary, and so we should probably do that.

See a longer exposition of this topic on TimeStored: http://www.timestored.com/time-series-data/kerf-database

As you might guess, send_sync is also available. The difference from send_async is that send_sync blocks and returns the evaluated reponse from the remote server.

KeRF> socket: open_socket("localhost","1234")
KeRF> send_sync(socket,"1+11",[])
12

Some IPC-related variables:

.Net.client - current integer handle of the now-processing client
.Net.on_close - one-argument function called on the integer handle of the closing client

Examples:

.Net.on_close: {[x] out 'client closed: ' join (string x) join '\n'}

send_async(socket, "a:2; display .Net.client; out ' is the client\n'")

CONTROL FLOW

Control flow is designed to be as generic as possible. You probably don't need it yet, but Kerf uses:

if(b){x} else if(c){y} else{z} 
do(n){x} 
while(b){x}
for(a;b;c){x} 
def myfunc(arg1, arg2) {x}
function myfunc(arg1, arg2) {x}

All portions must be properly (parenthesized) and {curly-braced}: no skipping. Lambdas are: {[arg1, arg2] arg1+arg2}. Lambda function recursion is self or this. Early return is return, otherwise return the final eval. Note: ending the final eval with a semicolon causes null to be returned. Commas , and semicolons ; are usually interchangeable. Comments are //.

MISC CODE SAMPLES

Examples for average, standard deviation, and variance (avg, std, var).

a: [12, 2.4, 8]   //assign an array to 'a' using JSON notation
a: range(6)       //integers [0, 1, 2, 3, 4, 5]
a: rand(8, 100.0) //eight random floats from the interval [0.0, 100.0)

REPL or API (Cheating):
  avg(a)
  std(a)
  var(a)

REPL or API (Simplified):
  (sum a)/count a              
  sqrt var a                   
  (sum (a - avg a)**2)/count a 

REPL or API (Traditional):
  sum(a)/count(a)               
  sqrt(var(a))                  
  sum((a - avg(a))**2)/count(a)

API Argument Passing, each with 1 argument (Traditional):
  sum($1)/count($1)               
  sqrt(var($1))                  
  sum(($1 - avg($1))**2)/count($1)

Function Definition (Traditional):
  def my_func_avg(a) {sum(a)/count(a)}
  def my_func_std(a) {sqrt(var(a))}
  def my_func_var(a) {sum((a - avg(a))**2)/count(a)}

Lambdas (Traditional):
  {[a] sum(a)/count(a)}
  {[a] sqrt(var(a))}
  {[a] sum((a - avg(a))**2)/count(a)}

REPL or API (Variant Takes)
  (plus fold a)/len(a)
  sum((a minus avg(a)) pow 2) divide count(a)
  pow(std a, 2) 

LEGAL

MISC LANGUAGE SPECS

Kerf is written in C. Kerf is a superset of both JSON and SQL. Kerf compiles to Kerf bytecode. Memory management is automatic and invisible to the user. Internally, Kerf uses reference counting. Kerf does not garbage collect. Kerf uses copy-on-write. Kerf uses a memory pool, so warmed operations are faster. Kerf does not expose pointers. It does not use globally interned strings. Certain objects will intern strings locally. Kerf data structures use optimized hash tables and b-trees. All Kerf objects serialize automatically and use the same [decompressed] representation in-memory, on-disk, and over the network. IPC is compressed when it would lower transfer times. By default the PRNG is initialized with a nondeterministic seed. By default times are UTC.