Developer Docs
API Reference
Services
Schema Builder
Classes
Class: ProgressiveSchemaBuilder

web


web / lib/services/schema-builder / ProgressiveSchemaBuilder

Class: ProgressiveSchemaBuilder

Constructors

Constructor

new ProgressiveSchemaBuilder(initialState?, config?): ProgressiveSchemaBuilder

Parameters

initialState?

SchemaBuilderState

config?

Partial<{ maxSamples: number; maxUniqueValues: number; enumThreshold: number; enumMode: "count" | "percentage"; maxDepth: number; }>

Returns

ProgressiveSchemaBuilder

Methods

processBatch()

processBatch(records, batchNumber): Promise<{ schemaChanged: boolean; changes: SchemaChange[]; }>

Parameters

records

any[]

batchNumber

number

Returns

Promise<{ schemaChanged: boolean; changes: SchemaChange[]; }>


generateSchema()

generateSchema(): Promise<any>

Returns

Promise<any>


getEnumCount()

getEnumCount(): number

Returns

number


getGeoFieldCount()

getGeoFieldCount(): number

Returns

number


getState()

getState(): SchemaBuilderState

Returns

SchemaBuilderState


getSchema()

getSchema(): Promise<unknown>

Returns

Promise<unknown>


compareWithPrevious()

compareWithPrevious(previousSchema): Promise<SchemaComparison>

Parameters

previousSchema

any

Returns

Promise<SchemaComparison>