arquero/src/format/to-arrow-ipc.js

Query processing and transformation of array-backed data tables.

import { tableToIPC } from '@uwdata/flechette';
import { toArrow } from './to-arrow.js';

/**
 * Format a table as binary data in the Apache Arrow IPC format.
 * @param {import('../table/Table.js').Table} data The table data
 * @param {import('./types.js').ArrowIPCFormatOptions} [options]
 *  The Arrow IPC formatting options. Set the *format* option to `'stream'`
 *  or `'file'` to specify the IPC format.
 * @return {Uint8Array} A new Uint8Array of Arrow-encoded binary data.
 */
export function toArrowIPC(data, options = {}) {
  const { format = 'stream', ...toArrowOptions } = options;
  return tableToIPC(toArrow(data, toArrowOptions), { format });
}