Class SQLiteNumericBuilder<T>

_

$default

$onUpdate

$defaultFn

• $defaultFn(
      fn: () => SQL<unknown> | T["data"],
  ): HasRuntimeDefault<HasDefault<SQLiteNumericBuilder<T>>>

  Adds a dynamic default value to the column. The function will be called when the row is inserted, and the returned value will be used as the column value.

  Note: This value does not affect the drizzle-kit behavior, it is only used at runtime in drizzle-orm.

  Parameters

  • fn: () => SQL<unknown> | T["data"]

  Returns HasRuntimeDefault<HasDefault<SQLiteNumericBuilder<T>>>

$onUpdateFn

• $onUpdateFn(
      fn: () => SQL<unknown> | T["data"],
  ): HasDefault<SQLiteNumericBuilder<T>>

  Adds a dynamic update value to the column. The function will be called when the row is updated, and the returned value will be used as the column value if none is provided. If no default (or $defaultFn) value is provided, the function will be called when the row is inserted as well, and the returned value will be used as the column value.

  Note: This value does not affect the drizzle-kit behavior, it is only used at runtime in drizzle-orm.

  Parameters

  • fn: () => SQL<unknown> | T["data"]

  Returns HasDefault<SQLiteNumericBuilder<T>>

$type

• $type<TType>(): $Type<SQLiteNumericBuilder<T>, TType>

  Changes the data type of the column. Commonly used with json columns. Also, useful for branded types.

  Type Parameters

  • TType

  Returns $Type<SQLiteNumericBuilder<T>, TType>

  Example

  const users = pgTable('users', {
  	id: integer('id').$type<UserId>().primaryKey(),
  	details: json('details').$type<UserDetails>().notNull(),
  });
  Copy

default

• default(value: SQL<unknown> | T["data"]): HasDefault<SQLiteNumericBuilder<T>>

  Adds a default <value> clause to the column definition.

  Affects the insert model of the table - columns with default are optional on insert.

  If you need to set a dynamic default value, use $defaultFn instead.

  Parameters

  • value: SQL<unknown> | T["data"]

  Returns HasDefault<SQLiteNumericBuilder<T>>

generatedAlwaysAs

• generatedAlwaysAs(
      as: SQL<unknown> | (() => SQL) | T["data"],
      config?: SQLiteGeneratedColumnConfig,
  ): HasGenerated<SQLiteNumericBuilder<T>, { type: "always" }>

  Parameters

  • as: SQL<unknown> | (() => SQL) | T["data"]
  • Optionalconfig: SQLiteGeneratedColumnConfig

  Returns HasGenerated<SQLiteNumericBuilder<T>, { type: "always" }>

notNull

• notNull(): NotNull<SQLiteNumericBuilder<T>>

  Adds a not null clause to the column definition.

  Affects the select model of the table - columns without not null will be nullable on select.

  Returns NotNull<SQLiteNumericBuilder<T>>

primaryKey

• primaryKey(): IsPrimaryKey<NotNull<SQLiteNumericBuilder<T>>>

  Adds a primary key clause to the column definition. This implicitly makes the column not null.

  In SQLite, integer primary key implicitly makes the column auto-incrementing.

  Returns IsPrimaryKey<NotNull<SQLiteNumericBuilder<T>>>

references

• references(
      ref: () => SQLiteColumn,
      actions?: { onDelete?: UpdateDeleteAction; onUpdate?: UpdateDeleteAction },
  ): this

  Parameters

  • ref: () => SQLiteColumn
  • Optionalactions: { onDelete?: UpdateDeleteAction; onUpdate?: UpdateDeleteAction }

  Returns this

unique

• unique(name?: string): this

  Parameters

  • Optionalname: string

  Returns this