monolayer-pg / schema / char

Function: char()

char(maximumLength): PgCharacter

Column that stores a fixed-length, blank-padded string of up to maximumLength characters.

Parameters

Parameter	Type	Default value	Description
maximumLength	number	1	Maximum character length of strings in the column. Must be greater than zero and cannot exceed 10,485,760. Default: 1.

Returns

PgCharacter

Remarks

Kysely database schema type definition

{
  readonly __select__: string | null;
  readonly __insert__: string | null | undefined;
  readonly __update__: string | null;
};

Nullability and optionality will change according to the column's constraints, generated values, and default data values.

Example

import { char, schema, table } from "@monolayer/pg/schema";

const dbSchema = schema({
  tables: {
    example: table({
      columns: {
        description: char(30),
      },
    }),
  },
});

// Kysely database schema type
type DB = typeof dbSchema.infer;

See

PostgreSQL Docs: character