Class Model<T>

Type Parameters

T extends object

The type of the model, which will be returned when using methods such as First() or All()

Hierarchy

Model

Index

Constructors

constructor

new Model<T>(options: { D1Orm: D1Orm; tableName: string }, columns: Record<Extract<keyof T, string>, ModelColumn>): Model<T>
Type Parameters
Type Parameters
- T extends object
  
  The type of the model, which will be returned when using methods such as First() or All()
Parameters
- options: { D1Orm: D1Orm; tableName: string }
  
  The options for the model. The table name & D1Orm instance are required.
  - D1Orm: D1Orm
    
    The D1Orm instance to use.
  - tableName: string
    
    The name of the table to use.
- columns: Record<Extract<keyof T, string>, ModelColumn>
  
  The columns for the model. The keys are the column names, and the values are the column options. See ModelColumn
Returns Model<T>
- Defined in model.ts:17

Properties

`Readonly` columns

columns: Record<string, ModelColumn>

tableName

tableName: string

Accessors

createTableDefinition

get createTableDefinition(): string
Returns
A CreateTable definition for the model, which can be used in a CREATE TABLE statement.

Returns string
- Defined in model.ts:73

Methods

All

All(options: Omit<GenerateQueryOptions<T>, "data" | "upsertOnlyUpdateData">): Promise<D1Result<T[]>>
Returns
Returns all rows that match the where clause.
Parameters
- options: Omit<GenerateQueryOptions<T>, "data" | "upsertOnlyUpdateData">
  
  The options for the query, see GenerateQueryOptions
Returns Promise<D1Result<T[]>>
- Defined in model.ts:179

CreateTable

CreateTable(options?: { strategy: "default" | "force" | "alter" }): Promise<D1Result<unknown>>
Throws
- Throws an error if the table already exists and the strategy is not "force".
- Throws an error if the strategy is "alter", as this is not yet implemented
Parameters
- options: { strategy: "default" | "force" | "alter" } = ...
  The options for creating the table. Currently only contains strategy, which is the strategy to use when creating the table.
  - "default" - The default strategy, which will attempt create the table.
  - "force" - Drops the table if it exists, then creates it
  - "alter" - [NOT YET IMPLEMENTED] Attempts to alter the table to match the model
  - strategy: "default" | "force" | "alter"
Returns Promise<D1Result<unknown>>
- Defined in model.ts:106

Delete

Delete(options: Pick<GenerateQueryOptions<T>, "where">): Promise<D1Result<unknown>>
Parameters
- options: Pick<GenerateQueryOptions<T>, "where">
  
  The options for the query, see GenerateQueryOptions
Returns Promise<D1Result<unknown>>
- Defined in model.ts:192

DropTable

DropTable(silent?: boolean): Promise<D1Result<unknown>>
Parameters
- Optional silent: boolean
  
  If true, will ignore the table not existing. If false, will throw an error if the table does not exist.
Returns Promise<D1Result<unknown>>
- Defined in model.ts:125

First

First(options: Pick<GenerateQueryOptions<T>, "where">): Promise<T>
Returns
Returns the first row that matches the where clause.
Parameters
- options: Pick<GenerateQueryOptions<T>, "where">
  
  The options for the query, see GenerateQueryOptions
Returns Promise<T>
- Defined in model.ts:161

InsertMany

InsertMany(data: Partial<T>[]): Promise<D1Result<T>[]>
Parameters
- data: Partial<T>[]
  
  The data to insert into the table, as an array of objects with the column names as keys and the values as values.
Returns Promise<D1Result<T>[]>
- Defined in model.ts:146

InsertOne

InsertOne(data: Partial<T>): Promise<D1Result<T>>
Parameters
- data: Partial<T>
  
  The data to insert into the table, as an object with the column names as keys and the values as values.
Returns Promise<D1Result<T>>
- Defined in model.ts:135

Update

Update(options: Pick<GenerateQueryOptions<T>, "data" | "where">): Promise<D1Result<unknown>>
Throws
Throws an error if the data clause is empty.
Parameters
- options: Pick<GenerateQueryOptions<T>, "data" | "where">
  
  The options for the query, see GenerateQueryOptions
Returns Promise<D1Result<unknown>>
- Defined in model.ts:206

Upsert

Upsert(options: Pick<GenerateQueryOptions<T>, "data" | "where" | "upsertOnlyUpdateData">): Promise<D1Result<unknown>>
Upserting is a way to insert a row into the table, or update it if it already exists. This is done by using SQLITE's ON CONFLICT clause. As a result, this method should control the primary key for the insert & where clauses, and should not be used with auto incrementing keys.
Parameters
- options: Pick<GenerateQueryOptions<T>, "data" | "where" | "upsertOnlyUpdateData">
  
  The options for the query, see GenerateQueryOptions
Returns Promise<D1Result<unknown>>
- Defined in model.ts:221

Class Model<T>

Type Parameters

T extends object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Type Parameters

T extends object

Parameters

options: { D1Orm: D1Orm; tableName: string }

D1Orm: D1Orm

tableName: string

columns: Record<Extract<keyof T, string>, ModelColumn>

Returns Model<T>

Properties

Readonly columns

tableName

Accessors

createTableDefinition

Returns

Returns string

Methods

All

Returns

Parameters

options: Omit<GenerateQueryOptions<T>, "data" | "upsertOnlyUpdateData">

Returns Promise<D1Result<T[]>>

CreateTable

Throws

Parameters

options: { strategy: "default" | "force" | "alter" } = ...

strategy: "default" | "force" | "alter"

Returns Promise<D1Result<unknown>>

Delete

Parameters

options: Pick<GenerateQueryOptions<T>, "where">

Returns Promise<D1Result<unknown>>

DropTable

Parameters

Optional silent: boolean

Returns Promise<D1Result<unknown>>

First

Returns

Parameters

options: Pick<GenerateQueryOptions<T>, "where">

Returns Promise<T>

InsertMany

Parameters

data: Partial<T>[]

Returns Promise<D1Result<T>[]>

InsertOne

Parameters

data: Partial<T>

Returns Promise<D1Result<T>>

Update

Throws

Parameters

options: Pick<GenerateQueryOptions<T>, "data" | "where">

Returns Promise<D1Result<unknown>>

Upsert

Parameters

options: Pick<GenerateQueryOptions<T>, "data" | "where" | "upsertOnlyUpdateData">

Returns Promise<D1Result<unknown>>

Settings

Member Visibility

Theme

`Readonly` columns

`Optional` silent: boolean