columns.enum()

When to use

• Your TypeScript code expects a string from a strictly defined set
• Your database column is an ENUM of defined values

How it works

This column type is generic and takes a union of string values for the permitted ENUM values. For example, if a column was defined with the possible enum values CHEESE, WINE and JELLY, the column could be defined as:

columns.enum<"CHEESE" | "WINE" | "JELLY">();

Nullability

If the column allows null values, use columns.enumNull().

Example

Given the following database table petExample:

id INT	pet ENUM(CAT,DOG,FISH)
1	CAT
2	FISH

And the following model:

const getExampleRow = db.getOne({
  name: "get-one-example-row",
  columns: {
    pet: columns.enum<"CAT" | "DOG" | "FISH">(),
  },
  query: ({ id }: { id: number }) =>
    SQL`SELECT pet FROM petExample WHERE id = ${id}`,
});

A query for row id 1 yields:

const result = await getExampleRow({ id: 1 });
if (result) {
  console.log(result.pet);
}

// -> 'CAT'