JSON types

Postgres supports two types of JSON: json is for storing JSON strings as they were saved, and jsonb is stored in binary format and allows additional methods.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    json: t.jsonText(), // -> JSON string
    jsonB: t.json(), // -> JSON binary
  }));
}

json type accepts a callback which defines a schema for validation. When the schema is not provided, it is of type unknown by default.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        age: t.number(),
        name: t.string(),
        description: t.string().optional(),
        tags: t.string().array(),
      }),
    ),
  }));
}

Error messages described in validation docs are working in the same way for nested JSON schemas.

json columns support the following where operators:

db.someTable.where({
  jsonColumn: {
    // first element is JSON path,
    // second is a compare operator,
    // third value can be of any type, or a subquery, or a raw SQL query
    jsonPath: ['$.name', '=', value],

    // check if the JSON value in the column is a superset of the provided value
    jsonSupersetOf: { key: 'value' },

    // check if the JSON value in the column is a subset of the provided value
    jsonSubsetOf: { key: 'value' },
  },
});

basic JSON types

The basic types are:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        number: t.number(),
        string: t.string(),
        literal: t.literal('value'),
        boolean: t.boolean(),
        null: t.null(),
        unknown: t.unknown(),
      }),
    ),
  }));
}

number type can be chained with the same methods as numeric columns:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        number: t
          .number()
          .lt(number) // must be lower than number
          .lte(number) // must be lower than or equal to the number
          .max(number) // alias for .lte
          .gt(number) // must be greater than number
          .gte(number) // must be greater than or equal to the number
          .min(number) // alias for .gte
          .positive() // must be greater than 0
          .nonNegative() // must be greater than or equal to 0
          .negative() // must be lower than 0
          .nonPositive() // must be lower than or equal to 0
          .multipleOf(number) // must be a multiple of the number
          .step(number) // alias for .multipleOf
          .finite() // not Infinity
          .safe(), // equivalient to .lte(Number.MAX_SAFE_INTEGER)
      }),
    ),
  }));
}

string type can be chained with the methods as text columns:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        string: t
          .string()
          .nonEmpty() // equivalent for .min(1)
          .min(1)
          .max(10)
          .length(5)
          .email()
          .url()
          .emoji()
          .uuid()
          .cuid()
          .cuid2()
          .ulid()
          .datetime({ offset: true, precision: 5 }) // see Zod docs for details
          .ip({ version: 'v4' }) // v4, v6 or don't pass the parameter for both
          .regex(/regex/)
          .includes('str')
          .startsWith('str')
          .endsWith('str')
          .trim()
          .toLowerCase()
          .toUpperCase(),
      }),
    ),
  }));
}

optional, nullable and nullish

By default, all types are required. Append .optional() so the value may be omitted from the object:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        optionalNumber: t.number().optional(),
      }),
    ),
  }));
}

It's possible to undo the optional with required:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        requiredNumber: t.number().optional().required(),
      }),
    ),
  }));
}

To allow a null value use the nullable:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        nullableNumber: t.number().nullable(),
      }),
    ),
  }));
}

Undo the nullable with notNullable:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        nonNullableNumber: t.number().nullable().nonNullable(),
      }),
    ),
  }));
}

nullish is a combination of optional and nullable:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        nullishNumber: t.number().nullish(),
      }),
    ),
  }));
}

Disallow null and undefined values with notNullish:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        nonNullishNumber: t.number().nullish().notNullish(),
      }),
    ),
  }));
}

default

Set a default value to be used during the validation if the input is null or undefined. If the function is provided, it will be called on each validation to use the returned value.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        defautedNumber: t.number().default(123),
        defautedRandom: t.number().default(() => Math.random()),
      }),
    ),
  }));
}

narrow type

Narrow string or number type to a literal union:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        size: t.string<'small' | 'medium' | 'large'>(),
        keyLength: t.number<1024 | 2048>(),
      }),
    ),
  }));
}

or and union

Make a union (oneType | otherType) of several types by using or or union:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // string | number
        stringOrNumber: t.string().or(t.number()),

        // equivalent to
        stringOrNumber2: t.union([t.string(), t.number()]),
      }),
    ),
  }));
}

and, intersection

Make an intersection (oneType & otherType) of several types by using and or intersection:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // { name: string } & { age: number }
        obj: t.object({ name: t.string() }).and(t.object({ age: t.number() })),

        // equivalent to
        obj2: t.intersection(
          t.object({ name: t.string() }),
          t.object({ age: t.number() }),
        ),
      }),
    ),
  }));
}

deepPartial

For a composite type such as array, object, record, map, set, and some others, call deepPartial() to mark all inner object keys as optional:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // object with optional `name`:
        deepPartialObject: t.object({ name: t.string() }).deepPartial(),

        // array of objects with optional `name`:
        deepPartialArray: t.object({ name: t.string() }).array().deepPartial(),
      }),
    ),
  }));
}

transform

Specify a function to transform values during the validation. For example, reverse a string:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        reverseString: t
          .string()
          .transform((input) => input.split('').reverse().join('')),
      }),
    ),
  }));
}

To transform value from one type to another, use .to.

In the following example, the string will be transformed into a number, and the number method lte will become available:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        stringToNumber: t
          .string()
          .to((input) => parseInt(input), t.number())
          .lte(10),
      }),
    ),
  }));
}

refine

Add a custom check for the value, validation will fail when a falsy value is returned:

Optionally takes error message.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        refinedString: t
          .string()
          .refine((val) => val.length <= 255, 'error message'),
      }),
    ),
  }));
}

Refinements can also be async.

superRefine

superRefine allows one to check a value and handle different cases using the ctx context of the validation.

Refer to Zod document for it.

This library is designed to support Zod and later other validation libraries, so the ctx has type any and needs to be explicitly typed with the correct type of chosen lib:

import { z, RefinementCtx } from 'zod';

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        superRefinedString: t
          .string()
          .superRefine((val, ctx: RefinementCtx) => {
            if (val.length > 3) {
              ctx.addIssue({
                code: t.ZodIssueCode.too_big,
                maximum: 3,
                type: 'array',
                inclusive: true,
                message: 'Too many items 😡',
              });
            }
          }),
      }),
    ),
  }));
}

array

Every type has the.array() method to wrap it into the array:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // array of numbers
        arrayOfNumbers: t.number().array(),

        // is equivalent to:
        arrayOfNumbers2: t.array(t.number()),
      }),
    ),
  }));
}

The array type can be chained with the following validation methods:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        arrayOfNumbers: t
          .number()
          .array()
          .nonEmpty() // require at least one element
          .min(number) // set minimum array length
          .max(number) // set maximum array length
          .length(number), // set exact array length
      }),
    ),
  }));
}

object

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // all properties are required by default
        // type will be { name: string, age: number }
        name: t.string(),
        age: t.number(),
      }),
    ),
  }));
}

extend

You can add additional fields to an object schema with the .extend method.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be { one: number, two: string }
        extendObject: t.object({ one: t.number() }).extend({ two: t.string() }),
      }),
    ),
  }));
}

merge

Merge two object types into one:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be { one: number, two: string }
        mergeObject: t
          .object({ one: t.number() })
          .merge(t.object({ two: t.string() })),
      }),
    ),
  }));
}

pick

To only keep certain keys, use .pick:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be { one: number, two: number }
        pickObject: t
          .object({ one: t.number(), two: t.number(), three: t.number() })
          .pick('one', 'two'),
      }),
    ),
  }));
}

omit

To remove certain keys, use .omit:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be { three: number }
        omitObject: t
          .object({ one: t.number(), two: t.number(), three: t.number() })
          .omit('one', 'two'),
      }),
    ),
  }));
}

partial

The .partial method makes all properties optional:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be { one?: number, two?: number }
        partialObject: t.object({ one: t.number(), two: t.number() }).partial(),
      }),
    ),
  }));
}

You can also specify which properties to make optional:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be { one?: number, two: number }
        partialOne: t
          .object({ one: t.number(), two: t.number() })
          .partial('one'),
      }),
    ),
  }));
}

passthrough

By default, object schemas strip out unrecognized keys during parsing.

Instead, if you want to pass through unknown keys, use .passthrough().

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // will validate only `one` key and preserve all other keys when parsing
        object: t.object({ one: t.number() }).passthrough(),
      }),
    ),
  }));
}

strict

By default, object schemas strip out unrecognized keys during parsing.

You can disallow unknown keys with .strict(). If there are any unknown keys in the input, it will throw an error.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // will throw if unknown keys will be found during parsing
        object: t.object({ one: t.number() }).strict(),
      }),
    ),
  }));
}

strip

You can use the .strip method to reset an object schema to the default behavior (stripping unrecognized keys).

catchall

You can pass a "catchall" schema into an object schema. All unknown keys will be validated against it.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // check `name` to be a string and all other keys to have numbers
        object: t.object({ name: t.string() }).catchall(t.number()),
      }),
    ),
  }));
}

record

Record schemas are used to validate types such as { [k: string]: number }.

If you want to validate the values of an object against some schema but don't care about the keys, use t.record(valueType):

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be { [k: string]: number }
        record: t.record(t.number()),
      }),
    ),
  }));
}

If you want to validate both the keys and the values, use t.record(keyType, valueType):

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        record: t.record(t.string().min(1), t.number()),
      }),
    ),
  }));
}

tuple

Tuples have a fixed number of elements and each element can have a different type.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be [string, number, { pointsScored: number }]
        tuple: t.tuple([
          t.string(),
          t.number(),
          t.object({
            pointsScored: t.number(),
          }),
        ]),
      }),
    ),
  }));
}

A variadic ("rest") argument can be added with the .rest method.

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        // type will be [string, ...number]
        tupleWithRest: t.tuple([t.string()]).rest(t.number()),
      }),
    ),
  }));
}

enum

t.enum is a way to declare a schema with a fixed set of allowable string values:

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        enum: t.enum(['Salmon', 'Tuna', 'Trout']),
      }),
    ),
  }));
}

Alternatively, use as const to define your enum values as a tuple of strings:

const VALUES = ['Salmon', 'Tuna', 'Trout'] as const;

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        enum: t.enum(VALUES),
      }),
    ),
  }));
}

native enums

t.enum is the recommended approach to defining and validating enums. But if you need to validate against an enum from a third-party library (or you don't want to rewrite your existing enums) you can use t.nativeEnum().

enum Fruits {
  Apple,
  Banana,
}

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        enum: t.nativeEnum(Fruits),
      }),
    ),
  }));
}

discriminated union

If the union consists of object schemas all identifiable by a common property, it is possible to use the t.discriminatedUnion method.

The advantage is in the more efficient evaluation and more human-friendly errors. With the basic union method the input is tested against each of the provided "options", and in the case of invalidity, issues for all the "options" are shown in the zod error. On the other hand, the discriminated union allows for selecting just one of the "options", testing against it, and showing only the issues related to this "option".

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        object: t
          .discriminatedUnion('type', [
            t.object({ type: t.literal('a'), a: t.string() }),
            t.object({ type: t.literal('b'), b: t.string() }),
          ])
          .parse({ type: 'a', a: 'abc' }),
      }),
    ),
  }));
}

recursive JSON types

You can define a recursive schema, but because of a limitation of TypeScript, their type can't be statically inferred. Instead, you'll need to define the type definition manually, and provide it as a "type hint".

import { JSONType, jsonTypes as t } from 'orchid-orm';

interface Category {
  name: string;
  subCategories: Category[];
}

const Category: JSONType<Category> = t.lazy(() =>
  t.object({
    name: t.string(),
    subCategories: t.array(Category),
  }),
);

export class Table extends BaseTable {
  readonly table = 'table';
  columns = this.setColumns((t) => ({
    data: t.json((t) =>
      t.object({
        name: t.string(),
        category: Category,
      }),
    ),
  }));
}

JSON types #

basic JSON types #

optional, nullable and nullish #

default #

narrow type #

or and union #

and, intersection #

deepPartial #

transform #

refine #

superRefine #

array #

object #

extend #

merge #

pick #

omit #

partial #

passthrough #

strict #

strip #

catchall #

record #

tuple #

enum #

native enums #

discriminated union #

recursive JSON types #