Developer Docs
API Reference
Services
Schema Versioning
Classes
Class: SchemaVersioningService

web


web / lib/services/schema-versioning / SchemaVersioningService

Class: SchemaVersioningService

Consolidated schema versioning service to prevent duplicate creation and ensure consistent version numbering across auto and manual approval flows

Constructors

Constructor

new SchemaVersioningService(): SchemaVersioningService

Returns

SchemaVersioningService

Methods

getNextSchemaVersion()

static getNextSchemaVersion(payload, datasetId): Promise<number>

Get the next schema version number for a dataset

Parameters

payload

BasePayload

datasetId

string | number

Returns

Promise<number>


createSchemaVersion()

static createSchemaVersion(payload, __namedParameters): Promise<DatasetSchema>

Create a new schema version with consistent data structure

Parameters

payload

BasePayload

__namedParameters
dataset

string | number | Dataset

schema

unknown

fieldMetadata?

Record<string, unknown> = {}

autoApproved?

boolean = false

approvedBy?

null | string | number

importSources?

object[] = []

Returns

Promise<DatasetSchema>


linkImportToSchemaVersion()

static linkImportToSchemaVersion(payload, importJobId, schemaVersionId): Promise<void>

Link an import job to a schema version

Parameters

payload

BasePayload

importJobId

string | number

schemaVersionId

string | number

Returns

Promise<void>