Skip to main content

Variable: EntitySchema

const EntitySchema: ObjectSchema<{
  additionalProperties: OptionalSchema<GenericSchema<FieldType>, undefined>;
  dbName: OptionalSchema<StringSchema<undefined>, undefined>;
  doc: OptionalSchema<StringSchema<undefined>, undefined>;
  enums: OptionalSchema<RecordSchema<StringSchema<undefined>, ObjectSchema<{
     dbName: OptionalSchema<StringSchema<undefined>, undefined>;
     doc: OptionalSchema<StringSchema<undefined>, undefined>;
     name: StringSchema<undefined>;
     values: ArraySchema<ObjectSchema<{
        dbName: OptionalSchema<StringSchema<...>, undefined>;
        doc: OptionalSchema<StringSchema<...>, undefined>;
        name: StringSchema<undefined>;
     }, undefined>, undefined>;
  }, undefined>, undefined>, undefined>;
  fields: ArraySchema<ObjectSchema<{
     constraints: ObjectSchema<{
        format: OptionalSchema<PicklistSchema<["email", "url", "uuid", "cuid", "cuid2", "ulid", "datetime", "date", "time", "duration", "ipv4", "ipv6"], undefined>, undefined>;
        max: OptionalSchema<NumberSchema<undefined>, undefined>;
        maxLength: OptionalSchema<NumberSchema<undefined>, undefined>;
        min: OptionalSchema<NumberSchema<undefined>, undefined>;
        minLength: OptionalSchema<NumberSchema<undefined>, undefined>;
        regex: OptionalSchema<StringSchema<undefined>, undefined>;
        unique: OptionalSchema<BooleanSchema<undefined>, undefined>;
     }, undefined>;
     dbName: OptionalSchema<StringSchema<undefined>, undefined>;
     default: OptionalSchema<VariantSchema<"kind", [ObjectSchema<{
        kind: LiteralSchema<..., ...>;
        value: GenericSchema<...>;
      }, undefined>, ObjectSchema<{
        args: OptionalSchema<..., ...>;
        expr: StringSchema<...>;
        kind: LiteralSchema<..., ...>;
     }, undefined>], undefined>, undefined>;
     doc: OptionalSchema<StringSchema<undefined>, undefined>;
     hidden: OptionalSchema<BooleanSchema<undefined>, undefined>;
     list: BooleanSchema<undefined>;
     name: StringSchema<undefined>;
     nullable: BooleanSchema<undefined>;
     optional: BooleanSchema<undefined>;
     type: GenericSchema<FieldType>;
  }, undefined>, undefined>;
  indexes: ArraySchema<VariantSchema<"kind", [ObjectSchema<{
     fields: ArraySchema<StringSchema<undefined>, undefined>;
     kind: LiteralSchema<"columns", undefined>;
     name: OptionalSchema<StringSchema<undefined>, undefined>;
     type: OptionalSchema<PicklistSchema<["btree", "hash", "gin", "gist", "brin", "spgist"], undefined>, undefined>;
   }, undefined>, ObjectSchema<{
     expression: StringSchema<undefined>;
     kind: LiteralSchema<"expression", undefined>;
     name: OptionalSchema<StringSchema<undefined>, undefined>;
     type: OptionalSchema<PicklistSchema<["btree", "hash", "gin", "gist", "brin", "spgist"], undefined>, undefined>;
  }, undefined>], undefined>, undefined>;
  name: StringSchema<undefined>;
  primaryKey: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, undefined>;
  relations: ArraySchema<ObjectSchema<{
     backRelation: OptionalSchema<StringSchema<undefined>, undefined>;
     cardinality: PicklistSchema<["one", "many"], undefined>;
     fkFields: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, undefined>;
     name: StringSchema<undefined>;
     onDelete: OptionalSchema<PicklistSchema<["cascade", "restrict", "setNull", "setDefault", "noAction"], undefined>, undefined>;
     onUpdate: OptionalSchema<PicklistSchema<["cascade", "restrict", "setNull", "setDefault", "noAction"], undefined>, undefined>;
     optional: BooleanSchema<undefined>;
     owning: BooleanSchema<undefined>;
     references: OptionalSchema<ArraySchema<StringSchema<undefined>, undefined>, undefined>;
     target: ObjectSchema<{
        entity: StringSchema<undefined>;
        namespace: StringSchema<undefined>;
     }, undefined>;
  }, undefined>, undefined>;
  uniques: ArraySchema<ObjectSchema<{
     fields: ArraySchema<StringSchema<undefined>, undefined>;
     name: OptionalSchema<StringSchema<undefined>, undefined>;
  }, undefined>, undefined>;
}, undefined>;

Defined in: packages/ir/src/schemas.ts:219