#! /usr/bin/env node "use strict"; // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. Object.defineProperty(exports, "__esModule", { value: true }); const tslib_1 = require("tslib"); /* eslint-disable unicorn/no-array-for-each */ const fs = tslib_1.__importStar(require("fs")); const stream = tslib_1.__importStar(require("stream")); const pretty_js_1 = require("../util/pretty.js"); const Arrow_node_js_1 = require("../Arrow.node.js"); const command_line_usage_1 = tslib_1.__importDefault(require("command-line-usage")); const command_line_args_1 = tslib_1.__importDefault(require("command-line-args")); const pad_left_1 = tslib_1.__importDefault(require("pad-left")); // @ts-ignore const json_bignum_1 = require("json-bignum"); const argv = (0, command_line_args_1.default)(cliOpts(), { partial: true }); const files = argv.help ? [] : [...(argv.file || []), ...(argv._unknown || [])].filter(Boolean); const state = Object.assign(Object.assign({}, argv), { closed: false, maxColWidths: [10] }); (() => tslib_1.__awaiter(void 0, void 0, void 0, function* () { var e_1, _a; const sources = argv.help ? [] : [ ...files.map((file) => () => fs.createReadStream(file)), ...(process.stdin.isTTY ? [] : [() => process.stdin]) ].filter(Boolean); let reader; let hasReaders = false; for (const source of sources) { if (state.closed) { break; } try { for (var _b = (e_1 = void 0, tslib_1.__asyncValues(recordBatchReaders(source))), _c; _c = yield _b.next(), !_c.done;) { reader = _c.value; hasReaders = true; const transformToString = batchesToString(state, reader.schema); yield pipeTo(reader.pipe(transformToString), process.stdout, { end: false }).catch(() => state.closed = true); // Handle EPIPE errors } } catch (e_1_1) { e_1 = { error: e_1_1 }; } finally { try { if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b); } finally { if (e_1) throw e_1.error; } } if (state.closed) { break; } } return hasReaders ? 0 : print_usage(); }))() .then((x) => +x || 0, (err) => { if (err) { console.error(`${(err === null || err === void 0 ? void 0 : err.stack) || err}`); } return process.exitCode || 1; }).then((code) => process.exit(code)); function pipeTo(source, sink, opts) { return new Promise((resolve, reject) => { source.on('end', onEnd).pipe(sink, opts).on('error', onErr); function onEnd() { done(undefined, resolve); } function onErr(err) { done(err, reject); } function done(e, cb) { source.removeListener('end', onEnd); sink.removeListener('error', onErr); cb(e); } }); } function recordBatchReaders(createSourceStream) { return tslib_1.__asyncGenerator(this, arguments, function* recordBatchReaders_1() { var e_2, _a, e_3, _b; const json = new Arrow_node_js_1.AsyncByteQueue(); const stream = new Arrow_node_js_1.AsyncByteQueue(); const source = createSourceStream(); let reader = null; let readers = null; // tee the input source, just in case it's JSON source.on('end', () => [stream, json].forEach((y) => y.close())) .on('data', (x) => [stream, json].forEach((y) => y.write(x))) .on('error', (e) => [stream, json].forEach((y) => y.abort(e))); try { try { for (var _c = tslib_1.__asyncValues(Arrow_node_js_1.RecordBatchReader.readAll(stream)), _d; _d = yield tslib_1.__await(_c.next()), !_d.done;) { reader = _d.value; reader && (yield yield tslib_1.__await(reader)); } } catch (e_2_1) { e_2 = { error: e_2_1 }; } finally { try { if (_d && !_d.done && (_a = _c.return)) yield tslib_1.__await(_a.call(_c)); } finally { if (e_2) throw e_2.error; } } if (reader) return yield tslib_1.__await(void 0); } catch (_e) { readers = null; } if (!readers) { yield tslib_1.__await(json.closed); if (source instanceof fs.ReadStream) { source.close(); } // If the data in the `json` ByteQueue parses to JSON, then assume it's Arrow JSON from a file or stdin try { try { for (var _f = tslib_1.__asyncValues(Arrow_node_js_1.RecordBatchReader.readAll((0, json_bignum_1.parse)(yield tslib_1.__await(json.toString())))), _g; _g = yield tslib_1.__await(_f.next()), !_g.done;) { reader = _g.value; reader && (yield yield tslib_1.__await(reader)); } } catch (e_3_1) { e_3 = { error: e_3_1 }; } finally { try { if (_g && !_g.done && (_b = _f.return)) yield tslib_1.__await(_b.call(_f)); } finally { if (e_3) throw e_3.error; } } } catch (_h) { readers = null; } } }); } function batchesToString(state, schema) { let rowId = 0; let batchId = -1; let maxColWidths = [10]; const { hr, sep, metadata } = state; const header = ['row_id', ...schema.fields.map((f) => `${f}`)].map(val => (0, pretty_js_1.valueToString)(val)); state.maxColWidths = header.map((x, i) => Math.max(maxColWidths[i] || 0, x.length)); return new stream.Transform({ encoding: 'utf8', writableObjectMode: true, readableObjectMode: false, final(cb) { // if there were no batches, then print the Schema, and metadata if (batchId === -1) { hr && this.push(`${horizontalRule(state.maxColWidths, hr, sep)}\n\n`); this.push(`${formatRow(header, maxColWidths, sep)}\n`); if (metadata && schema.metadata.size > 0) { this.push(`metadata:\n${formatMetadata(schema.metadata)}\n`); } } hr && this.push(`${horizontalRule(state.maxColWidths, hr, sep)}\n\n`); cb(); }, transform(batch, _enc, cb) { var _a; batch = !((_a = state.schema) === null || _a === void 0 ? void 0 : _a.length) ? batch : batch.select(state.schema); if (state.closed) { return cb(undefined, null); } // Pass one to convert to strings and count max column widths state.maxColWidths = measureColumnWidths(rowId, batch, header.map((x, i) => Math.max(maxColWidths[i] || 0, x.length))); // If this is the first batch in a stream, print a top horizontal rule, schema metadata, and if (++batchId === 0) { hr && this.push(`${horizontalRule(state.maxColWidths, hr, sep)}\n`); if (metadata && batch.schema.metadata.size > 0) { this.push(`metadata:\n${formatMetadata(batch.schema.metadata)}\n`); hr && this.push(`${horizontalRule(state.maxColWidths, hr, sep)}\n`); } if (batch.numRows <= 0 || batch.numCols <= 0) { this.push(`${formatRow(header, maxColWidths = state.maxColWidths, sep)}\n`); } } if (batch.numRows > 0 && batch.numCols > 0) { // If any of the column widths changed, print the header again if (rowId % 350 !== 0 && JSON.stringify(state.maxColWidths) !== JSON.stringify(maxColWidths)) { this.push(`${formatRow(header, state.maxColWidths, sep)}\n`); } maxColWidths = state.maxColWidths; for (const row of batch) { if (state.closed) { break; } else if (!row) { continue; } if (rowId % 350 === 0) { this.push(`${formatRow(header, maxColWidths, sep)}\n`); } this.push(`${formatRow([rowId++, ...row.toArray()].map(v => (0, pretty_js_1.valueToString)(v)), maxColWidths, sep)}\n`); } } cb(); } }); } function horizontalRule(maxColWidths, hr = '', sep = ' | ') { return ` ${(0, pad_left_1.default)('', maxColWidths.reduce((x, y) => x + y, -2 + maxColWidths.length * sep.length), hr)}`; } function formatRow(row = [], maxColWidths = [], sep = ' | ') { return `${row.map((x, j) => (0, pad_left_1.default)(x, maxColWidths[j])).join(sep)}`; } function formatMetadataValue(value = '') { let parsed = value; try { parsed = JSON.stringify(JSON.parse(value), null, 2); } catch (_a) { parsed = value; } return (0, pretty_js_1.valueToString)(parsed).split('\n').join('\n '); } function formatMetadata(metadata) { return [...metadata].map(([key, val]) => ` ${key}: ${formatMetadataValue(val)}`).join(', \n'); } function measureColumnWidths(rowId, batch, maxColWidths = []) { let val, j = 0; for (const row of batch) { if (!row) { continue; } maxColWidths[j = 0] = Math.max(maxColWidths[0] || 0, (`${rowId++}`).length); for (val of row) { if (val && typedArrayElementWidths.has(val.constructor) && (typeof val[Symbol.toPrimitive] !== 'function')) { // If we're printing a column of TypedArrays, ensure the column is wide enough to accommodate // the widest possible element for a given byte size, since JS omits leading zeroes. For example: // 1 | [1137743649,2170567488,244696391,2122556476] // 2 | null // 3 | [637174007,2142281880,961736230,2912449282] // 4 | [1035112265,21832886,412842672,2207710517] // 5 | null // 6 | null // 7 | [2755142991,4192423256,2994359,467878370] const elementWidth = typedArrayElementWidths.get(val.constructor); maxColWidths[j + 1] = Math.max(maxColWidths[j + 1] || 0, 2 + // brackets on each end (val.length - 1) + // commas between elements (val.length * elementWidth) // width of stringified 2^N-1 ); } else { maxColWidths[j + 1] = Math.max(maxColWidths[j + 1] || 0, (0, pretty_js_1.valueToString)(val).length); } ++j; } } return maxColWidths; } // Measure the stringified representation of 2^N-1 for each TypedArray variant const typedArrayElementWidths = (() => { const maxElementWidth = (ArrayType) => { const octets = Array.from({ length: ArrayType.BYTES_PER_ELEMENT - 1 }, _ => 255); return `${new ArrayType(new Uint8Array([...octets, 254]).buffer)[0]}`.length; }; return new Map([ [Int8Array, maxElementWidth(Int8Array)], [Int16Array, maxElementWidth(Int16Array)], [Int32Array, maxElementWidth(Int32Array)], [Uint8Array, maxElementWidth(Uint8Array)], [Uint16Array, maxElementWidth(Uint16Array)], [Uint32Array, maxElementWidth(Uint32Array)], [Float32Array, maxElementWidth(Float32Array)], [Float64Array, maxElementWidth(Float64Array)], [Uint8ClampedArray, maxElementWidth(Uint8ClampedArray)] ]); })(); function cliOpts() { return [ { type: String, name: 'schema', alias: 's', optional: true, multiple: true, typeLabel: '{underline columns}', description: 'A space-delimited list of column names' }, { type: String, name: 'file', alias: 'f', optional: true, multiple: true, description: 'The Arrow file to read' }, { type: String, name: 'sep', optional: true, default: ' | ', description: 'The column separator character (default: " | ")' }, { type: String, name: 'hr', optional: true, default: '', description: 'The horizontal border character (default: "")' }, { type: Boolean, name: 'metadata', alias: 'm', optional: true, default: false, description: 'Flag to print Schema metadata (default: false)' }, { type: Boolean, name: 'help', optional: true, default: false, description: 'Print this usage guide.' } ]; } function print_usage() { console.log((0, command_line_usage_1.default)([ { header: 'arrow2csv', content: 'Print a CSV from an Arrow file' }, { header: 'Synopsis', content: [ '$ arrow2csv {underline file.arrow} [{bold --schema} column_name ...]', '$ arrow2csv [{bold --schema} column_name ...] [{bold --file} {underline file.arrow}]', '$ arrow2csv {bold -s} column_1 {bold -s} column_2 [{bold -f} {underline file.arrow}]', '$ arrow2csv [{bold --help}]' ] }, { header: 'Options', optionList: cliOpts() }, { header: 'Example', content: [ '$ arrow2csv --schema foo baz --sep " , " -f simple.arrow', '> "row_id", "foo: Int32", "baz: Utf8"', '> 0, 1, "aa"', '> 1, null, null', '> 2, 3, null', '> 3, 4, "bbb"', '> 4, 5, "cccc"', ] } ])); return 1; } //# sourceMappingURL=arrow2csv.js.map