spreadsheet-to-json

Convert Spreadsheets and CSV files to jSON

Battle-tested with spreadsheets under 10MB; recent releases handle much larger files. See version history below.

This library crate provides the core functions to convert common spreadsheet and CSV files into JSON or JSONL (JSON Lines) either directly or asynchronously.

It relies on the Calamine and CSV library crates to process files, the tokio crate for asynchronous operations and naturally serde and serde_json serialization libraries.

It supports the following formats:

• Excel 2007+ Workbook (.xlsx)
• Excel 2007+ Macro-Enabled Workbook (.xlsm) -- read as plain data; macros are ignored
• Excel 2007+ Binary (.xlsb)
• Excel 97-2004 Legacy (.xls)
• OpenDocument Spreadsheets (.ods) compatible with LibreOffice
• CSV: comma separated values (.csv)
• TSV: tab-separated values (.tsv)

Features

• Blazingly fast: It can import 10,000 rows in less than 0.4 seconds.
• Can export to standard JSON or to JSON lines when writing large files
• Formula cells are read as calculated values
• Can identify and convert both Excel's 1900 datetime format and standard ISO format as used in OpenDocument Spreadsheet
• Can identify numeric fields formatted as text and convert them to integers or floats.
• Can identify truthy text or number cells and convert them to booleans
• Can save large files asynchronously

Core Options

Options can be set by instantiating OptionSet::new("path/to/spreadsheet.xlsx") with chained setter methods:

• .max_row_count(max: u32): overrides the default max row count of 10,000. Use this is direct mode or to return only the first n rows.
• .header_row(index: u8) overrides the default header row index of 0, useful for spreadsheets with a title and notes on top
• .omit_header() omit the header altogether and assign default A1-style keys or column numbers.
• .sheet_index(index: u32) zero-based sheer index. Any value over zero will override the specified sheet name.
• .sheet_name(name: &str) case-insensitive sheet name. It will match the first sheet with name after stripping spaces and punctuation.
• .read_mode_async() Defer processing of rows with a callback in the second argument in render_spreadsheet_async()
• .json_lines() Output will be rendered one json object per row.
• field_name_mode(system: &str, override_header: bool): use either A1 (a, b, ... z, aa, ab, ...) or C-prefixed zero-padded numbers (c01, c02, ...) for the default column key notation where headers are either unavailable or suppressed via the override_header flag. The C-style padding width scales with the sheet's total column count, so keys still sort correctly regardless of width: c01..c99 under 100 columns, c001..c999 from 100 up to 1,000, c0001..c9999 from 1,000 up to 10,000 (see build_padded_col_key in headers.rs).
• override_headers(keys: &[&str]) Override matched or automatic column keys. More advanced column options will be detailed soon.
• override_columns(cols: &[Value]) Lets you override column settings, represented here as an array of serde_json::Value key/value objects, where :
  • key: overrides the header key,
  • format: string | integer | float | d1 ... d8 | datetime | date | boolean | truthy | truthy:true_key,false_key
    • d1 to d8 will round floats to the specified max. number of decimal places.
    • boolean will cast integer, floats >= 1 as true as well as the strings '1' and 'true', with < 1 and the strings 0 and false being false. If unmatched or empty the field value will be null.
    • truthy will cast common English-like abbreviations such as Y, Yes as true and N or No false
    • truthy:true_key,false_key lets you cast custom strings to true or false. If unmatched the field value will be null.
  • default: overrides the default value for empty cells.

The C-style keys are prefixed with c rather than left as bare zero-padded numbers ("001", "002", ...) for two reasons: zero-padding alone guarantees the keys sort correctly as plain strings in virtually any programming language, and a bare numeric-looking string is a confusing choice for an object/map key -- it's easy to mistake for an array index, and some languages treat numeric-looking string keys specially. If you actually want positional access instead of keyed access, that's a one-liner in most languages regardless of how the keys are named -- in JavaScript, for example, Object.values(row) turns a row object into a plain array of its values in field order.

To do

More details of options to come.

Simple example:

  let opts = OptionsSet::new("path/to/spreadsheet.ods")
      .sheet_index(3)
      .read_mode_async()
      .override_headers(&["name", "height", "width", "weight", "hue", "price"]);

Core functions

• process_spreadsheet_direct(opts: &OptionSet): May be called in a synchronous context where you need to process results immediately.

• process_spreadsheet_async(opts: &OptionSet): Asynchronously processes files with a callback function to save each row.

Result set

• filename: Matched filename,
• extension: Matched extension
• sheet: Matched worksheet name and index
• sheets: List of available worksheet names
• keys: Assigned column keys
• num_rows: number of rows in the source file that have been successfully parsed
• data: Vector of dynamic objects (IndexMap<String, Value>) that can be easily translated into JSON or other common formats.
• out_ref: Optional output reference such as a generated file name, URL or database id.

If the file name and extension cannot be matched, because the file is unavailable or unsupported, the core functions will return a generic error.

Result Set methods

• to_json(): Converts to the result set to serde_json::Value that may be printed directly or written to a file.
• to_output_lines(json_lines: bool): Returns a vector of plain-text results with each data row as JSON on a new line
• rows(): Returns a vector of rendered JSON strings
• json_data(): Returns all data as as serde_json::Value::Array ready for conversion or post-processing.

Examples

The main implementation is my unpublished Spreadsheet to JSON CLI crate,

Simple immediate jSON conversion

This function processes the spreadsheet file immediately.

use spreadsheet_to_json::*;

fn main() -> Result<(), GenericError> {
  let opts = OptionSet::new("path/to/spreadsheet.xlsx").sheet_index(1);
  let result = process_spreadsheet_direct(&opts);
  let json_value = match result {
    Err(msg_code) => json!({ "error": true, "key": msg_code.to_string() }),
    Ok(data_set) => data_set.to_json() // full result set
  };
  println!("{}", json_value);
  Ok(())
}

Preview multiple worksheets

You may preview all worksheets and limit the number of sample rows from each sheet.

use spreadsheet_to_json::*;

fn main() -> Result<(), GenericError> {
  // set the read mode to PreviewMultiple and limit output to the first 10 data rows
  let opts = OptionSet::new("path/to/spreadsheet-with-2-worksheets.xlsx")
    .read_mode_preview()
    .max_row_count(10)
    .json_lines();

  let result = process_spreadsheet_direct(&opts);
  // output each line
  for line in result.to_output_lines() {
    println!("{}", line);
  }
  Ok(())
}

Asynchronous parsing and saving to a database

This must be called in an async function with a callback to save rows in separate processes.

use spreadsheet_to_json::*;
use spreadsheet_to_json::tokio;
use indexmap::IndexMap;
use serde_json::Value;

#[tokio::main]
async fn main() -> Result<(), GenericError> {
  let opts = OptionSet::new("path/to/spreadsheet.xlsx").read_mode_async();

  let callback = move |row: IndexMap<String, Value>| -> Result<(), GenericError> {
    save_data_row(row, &connection, dataset_id)
  };

  let result = process_spreadsheet_async(&opts, Box::new(callback), None).await;
  // A successful result set will have an output reference rather than the actual data
  let result_set = match result {
      Err(msg_code) => json!({ "error": true, "key": msg_code.to_string() }),
      Ok(data_set) => data_set.to_json() 
  };
  println!("{}", result_set);
  Ok(())
}

// Save function called in a closure for each row with a database connection and data_id from the outer scope
fn save_data_row(row: IndexMap<String, Value>, connection: &PgConnection, data_id: u32) -> Result<(), GenericError> {
    let mut row_struct = CustomTableStruct {
    id: None,
    data_id: data_id, // or whatever ID setting logic you have
    field1: None,
    field2: None,
    // ... set other fields to None or default values
  };
  
  for (key, value) in row {
    match key.as_str() {
        "field1" => {
            if let Value::String(s) = value {
                row_struct.field1 = Some(s.clone());
            }
        },
        "field2" => {
            if let Value::Number(n) = value {
                if let Some(i) = n.as_i64() {
                    row_struct.field2 = Some(i as i32);
                }
            }
        },
        // Add other field mappings here
        _ => {} // Ignore unknown keys
    }
  }
  diesel::insert_into("data_rows")
  .values(&row_struct)
  .execute(connection)
  .map_err(|_| GenericError("database_error"))?;
  Ok(())
}

Version History

• 0.1.2 the core public functions with Result return types now use a GenericError error type
• 0.1.3 Refined A1 and C01 column name styles and added result output as vectors of lines for interoperability with CLI utilities and debugging.
• 0.1.4 Added support for the Excel Binary format (.xlsb)
• 0.1.5 Added two new core functions process_spreadsheet_direct() for direct row processing in a synchronous context and process_spreadsheet_async() in an asynchronous context with a callback. If you need to process a spreadsheet directly in an async function
• 0.1.6 Deprecated public function beginning with render (render_spreadsheet_direct() has become. You should use process_spreadsheet_immediate() for immediate processing of spreadsheets in an async context). Ensured the header row does not appear as the first data row in spreadsheets.
• 0.1.7 Added support for multiple worksheets in preview mode and refined output options
• 0.1.10 Reviewed date-time parsing options for Excel and OpenDocument spreadsheets. Reorganised cell post-processors by detected data-type.
• 0.2.0 Bumped calamine to 0.36.0. Switched is-truthy, alphanumeric and simple-string-patterns from local path dependencies to their published crates.io versions — is-truthy gained a TruthyRuleSet builder (options()/true_options()/false_options(), replacing the old TruthyOption vector plumbing). Fixed the CSV reader silently ignoring its own default row cap (DEFAULT_MAX_ROWS) when no explicit .max_row_count() was set — large uploads could load unbounded into memory. Fixed a panic in Column::from_json on a non-string format field. Assorted performance fixes: redundant Column/Format clones per cell, a fresh Arc allocated per CSV row instead of once per file, a double clone in ResultSet::rows(). Fixed a panic in read_workbook_sheet_info on an unreadable individual sheet.
• 0.2.1 Bumped is-truthy to 0.1.2, fixing CSV cells like "SKU001" or a date starting "01/..." being silently coerced to the boolean true/false just because they contained an embedded 0 or 1. Added Column::source_key (and Column::from_source_key_with_format()): a column override can now be matched by its natural, auto-detected key wherever that column actually is, instead of strictly by position — see resolve_columns()/natural_column_keys() in headers.rs. Overrides with no source_key still apply positionally, unchanged. Fixed Format::Integer on a CSV cell with a decimal value (e.g. "58.2") silently producing 0 instead of the truncated integer.
• 0.2.2 Fixed a per-column Format::Date/Format::DateTime override having no effect at all on real (non-string) datetime cells in xlsx/ods — only the row-wide --date-only-style default was ever consulted for Data::DateTime/Data::DateTimeIso cells, so casting a single datetime column to date-only silently did nothing; see resolve_date_only() in reader.rs. Fixed is_not_header_row misclassifying the header row as real data (leaking it into the output as a bogus extra row) whenever any column had a non-Auto Format — it used to compare the row's already-formatted values against the header text, and formatting the header row's own text (e.g. through a date or decimal parse) commonly turns it into null or something else that no longer matches; it now compares raw, un-coerced cell text instead. Both bugs affected the xlsx/ods path only, not CSV/TSV.
• 0.2.3 Added .xlsm (macro-enabled Excel workbook) support. .xlsm uses the exact same OOXML container as .xlsx and calamine has always read both through its Xlsx reader, but this crate's own Extension enum only recognised the .xlsx extension, so .xlsm files were rejected before calamine ever got a chance to open them.