Skip to main content
Version: Next

MetadataError <T>

Error thrown when entity metadata is invalid, incomplete, or inconsistent.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • message: string
    • optionalentity: T

    Returns MetadataError<T>

Properties

optionalinheritedcause

cause?: unknown

optionalreadonlyinheritedentity

entity?: T

inheritedmessage

message: string

inheritedname

name: string

optionalinheritedstack

stack?: string

staticinheritedstackTraceLimit

stackTraceLimit: number

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.

Methods

inheritedgetEntity

  • getEntity(): undefined | Partial<any>

  • Gets instance of entity that caused this error.

    Returns undefined | Partial<any>

staticambiguousEntityName

staticinheritedcannotCommit

  • Returns ValidationError<Partial<any>>

staticinheritedcannotModifyInverseCollection

  • cannotModifyInverseCollection(owner, property): ValidationError<Partial<any>>

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritedcannotModifyReadonlyCollection

  • cannotModifyReadonlyCollection(owner, property): ValidationError<Partial<any>>

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritedcannotRemoveFromCollectionWithoutOrphanRemoval

  • cannotRemoveFromCollectionWithoutOrphanRemoval(owner, property): ValidationError<Partial<any>>

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritedcannotStageNonScalarSessionVariable

  • cannotStageNonScalarSessionVariable(filterName, argName): ValidationError<Partial<any>>

  • Parameters

    • filterName: string
    • argName: string

    Returns ValidationError<Partial<any>>

staticinheritedcannotUseGlobalContext

  • Returns ValidationError<Partial<any>>

staticinheritedcannotUseGroupOperatorsInsideScalars

  • cannotUseGroupOperatorsInsideScalars(entityName, propName, payload): ValidationError<Partial<any>>

  • Parameters

    • entityName: EntityName
    • propName: string
    • payload: unknown

    Returns ValidationError<Partial<any>>

staticinheritedcannotUseOperatorsInsideEmbeddables

  • cannotUseOperatorsInsideEmbeddables(entityName, propName, payload): ValidationError<Partial<any>>

  • Parameters

    • entityName: EntityName
    • propName: string
    • payload: unknown

    Returns ValidationError<Partial<any>>

staticinheritedcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt): void

  • 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
    • optionalconstructorOpt: Function

    Returns void

staticinheritedconnectionSessionContextNotSupported

  • Returns ValidationError<Partial<any>>

staticdangerousPropertyName

staticduplicateEntityDiscovered

staticduplicateFieldName

  • duplicateFieldName(entityName, names): MetadataError<Partial<any>>

staticduplicatePolicyName

staticinheritedentityNotManaged

  • Parameters

    • entity: Partial<any>

    Returns ValidationError<Partial<any>>

staticfromInversideSidePrimary

  • fromInversideSidePrimary(meta, owner, prop): MetadataError<Partial<any>>

staticinheritedfromMergeWithoutPK

staticfromMissingOption

  • fromMissingOption(meta, prop, option): MetadataError<Partial<any>>

staticfromMissingPrimaryKey

staticfromUnknownEntity

  • fromUnknownEntity(entityName, source): MetadataError<Partial<any>>

  • Parameters

    • entityName: string
    • source: string

    Returns MetadataError<Partial<any>>

staticfromWrongForeignKey

  • fromWrongForeignKey(meta, prop, key): MetadataError<Partial<any>>

staticfromWrongOwnership

staticinheritedfromWrongPropertyType

  • fromWrongPropertyType(entity, property, expectedType, givenType, givenValue): ValidationError<Partial<any>>

  • Parameters

    • entity: Partial<any>
    • property: string
    • expectedType: string
    • givenType: string
    • givenValue: string

    Returns ValidationError<Partial<any>>

staticfromWrongReference

  • fromWrongReference(meta, prop, key, owner): MetadataError<Partial<any>>

staticfromWrongReferenceKind

  • fromWrongReferenceKind(meta, owner, prop): MetadataError<Partial<any>>

staticinheritedfromWrongRepositoryType

  • fromWrongRepositoryType(entityName, repoType, method): ValidationError<Partial<any>>

  • Parameters

    • entityName: string
    • repoType: string
    • method: string

    Returns ValidationError<Partial<any>>

staticfromWrongTypeDefinition

staticincompatiblePolymorphicTargets

  • incompatiblePolymorphicTargets(meta, prop, target1, target2, reason): MetadataError<Partial<any>>

staticinheritedinvalidCollectionValues

  • invalidCollectionValues(entityName, propName, invalid): ValidationError<Partial<any>>

  • Parameters

    • entityName: string
    • propName: string
    • invalid: unknown

    Returns ValidationError<Partial<any>>

staticinheritedinvalidCompositeIdentifier

staticinheritedinvalidEmbeddableQuery

  • invalidEmbeddableQuery(entityName, propName, embeddableType): ValidationError<Partial<any>>

  • Parameters

    • entityName: EntityName
    • propName: string
    • embeddableType: string

    Returns ValidationError<Partial<any>>

staticinheritedinvalidEnumArrayItems

  • Parameters

    • entityName: string
    • invalid: unknown

    Returns ValidationError<Partial<any>>

staticinvalidManyToManyWithPivotEntity

  • invalidManyToManyWithPivotEntity(meta1, prop1, meta2, prop2): MetadataError<Partial<any>>

staticinvalidPrimaryKey

  • invalidPrimaryKey(meta, prop, requiredName): MetadataError<Partial<any>>

staticinheritedinvalidPropertyName

  • Parameters

    Returns ValidationError<Partial<any>>

staticinheritedinvalidQueryCondition

  • Parameters

    • cond: unknown

    Returns ValidationError<Partial<any>>

staticinheritedinvalidType

  • Parameters

    Returns ValidationError<Partial<any>>

staticinvalidVersionFieldType

staticmissingMetadata

staticmixedInheritanceStrategies

  • mixedInheritanceStrategies(root, child): MetadataError<Partial<any>>

staticmultipleDecorators

  • multipleDecorators(entityName, propertyName): MetadataError<Partial<any>>

  • Parameters

    • entityName: string
    • propertyName: string

    Returns MetadataError<Partial<any>>

staticmultipleVersionFields

staticnoEntityDiscovered

staticnonPersistentCompositeProp

  • nonPersistentCompositeProp(meta, prop): MetadataError<Partial<any>>

staticinheritednotDiscoveredEntity

staticinheritednotEntity

  • Parameters

    Returns ValidationError<Partial<any>>

staticonlyAbstractEntitiesDiscovered

staticinheritedprepareStackTrace

  • prepareStackTrace(err, stackTraces): any

staticinheritedpropertyRequired

  • Parameters

    Returns ValidationError<Partial<any>>

staticpropertyTargetsEntityType

  • propertyTargetsEntityType(meta, prop, target): MetadataError<Partial<any>>

staticrlsFilterCannotBeRegisteredAtRuntime

  • rlsFilterCannotBeRegisteredAtRuntime(filterName): MetadataError<Partial<any>>

  • Thrown when an entity-scoped rls filter is registered at runtime via em.addFilter() instead of in metadata.

    Parameters

    • filterName: string

    Returns MetadataError<Partial<any>>

staticrlsFilterDependsOnRuntimeState

  • rlsFilterDependsOnRuntimeState(filterName): MetadataError<Partial<any>>

  • Thrown when an rls filter's condition depends on runtime state and cannot be compiled to a static policy.

    Parameters

    • filterName: string

    Returns MetadataError<Partial<any>>

staticrlsFilterMultiArgSetting

  • rlsFilterMultiArgSetting(filterName, args): MetadataError<Partial<any>>

  • Thrown when a filter's custom setting is used with more than one argument.

    Parameters

    • filterName: string
    • args: string[]

    Returns MetadataError<Partial<any>>

staticrlsFilterMustBeEntityScoped

  • rlsFilterMustBeEntityScoped(filterName): MetadataError<Partial<any>>

  • Thrown when a global (config or EM registered) filter is flagged with rls; RLS filters must be entity scoped.

    Parameters

    • filterName: string

    Returns MetadataError<Partial<any>>

staticrlsFilterNotSupportedByDriver

  • rlsFilterNotSupportedByDriver(meta, filterName): MetadataError<Partial<any>>

  • Thrown when a filter flagged with rls is declared on a driver that does not support row level security.

    Parameters

    Returns MetadataError<Partial<any>>

staticrlsFilterOnNonRootStiEntity

  • rlsFilterOnNonRootStiEntity(meta, filterName): MetadataError<Partial<any>>

  • Thrown when a filter flagged with rls is declared on a non-root entity of an STI hierarchy.

    Parameters

    Returns MetadataError<Partial<any>>

staticrlsFilterUncastableType

  • rlsFilterUncastableType(filterName, columnType): MetadataError<Partial<any>>

  • Thrown when an rls filter compares against a column whose type has no automatic session-variable cast.

    Parameters

    • filterName: string
    • columnType: string

    Returns MetadataError<Partial<any>>

staticrlsFilterUnmanagedColumn

  • rlsFilterUnmanagedColumn(filterName, column): MetadataError<Partial<any>>

  • Thrown when an rls filter compares against a column the schema generator does not manage.

    Parameters

    • filterName: string
    • column: string

    Returns MetadataError<Partial<any>>

staticrlsFilterUnsupportedCond

  • rlsFilterUnsupportedCond(filterName): MetadataError<Partial<any>>

  • Thrown when an rls filter references an argument outside of a direct comparison, which cannot be compiled.

    Parameters

    • filterName: string

    Returns MetadataError<Partial<any>>

staticrowLevelSecurityNotSupportedByDriver

  • rowLevelSecurityNotSupportedByDriver(meta): MetadataError<Partial<any>>

staticrowLevelSecurityOnNonRootStiEntity

  • rowLevelSecurityOnNonRootStiEntity(meta): MetadataError<Partial<any>>

staticinheritedsessionContextInsideTransaction

  • Parameters

    • action: set | clear = 'set'

    Returns ValidationError<Partial<any>>

staticinheritedsessionContextNotSupported

  • Returns ValidationError<Partial<any>>

staticinheritedsessionContextRequiresImplicitTransactions

  • sessionContextRequiresImplicitTransactions(): ValidationError<Partial<any>>

  • Returns ValidationError<Partial<any>>

staticinheritedsessionContextStreamRequiresTransaction

  • Returns ValidationError<Partial<any>>

staticinheritedsessionContextWithDisabledTransactions

  • Returns ValidationError<Partial<any>>

statictargetIsAbstract

statictargetKeyNotFound

  • targetKeyNotFound(meta, prop, target): MetadataError<Partial<any>>

statictargetKeyNotUnique

  • targetKeyNotUnique(meta, prop, target): MetadataError<Partial<any>>

statictargetKeyOnManyToMany

staticthroughRelationCompositeTarget

  • throughRelationCompositeTarget(meta, prop): MetadataError<Partial<any>>

staticthroughRelationInvalidKind

  • throughRelationInvalidKind(meta, prop): MetadataError<Partial<any>>

staticthroughRelationMissingProperty

  • throughRelationMissingProperty(meta, prop, through, side): MetadataError<Partial<any>>

statictptNotSupportedByDriver

staticinheritedtransactionRequired

  • Returns ValidationError<Partial<any>>

statictriggersNotSupportedByDriver

staticunknownIndexProperty

  • unknownIndexProperty(meta, prop, type): MetadataError<Partial<any>>

staticviewEntityWithoutExpression

Page Options