Skip to content
benrudolph edited this page Oct 21, 2014 · 8 revisions

HXL API Reference

HXL.foreach(filename, options, &block)

This reads a standard HXL encoded CSV and yields each row. The HXL class will use compact disaggregation to build the new CSV. Read more here.

HXL.concat([filenames], options, &block)

Concat takes a list of filenames and concats the HXL encoded files together, intelligently matching columns based on their HXL tag.

HXL.join([filenames], on, options, &block)

Join takes a list of filenames and joins the file on a specified HXL tag. If any of the files do not contain the column specified in the on parameter, a MissingColumnException will be thrown.

HXL.read(filename, options, &block)

Returns an array of arrays in properly formatted HXL.

Clone this wiki locally