Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tygress.io/llms.txt

Use this file to discover all available pages before exploring further.

To model a Postgres table in Tygress you need to create a class and decorate it with the @Table decorator. Once you do this we call the class an . To define columns you need to create fields in the class and decorate them with the @Column decorator. Every needs to have a . Example: 
@Table("users")
export class Users {
  @PrimaryKey({ name: "id", type: "UUID" })
  id: string;

  @Column({ name: "username", type: "TEXT" })
  username: string;
}

​
Columns

The @Column allows you to specify column attributes such as nullability, precision or max length. 
@Column({ name: 'post_code', type: 'VARCHAR', maxLength: 8 })
postCode: string;

@Column({
  name: "average_temperature",
  type: "DECIMAL",
  precision: 12,
  scale: 8,
})
averageTemperature: number;

​
Indexes

To define an index on a table use the @Index class decorator: 
@Index("users_username_idx", { columns: ["username"] })
@Table("users")
class Users {
This decorator also allows you to make the index unique and specify include columns, where conditions or a different index method: 
@Index("users_average_temperature_brin", {
  columns: ["averageTemperature"],
  method: "brin",
  where: { averageTemperature: Gte(12.5), username: NotEq("admin") },
})