Skip to main content

ParquetSchema<T>

Typed Parquet schema.

Extends

  • ParquetSchema

Type Parameters

Type Parameter
T

Constructors

new ParquetSchema()

new ParquetSchema<T>(schema): ParquetSchema<T>

Create a new schema from a JSON schema definition

Parameters

ParameterType
schemaSchemaDefinition

Returns

ParquetSchema<T>

Inherited from

BaseParquetSchema.constructor

Properties

fieldList

fieldList: ParquetField[];

Inherited from

BaseParquetSchema.fieldList


fields

fields: Record<string, ParquetField>;

Inherited from

BaseParquetSchema.fields


schema

schema: ParquetSchemaDefinition<T>;

Overrides

BaseParquetSchema.schema

Methods

findField()

findField(path): ParquetField

Retrieve a field definition

Parameters

ParameterType
pathstring | string[]

Returns

ParquetField

Inherited from

BaseParquetSchema.findField


findFieldBranch()

findFieldBranch(path): ParquetField[]

Retrieve a field definition and all the field's ancestors

Parameters

ParameterType
pathstring | string[]

Returns

ParquetField[]

Inherited from

BaseParquetSchema.findFieldBranch


fromJsonSchema()

static fromJsonSchema(jsonSchema): ParquetSchema

Create a new schema from JSON Schema (json-schema.org)

Parameters

ParameterType
jsonSchemaJSONSchema4

Returns

ParquetSchema

Inherited from

BaseParquetSchema.fromJsonSchema