garyvidal / ml-bucketeer

A set of MarkLogic aggregate user defined functions in a native plugin for grouping values in a map.

MarkLogic Bucketeer Native Plugin

What it does

It creates 'buckets' in a map object based off of a regular expression ("regex") or specified parts of dateTime ("dateTime"). For example, if you want to bucket based off of the first character of an string you could pass "^.". (See Executing for full example). Arguments after that are options. You can have "case-insensitive" or "capture-overflow" to catch items that might not match the regular expression.

For dateTime you can specify any combination of the following to bucket by. Default is ("year","month"). -"year" -"month" -"day-of-year" -"day-of-month" -"day-of-week" -"hour" -"minute" -"second"

Requirements

For all Unix systems (Linux, Mac OS X, Solaris), GNU GCC and GNU make utilities are required.

For Windows systems, Visual Studio 2008 and Cygwin with GNU make utility are required. For Vista and above (Windows 7, Windows 8, Windows Server 2008+) you may need to copy this entire directory out of Program Files to another directory in order to work around Windows security problems writing into Program Files.

Installing

From command line:

make

From QConsole:

xquery version "1.0-ml";
import module namespace plugin = "http://marklogic.com/extension/plugin"
  at "MarkLogic/plugin/plugin.xqy";

plugin:install-from-zip("native",
  xdmp:document-get("<path-to-plugin>/bucketeer-audf.zip")/node())

Executing

xquery version "1.0-ml";

cts:aggregate(
  "native/bucketeer-audf", 
  "regex", 
  cts:element-reference(xs:QName("name"),"collation=http://marklogic.com/collation/codepoint"),
  ("^[a-z]", "case-insensitive","capture-overflow")
),
cts:aggregate(
  "native/bucketeer-audf", 
  "dateTime", 
  cts:element-reference(xs:QName("dateTime"),"type=dateTime"),
  ("year","month")
)