Model | D1 Orm - v0.9.2

Class Model<T>

Type Parameters

Constructors

constructor

  • new Model<T>(options, columns): Model<T>
  • Type Parameters

    Parameters

    • options: {
          D1Orm?: D1Orm;
          autoIncrement?: Extract<keyof T, string>;
          primaryKeys: Extract<keyof T, string> | Extract<keyof T, string>[];
          tableName: string;
          uniqueKeys?: Extract<keyof T, string>[][];
          withRowId?: boolean;
      }
      • OptionalD1Orm?: D1Orm
      • OptionalautoIncrement?: Extract<keyof T, string>
      • primaryKeys: Extract<keyof T, string> | Extract<keyof T, string>[]
      • tableName: string
      • OptionaluniqueKeys?: Extract<keyof T, string>[][]
      • OptionalwithRowId?: boolean
    • columns: T

    Returns Model<T>

Properties

Readonlycolumns

columns: T

ReadonlyprimaryKeys

primaryKeys: Extract<keyof T, string>[]

ReadonlytableName

tableName: string

ReadonlyuniqueKeys

uniqueKeys: Extract<keyof T, string>[][]

Accessors

D1Orm

  • get D1Orm(): D1Orm
  • Returns D1Orm

    The ORM instance that this model is using.

createTableDefinition

  • get createTableDefinition(): string
  • Returns string

    A CreateTable definition for the model, which can be used in a CREATE TABLE statement.

Methods

All

CreateTable

  • CreateTable(options?): Promise<D1ExecResult>
  • Parameters

    • options: {
          strategy: "default" | "force";
      } = ...
      • strategy: "default" | "force"

    Returns Promise<D1ExecResult>

Delete

DropTable

  • DropTable(silent?): Promise<D1ExecResult>
  • Parameters

    • Optionalsilent: boolean

    Returns Promise<D1ExecResult>

First

  • First(options): Promise<null | InferFromColumns<T>>
  • Returns Promise<null | InferFromColumns<T>>

    Returns the first row that matches the where clause, or null if no rows match.

InsertMany

InsertOne

SetOrm

  • SetOrm(orm): this
  • Returns this

Update

Upsert