Contact language

contact.md

/* comments */
// comments

Connections, misc

// default connection, this is used if a named connection 
// is not specified in a fetch, put, delete
connect "127.0.0.1:10017";
connect "127.0.0.1:10017" as $foo;
// $ prefix references a single node
connect "192.168.1.5:10017" as $bar;
// * prefix references many nodes
group $foo, $bar as *mynodes;

// execute a fetch against $foo
using bucket "Foo" fetch "MyKey" @ $foo; 

// execute a fetch against $foo AND $bar
using bucket "Foo" fetch "MyKey" @ *mynodes; 
connections;
exit

Buckets

use bucket "Foo";
get bucket; // shows "current" bucket
using bucket "Foo" … (fetch/put/etc)

// specify default options to use for the current session
use bucket "Foo"
        with fetch options r = 1;

use bucket "Foo"
    with fetch options  r = 1
    and  store options  w = 1, dw=1
    and  delete options foo = "baz"
    and query2i options foo = "bar";
	// use these options UNLESS a user overrides them on get/put

using bucket "Foo" get properties; // displays properties

use bucket "Foo";
set properties n_val=2, allow_siblings=false;
    
// these ops should probably prompt the user:
// this op can slow down a system, continue?
list buckets; 
using bucket "Foo" list keys; 
using bucket "Foo" count keys;

Fetch

using bucket "Foo" fetch "MyKey";
use bucket "Foo";
fetch "MyKey";

// fetch returns the value by default
fetch "MyKey" 
    with options 
        r = 1,
        pr = 1;
        
// fetch metadata + value from "MyKey"        
using bucket "Foo" 
	fetch 
		key, value, vclock 
	from "MyKey"
	with options
		r = 1;        

CRDT Fetch

// fetch the current value for the gold crdt counter
fetch .gold
	from "MyKey"
	with options
		r = 1;        

// does .weapons.mace exist in the set?
fetch .weapons.mace? 
	from "MyKey"
	with options
		r = 1;
				
// fetch all values from the bar map stored inside the foo map
fetch .foo.bar.* 
	from "MyKey";
	
// return everything, *decoded from crdt term*	
fetch .* from "MyKey"; 
							
// multiple queries into the crdt			
fetch .foo.bar.baz, .gold from "MyKey"; 

// metadata: use a $ prefix so users can store a "keys" or "values" key
fetch .foo.$keys from "MyKey";
fetch .foo.$values from "MyKey";
fetch .foo.$count from "MyKey";
// return the CRDT type
fetch .foo.$type from "MyKey";

Store

using bucket "Foo" 
    store "MyKey" 
    with text "This is text";

using bucket "Foo" 
    store "MyKey" 
    with json "{foo:bar}";
    
using bucket "Foo" 
    store "MyKey" 
    with xml "<foo>bar</foo>";

store "MyKey" with content-type "text/csv" and "1,2,3,4";            

// store value AND other metadata
using bucket "Foo" 
    store 
    	value "MyKey" 
    	and vclock = "xyz"
    with xml "<foo>bar</foo>";

using bucket "Foo" 
    store "MyKey" 
        with text "This is text" 
        with options w = 1, pw = 2;

using bucket "Foo" 
    store "MyKey" 
        with index "twitter_bin" = "test" 
        and index "github_bin" = "test2" 
        and index "foo_int" = 1000
        and text "This is text";

store "MyKey" 
        with index "twitter_bin" = "test" 
        and index "github_bin" = "test2" 
        and text "This is text";

CRDT Store

store "MyKey" 
	with 
	  //unnamed root node
	  map() values 
		counter gold inc 10, 
		counter stone dec 1
		set(weapons) values
			mace,
			sword,
			"warm beer"
		end,
		map(foo) values
			map(bar) values
				counter baz inc 1
			end
		end
	end;	

##Delete

using bucket "Foo" delete "MyKey";

delete "MyKey";

delete "MyKey" and options w="1";

##2i

using bucket "Foo" query2i with index "range_int" and value 1;
using bucket "Foo" query2i with index "foo_bin" and value "bar";

use bucket "Foo";
query2i with index "range_int" and value 21;
query2i with index "range_int" from 1 to 2;

Sean suggested sharing the syntax between CRDT queries and non-CRDT queries (ie. query into JSON etc)