Xlsxir
Xlsxir is an Elixir library that parses .xlsx
files using Simple API for XML (SAX) parsing via the Erlsom Erlang library, extracts the data to an Erlang Term Storage (ETS) process and provides various functions for accessing the data. Xlsxir supports ISO 8601 date formats and large files. Testing has been limited to various documents I have created or have access to and any issues submitted through GitHub, though I have succesfully parsed a worksheet containing 100 rows and 514K columns. Please submit any issues found and they will be addressed ASAP.
Installation
You can add Xlsxir as a dependancy to your Elixir project via the Hex package manager by adding the following to your mix.exs
file:
def deps do
[ {:xlsxir, "~> 1.1.0"} ]
end
Or, you can directly reference the GitHub repo:
def deps do
[ {:xlsxir, github: "kennellroxco/xlsxir"} ]
end
Basic Usage
Xlsxir parses a .xlsx
file located at a given path
and extracts the data to an ETS process via the Xlsxir.extract/3
function:
Xlsxir.extract(path, index, timer \\ false)
Argument descriptions:
path
the path of the file to be parsed instring
formatindex
is the position of the worksheet you wish to parse (zero-based index)timer
is a boolean flag that controls an extraction timer that returns time elapsed when set totrue
. Defalut value isfalse
.
Upon successful completion, the extraction process returns:
:ok
withtimer
set tofalse
{:ok, time_elapsed}
withtimer
set totrue
The extracted worksheet data can be accessed using any of the following functions:
Xlsxir.get_list
Xlsxir.get_map
Xlsxir.get_cell(cell_ref)
Xlsxir.get_row(row_num)
Xlsxir.get_col(col_ltr)
Xlsxir.get_info(num_type)
Xlsxir.get_list/0
returns entire worksheet in a list of row lists (i.e. [[row 1 values], ...]
)
Xlsxir.get_map/0
returns entire worksheet in a map of cell names and values (i.e. %{"A1" => value, ...}
)
Xlsxir.get_cell/1
returns value of specified cell (i.e. "A1"
returns value contained in cell A1)
Xlsxir.get_row/1
returns values of specified row (i.e. 1
returns the first row of data)
Xlsxir.get_col/1
returns values of specified column (i.e. "A"
returns the first column of data)
Xlsxir.get_info/1
returns count data for num_type
specified (i.e. :rows
, :cols
, :cells
, :all
)
Once the table data is no longer needed, run the following function to delete the ETS process and free memory:
Xlsxir.close
Be sure to close an open ETS process before trying to parse another worksheet in the same session or process. If you try to open a new :worksheet
ETS process when one already exists, you will get an error.
Refer to API Reference for more detailed examples.
Considerations
Cell references are formatted as a string (i.e. “A1”). Strings will be returned as type string
, resulting values for functions from within the worksheet are returned as type string
, integer
or float
depending on the type of the resulting value, data formatted as a number in the worksheet will be returned as type integer
or float
, and ISO 8601 date formatted values will be returned in Erlang :calendar.date()
type format (i.e. {year, month, day}
). Xlsxir does not currently support dates prior to 1/1/1900.
Contributing
Contributions are encouraged. Feel free to fork the repo, add your code along with appropriate tests and documentation (ensuring all existing tests continue to pass) and submit a pull request.
Bug Reporting
Please report any bugs or request future enhancements via the Issues page.