Class ForeignKeyConstraintError

Error for foreign key constraint violations

Hierarchy (View Summary)

PrormError
- ForeignKeyConstraintError

Index

Constructors

Properties

code parent? sql? metadata? field? table? value?

Methods

Constructors

constructor

new ForeignKeyConstraintError(
    message?: string,
    options?: {
        code?: ErrorCode;
        field?: string;
        table?: string;
        value?: unknown;
        parent?: Error;
        sql?: string;
    },
): ForeignKeyConstraintError
Parameters
- message: string = 'Foreign key constraint violation'
- options: {
      code?: ErrorCode;
      field?: string;
      table?: string;
      value?: unknown;
      parent?: Error;
      sql?: string;
  } = {}
Returns ForeignKeyConstraintError
Overrides PrormError.constructor
- Defined in errors/index.ts:341

Properties

`Readonly`code

code: ErrorCode

Unique error code for programmatic handling

`Optional` `Readonly`parent

parent?: Error

Original error that caused this error

`Optional` `Readonly`sql

sql?: string

SQL query that caused the error

`Optional` `Readonly`metadata

metadata?: Record<string, unknown>

Additional error properties

`Optional` `Readonly`field

field?: string

The foreign key field that caused the violation

`Optional` `Readonly`table

table?: string

The table that references the foreign key

`Optional` `Readonly`value

value?: unknown

The value that was used

Methods

toJSON

toJSON(): Record<string, unknown>
Convert to JSON for serialization

Returns Record<string, unknown>
Inherited from PrormError.toJSON
- Defined in errors/index.ts:84

`Static`from

from(
parent: Error,
options?: { field?: string; table?: string; value?: unknown; sql?: string },
): ForeignKeyConstraintError
Create from database error
Parameters
- parent: Error
- options: { field?: string; table?: string; value?: unknown; sql?: string } = {}
Returns ForeignKeyConstraintError
- Defined in errors/index.ts:376