Skip to main content

SchemaDriftError

@webda/sql

Class: SchemaDriftError

Defined in: packages/sql/src/relational/sync.ts:37

The database differs from the plan and the store is not allowed to change it (schemaSync: "validate")

Extends​

  • CodeError

Constructors​

Constructor​

new SchemaDriftError(steps, drift): SchemaDriftError

Defined in: packages/sql/src/relational/sync.ts:43

Create a new SchemaDriftError instance

Parameters​

steps​

SchemaStep[]

the changes sync would apply

drift​

SchemaDrift[]

the differences sync never resolves

Returns​

SchemaDriftError

Overrides​

WebdaError.CodeError.constructor

Properties​

code​

code: string

Defined in: packages/core/lib/errors/errors.d.ts:8

Code

Inherited from​

WebdaError.CodeError.code

drift​

readonly drift: SchemaDrift[]

Defined in: packages/sql/src/relational/sync.ts:45

the differences sync never resolves

message​

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from​

WebdaError.CodeError.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from​

WebdaError.CodeError.name

stack?​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

WebdaError.CodeError.stack

steps​

readonly steps: SchemaStep[]

Defined in: packages/sql/src/relational/sync.ts:44

the changes sync would apply

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.6.6/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

WebdaError.CodeError.stackTraceLimit

Methods​

getCode()​

getCode(): string

Defined in: packages/core/lib/errors/errors.d.ts:19

Return error code

Returns​

string

the result

Inherited from​

WebdaError.CodeError.getCode

getResponseCode()​

getResponseCode(): number

Defined in: packages/core/lib/errors/errors.d.ts:24

Http response code

Returns​

number

the result

Inherited from​

WebdaError.CodeError.getResponseCode

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@26.6.6/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

WebdaError.CodeError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@26.6.6/node_modules/@types/node/globals.d.ts:55

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

WebdaError.CodeError.prepareStackTrace