prorm API Reference
    Preparing search index...

    Variable ORMDecoratorsConst

    ORMDecorators: {
        Table: "Table";
        Schema: "Schema";
        Column: "Column";
        PrimaryKey: "PrimaryKey";
        Check: "Check";
        Unique: "Unique";
        Default: "Default";
        ForeignKey: "ForeignKey";
        Index: "Index";
        Partition: "Partition";
        BelongsTo: "BelongsTo";
        HasOne: "HasOne";
        HasMany: "HasMany";
        BelongsToMany: "BelongsToMany";
        BeforeCreate: "BeforeCreate";
        BeforeBulkCreate: "BeforeBulkCreate";
        BeforeUpdate: "BeforeUpdate";
        BeforeBulkUpdate: "BeforeBulkUpdate";
        BeforeDelete: "BeforeDelete";
        BeforeBulkDelete: "BeforeBulkDelete";
        BeforeFind: "BeforeFind";
        BeforeFindAfterExpandOptions: "BeforeFindAfterExpandOptions";
        BeforeFindAfterSetup: "BeforeFindAfterSetup";
        BeforeInit: "BeforeInit";
        BeforeConnect: "BeforeConnect";
        BeforeQuery: "BeforeQuery";
        BeforeSync: "BeforeSync";
        AfterCreate: "AfterCreate";
        AfterBulkCreate: "AfterBulkCreate";
        AfterUpdate: "AfterUpdate";
        AfterBulkUpdate: "AfterBulkUpdate";
        AfterDelete: "AfterDelete";
        AfterBulkDelete: "AfterBulkDelete";
        AfterFind: "AfterFind";
        AfterInit: "AfterInit";
        AfterConnect: "AfterConnect";
        AfterQuery: "AfterQuery";
        AfterSync: "AfterSync";
        Virtual: "Virtual";
        Generated: "Generated";
        Identity: "Identity";
        DefaultScope: "DefaultScope";
        Scopes: "Scopes";
        Scope: "Scope";
        Paranoid: "Paranoid";
        CreatedAt: "CreatedAt";
        UpdatedAt: "UpdatedAt";
        DeletedAt: "DeletedAt";
        Version: "Version";
        Trigger: "Trigger";
        Procedure: "Procedure";
        Function: "Function";
        SqlFunction: "SqlFunction";
        Sequence: "Sequence";
        Extension: "Extension";
        RowLevelSecurity: "RowLevelSecurity";
        Policy: "Policy";
        Inheritance: "Inheritance";
        PartitionPostgres: "Partition";
        Event: "Event";
        Routine: "Routine";
        ForeignTable: "ForeignTable";
        View: "View";
        ForeignKeyChecks: "ForeignKeyChecks";
        DatabaseSetting: "DatabaseSetting";
        Comment: "Comment";
        Secure: "Secure";
        SecureField: "SecureField";
        Permission: "Permission";
        CanView: "CanView";
        CannotView: "CannotView";
        CanWrite: "CanWrite";
        CannotWrite: "CannotWrite";
        Audit: "Audit";
        AuditChange: "AuditChange";
        AuditLog: "AuditLog";
        Validate: "Validate";
        Is: "Is";
        IsAlpha: "IsAlpha";
        IsAlphanumeric: "IsAlphanumeric";
        IsNumeric: "IsNumeric";
        IsEmail: "IsEmail";
        IsURL: "IsURL";
        IsIP: "IsIP";
        IsDate: "IsDate";
        IsInt: "IsInt";
        IsFloat: "IsFloat";
        IsBoolean: "IsBoolean";
        IsUUID: "IsUUID";
        IsJSON: "IsJSON";
        IsNull: "IsNull";
        NotEmpty: "NotEmpty";
        Len: "Len";
        Min: "Min";
        Max: "Max";
        IsIn: "IsIn";
        NotIn: "NotIn";
        Regexp: "Regexp";
        NotRegexp: "NotRegexp";
        IsCreditCard: "IsCreditCard";
        IsISBN: "IsISBN";
        IsMobilePhone: "IsMobilePhone";
        IsPostalCode: "IsPostalCode";
        IsCurrency: "IsCurrency";
        IsOctal: "IsOctal";
        IsDivisibleBy: "IsDivisibleBy";
        IndexAlt: "Index";
        Raw: "Raw";
    } = ...

    All ORM decorator names organized by category.

    This constant provides a centralized registry of decorator names used throughout the ORM for documentation, tooling, and reflection.

    Type Declaration

    • ReadonlyTable: "Table"

      Model/table decorator

    • ReadonlySchema: "Schema"

      Schema/database schema decorator

    • ReadonlyColumn: "Column"

      Column/property decorator

    • ReadonlyPrimaryKey: "PrimaryKey"

      Primary key decorator

    • ReadonlyCheck: "Check"

      Check constraint decorator

    • ReadonlyUnique: "Unique"

      Unique constraint decorator

    • ReadonlyDefault: "Default"

      Default value decorator

    • ReadonlyForeignKey: "ForeignKey"

      Foreign key decorator

    • ReadonlyIndex: "Index"

      Index decorator

    • ReadonlyPartition: "Partition"

      Partition decorator

    • ReadonlyBelongsTo: "BelongsTo"

      BelongsTo association decorator

    • ReadonlyHasOne: "HasOne"

      HasOne association decorator

    • ReadonlyHasMany: "HasMany"

      HasMany association decorator

    • ReadonlyBelongsToMany: "BelongsToMany"

      Many-to-many (junction) association decorator

    • ReadonlyBeforeCreate: "BeforeCreate"

      Before create hook

    • ReadonlyBeforeBulkCreate: "BeforeBulkCreate"

      Before bulk create hook

    • ReadonlyBeforeUpdate: "BeforeUpdate"

      Before update hook

    • ReadonlyBeforeBulkUpdate: "BeforeBulkUpdate"

      Before bulk update hook

    • ReadonlyBeforeDelete: "BeforeDelete"

      Before delete hook

    • ReadonlyBeforeBulkDelete: "BeforeBulkDelete"

      Before bulk delete hook

    • ReadonlyBeforeFind: "BeforeFind"

      Before find hook

    • ReadonlyBeforeFindAfterExpandOptions: "BeforeFindAfterExpandOptions"

      Before find after expand options hook

    • ReadonlyBeforeFindAfterSetup: "BeforeFindAfterSetup"

      Before find after distribution hook

    • ReadonlyBeforeInit: "BeforeInit"

      Before init hook

    • ReadonlyBeforeConnect: "BeforeConnect"

      Before connect hook

    • ReadonlyBeforeQuery: "BeforeQuery"

      Before query hook

    • ReadonlyBeforeSync: "BeforeSync"

      Before sync hook

    • ReadonlyAfterCreate: "AfterCreate"

      After create hook

    • ReadonlyAfterBulkCreate: "AfterBulkCreate"

      After bulk create hook

    • ReadonlyAfterUpdate: "AfterUpdate"

      After update hook

    • ReadonlyAfterBulkUpdate: "AfterBulkUpdate"

      After bulk update hook

    • ReadonlyAfterDelete: "AfterDelete"

      After delete hook

    • ReadonlyAfterBulkDelete: "AfterBulkDelete"

      After bulk delete hook

    • ReadonlyAfterFind: "AfterFind"

      After find hook

    • ReadonlyAfterInit: "AfterInit"

      After init hook

    • ReadonlyAfterConnect: "AfterConnect"

      After connect hook

    • ReadonlyAfterQuery: "AfterQuery"

      After query hook

    • ReadonlyAfterSync: "AfterSync"

      After sync hook

    • ReadonlyVirtual: "Virtual"

      Virtual/computed column decorator

    • ReadonlyGenerated: "Generated"

      Generated column decorator

    • ReadonlyIdentity: "Identity"

      Identity/auto-increment decorator

    • ReadonlyDefaultScope: "DefaultScope"

      Default scope decorator

    • ReadonlyScopes: "Scopes"

      Named scopes decorator

    • ReadonlyScope: "Scope"

      Scope decorator (single)

    • ReadonlyParanoid: "Paranoid"

      Paranoid (soft delete) decorator

    • ReadonlyCreatedAt: "CreatedAt"

      CreatedAt timestamp decorator

    • ReadonlyUpdatedAt: "UpdatedAt"

      UpdatedAt timestamp decorator

    • ReadonlyDeletedAt: "DeletedAt"

      DeletedAt timestamp decorator

    • ReadonlyVersion: "Version"

      Version (optimistic locking) decorator

    • ReadonlyTrigger: "Trigger"

      Trigger decorator

    • ReadonlyProcedure: "Procedure"

      Stored procedure decorator

    • ReadonlyFunction: "Function"

      SQL function decorator

    • ReadonlySqlFunction: "SqlFunction"

      Function: 'Function' (alias for clarity)

    • ReadonlySequence: "Sequence"

      Sequence decorator

    • ReadonlyExtension: "Extension"

      Extension decorator

    • ReadonlyRowLevelSecurity: "RowLevelSecurity"

      Row-level security decorator

    • ReadonlyPolicy: "Policy"

      Policy decorator

    • ReadonlyInheritance: "Inheritance"

      Table inheritance decorator

    • ReadonlyPartitionPostgres: "Partition"

      Partition decorator (PostgreSQL specific)

    • ReadonlyEvent: "Event"

      Event decorator (MySQL/MariaDB)

    • ReadonlyRoutine: "Routine"

      Stored routine decorator

    • ReadonlyForeignTable: "ForeignTable"

      Foreign table decorator (SQLite FDW)

    • ReadonlyView: "View"

      View decorator

    • ReadonlyForeignKeyChecks: "ForeignKeyChecks"

      Foreign key checks setting decorator

    • ReadonlyDatabaseSetting: "DatabaseSetting"

      Database setting decorator

    • ReadonlyComment: "Comment"

      Comment decorator

    • ReadonlySecure: "Secure"

      Secure field decorator

    • ReadonlySecureField: "SecureField"

      Secure field decorator (alias)

    • ReadonlyPermission: "Permission"

      Permission decorator

    • ReadonlyCanView: "CanView"

      Can view decorator

    • ReadonlyCannotView: "CannotView"

      Cannot view decorator

    • ReadonlyCanWrite: "CanWrite"

      Can write decorator

    • ReadonlyCannotWrite: "CannotWrite"

      Cannot write decorator

    • ReadonlyAudit: "Audit"

      Audit decorator

    • ReadonlyAuditChange: "AuditChange"

      AuditChange decorator

    • ReadonlyAuditLog: "AuditLog"

      AuditLog decorator

    • ReadonlyValidate: "Validate"

      Validate decorator

    • ReadonlyIs: "Is"

      Is decorator (validation rule)

    • ReadonlyIsAlpha: "IsAlpha"

      IsAlpha decorator

    • ReadonlyIsAlphanumeric: "IsAlphanumeric"

      IsAlphanumeric decorator

    • ReadonlyIsNumeric: "IsNumeric"

      IsNumeric decorator

    • ReadonlyIsEmail: "IsEmail"

      IsEmail decorator

    • ReadonlyIsURL: "IsURL"

      IsURL decorator

    • ReadonlyIsIP: "IsIP"

      IsIP decorator

    • ReadonlyIsDate: "IsDate"

      IsDate decorator

    • ReadonlyIsInt: "IsInt"

      IsInt decorator

    • ReadonlyIsFloat: "IsFloat"

      IsFloat decorator

    • ReadonlyIsBoolean: "IsBoolean"

      IsBoolean decorator

    • ReadonlyIsUUID: "IsUUID"

      IsUUID decorator

    • ReadonlyIsJSON: "IsJSON"

      IsJSON decorator

    • ReadonlyIsNull: "IsNull"

      IsNull decorator

    • ReadonlyNotEmpty: "NotEmpty"

      NotEmpty decorator

    • ReadonlyLen: "Len"

      Len decorator (length validation)

    • ReadonlyMin: "Min"

      Min decorator

    • ReadonlyMax: "Max"

      Max decorator

    • ReadonlyIsIn: "IsIn"

      IsIn decorator

    • ReadonlyNotIn: "NotIn"

      NotIn decorator

    • ReadonlyRegexp: "Regexp"

      Regexp decorator

    • ReadonlyNotRegexp: "NotRegexp"

      NotRegexp decorator

    • ReadonlyIsCreditCard: "IsCreditCard"

      IsCreditCard decorator

    • ReadonlyIsISBN: "IsISBN"

      IsISBN decorator

    • ReadonlyIsMobilePhone: "IsMobilePhone"

      IsMobilePhone decorator

    • ReadonlyIsPostalCode: "IsPostalCode"

      IsPostalCode decorator

    • ReadonlyIsCurrency: "IsCurrency"

      IsCurrency decorator

    • ReadonlyIsOctal: "IsOctal"

      IsOctal decorator

    • ReadonlyIsDivisibleBy: "IsDivisibleBy"

      IsDivisibleBy decorator

    • ReadonlyIndexAlt: "Index"

      Index (alias for backward compatibility)

    • ReadonlyRaw: "Raw"

      Raw decorator for raw SQL