Rename ColumnData to ColumnSource

This commit is contained in:
Kenny Daniel 2025-05-31 16:48:33 -07:00
parent 427c59fe53
commit b8227afdde
No known key found for this signature in database
GPG Key ID: 90AB653A8CAD7E45
6 changed files with 17 additions and 17 deletions

@ -51,15 +51,15 @@
"test": "vitest run"
},
"dependencies": {
"hyparquet": "1.13.1"
"hyparquet": "1.15.0"
},
"devDependencies": {
"@babel/eslint-parser": "7.27.1",
"@types/node": "22.15.17",
"@vitest/coverage-v8": "3.1.3",
"eslint": "9.26.0",
"eslint-plugin-jsdoc": "50.6.11",
"@types/node": "22.15.29",
"@vitest/coverage-v8": "3.1.4",
"eslint": "9.28.0",
"eslint-plugin-jsdoc": "50.6.17",
"typescript": "5.8.3",
"vitest": "3.1.3"
"vitest": "3.1.4"
}
}

@ -5,7 +5,7 @@ import { writeMetadata } from './metadata.js'
* ParquetWriter class allows incremental writing of parquet files.
*
* @import {ColumnChunk, FileMetaData, KeyValue, RowGroup, SchemaElement} from 'hyparquet'
* @import {ColumnData, Writer} from '../src/types.js'
* @import {ColumnSource, Writer} from '../src/types.js'
* @param {object} options
* @param {Writer} options.writer
* @param {SchemaElement[]} options.schema
@ -22,7 +22,7 @@ export function ParquetWriter({ writer, schema, compressed = true, statistics =
/** @type {RowGroup[]} */
this.row_groups = []
this.num_rows = BigInt(0)
this.num_rows = 0n
// write header PAR1
this.writer.appendUint32(0x31524150)
@ -33,7 +33,7 @@ export function ParquetWriter({ writer, schema, compressed = true, statistics =
* Will split data into row groups of the specified size.
*
* @param {object} options
* @param {ColumnData[]} options.columnData
* @param {ColumnSource[]} options.columnData
* @param {number} [options.rowGroupSize]
*/
ParquetWriter.prototype.write = function({ columnData, rowGroupSize = 100000 }) {

@ -3,7 +3,7 @@
* Accepts optional schemaOverrides to override the type of columns by name.
*
* @param {object} options
* @param {ColumnData[]} options.columnData
* @param {ColumnSource[]} options.columnData
* @param {Record<string,SchemaElement>} [options.schemaOverrides]
* @returns {SchemaElement[]}
*/
@ -43,7 +43,7 @@ export function schemaFromColumnData({ columnData, schemaOverrides }) {
/**
* @import {ConvertedType, DecodedArray, FieldRepetitionType, ParquetType, SchemaElement} from 'hyparquet'
* @import {BasicType, ColumnData} from '../src/types.js'
* @import {BasicType, ColumnSource} from '../src/types.js'
* @param {string} name
* @param {BasicType} type
* @param {boolean} [nullable]

4
src/types.d.ts vendored

@ -16,7 +16,7 @@ export type BasicType =
export interface ParquetWriteOptions {
writer: Writer
columnData: ColumnData[]
columnData: ColumnSource[]
schema?: SchemaElement[]
compressed?: boolean
statistics?: boolean
@ -24,7 +24,7 @@ export interface ParquetWriteOptions {
kvMetadata?: KeyValue[]
}
export interface ColumnData {
export interface ColumnSource {
name: string
data: DecodedArray
type?: BasicType

@ -1,4 +1,4 @@
/** @type {ColumnData[]} */
/** @type {ColumnSource[]} */
export const exampleData = [
{ name: 'bool', data: [true, false, true, false] },
{ name: 'int', data: [0, 127, 0x7fff, 0x7fffffff] },
@ -11,7 +11,7 @@ export const exampleData = [
/**
* @import {FileMetaData} from 'hyparquet'
* @import {ColumnData} from '../src/types.js'
* @import {ColumnSource} from '../src/types.js'
* @type {FileMetaData}
*/
export const exampleMetadata = {

@ -6,8 +6,8 @@ import { exampleData, exampleMetadata } from './example.js'
/**
* Utility to encode a parquet file and then read it back into a JS object.
*
* @import {ColumnData} from '../src/types.js'
* @param {ColumnData[]} columnData
* @import {ColumnSource} from '../src/types.js'
* @param {ColumnSource[]} columnData
* @param {import('hyparquet').SchemaElement[]} [schema]
* @returns {Promise<Record<string, any>>}
*/