Class Model<T>

Type Parameters

T extends Record<string, ModelColumn>

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;
    autoIncrement?: Extract<keyof T, string>;
    primaryKeys: Extract<keyof T, string> | Extract<keyof T, string>[];
    tableName: string;
    uniqueKeys?: Extract<keyof T, string>[][];
    withRowId?: boolean;
}, columns: T): Model<T>
Type Parameters
- T extends Record<string, ModelColumn>
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;
  }
  
  The options for the model. All parameters except autoIncrement, withRowId, and uniqueKeys are required.
  - Optional D1Orm?: D1Orm
    
    The D1Orm instance to use - optional. If not set initially, you must use SetOrm() to set before querying.
  - Optional autoIncrement?: Extract<keyof T, string>
    
    The column to use for auto incrementing. If specified, only one primary key is allowed, and must be of type INTEGER.
  - primaryKeys: Extract<keyof T, string> | Extract<keyof T, string>[]
    
    The primary key or keys of the table.
  - tableName: string
    
    The name of the table to use.
  - Optional uniqueKeys?: Extract<keyof T, string>[][]
    
    The unique keys of the table. For example [ ['id'], ['username', 'discriminator'] ] would cause ID to be unique, as well as the combination of username and discriminator.
  - Optional withRowId?: boolean
    
    Whether or not D1 should generate a rowid column automatically. Defaults to false.
- columns: T
  
  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:19

Properties

`Readonly` columns

columns: T

`Readonly` primaryKeys

primaryKeys: Extract<keyof T, string>[]

`Readonly` tableName

tableName: string

`Readonly` uniqueKeys

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

Accessors

D1Orm

get D1Orm(): D1Orm
Returns
The ORM instance that this model is using.

Returns D1Orm
- Defined in model.ts:115

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:136

Methods

All

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

CreateTable

CreateTable(options?: {
strategy: "default" | "force";
}): 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";
  } = ...
  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
  - strategy: "default" | "force"
Returns Promise<D1Result<unknown>>
- Defined in model.ts:176

Delete

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

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:196

First

First(options: Pick<GenerateQueryOptions<InferFromColumns<T>>, "where">): Promise<null | InferFromColumns<T>>
Returns
Returns the first row that matches the where clause, or null if no rows match.
Parameters
- options: Pick<GenerateQueryOptions<InferFromColumns<T>>, "where">
  
  The options for the query, see GenerateQueryOptions
Returns Promise<null | InferFromColumns<T>>
- Defined in model.ts:239

InsertMany

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

InsertOne

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

SetOrm

SetOrm(orm: D1Orm): Model<T>
Parameters
- orm: D1Orm
  
  The ORM instance to associate this model with.
Returns Model<T>
- Defined in model.ts:125

Update

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

Upsert

Upsert(options: Pick<GenerateQueryOptions<InferFromColumns<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<InferFromColumns<T>>, "data" | "where" | "upsertOnlyUpdateData">
  
  The options for the query, see GenerateQueryOptions
Returns Promise<D1Result<unknown>>
- Defined in model.ts:305

Class Model<T>

Type Parameters

T extends Record<string, ModelColumn>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Record<string, ModelColumn>

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; }

Optional D1Orm?: D1Orm

Optional autoIncrement?: Extract<keyof T, string>

primaryKeys: Extract<keyof T, string> | Extract<keyof T, string>[]

tableName: string

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

Optional withRowId?: boolean

columns: T

Returns Model<T>

Properties

Readonly columns

Readonly primaryKeys

Readonly tableName

Readonly uniqueKeys

Accessors

D1Orm

Returns

Returns D1Orm

createTableDefinition

Returns

Returns string

Methods

All

Returns

Parameters

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

Returns Promise<D1Result<InferFromColumns<T>>>

CreateTable

Throws

Parameters

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

strategy: "default" | "force"

Returns Promise<D1Result<unknown>>

Delete

Parameters

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

Returns Promise<D1Result<unknown>>

DropTable

Parameters

Optional silent: boolean

Returns Promise<D1Result<unknown>>

First

Returns

Parameters

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

Returns Promise<null | InferFromColumns<T>>

InsertMany

Parameters

data: Partial<InferFromColumns<T>>[]

orReplace: boolean = false

Returns Promise<D1Result<InferFromColumns<T>>[]>

InsertOne

Parameters

data: Partial<InferFromColumns<T>>

orReplace: boolean = false

Returns Promise<D1Result<InferFromColumns<T>>>

SetOrm

Parameters

orm: D1Orm

Returns Model<T>

Update

Throws

Parameters

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

Returns Promise<D1Result<unknown>>

Upsert

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;
}

`Optional` D1Orm?: D1Orm

`Optional` autoIncrement?: Extract<keyof T, string>

`Optional` uniqueKeys?: Extract<keyof T, string>[][]

`Optional` withRowId?: boolean

`Readonly` columns

`Readonly` primaryKeys

`Readonly` tableName

`Readonly` uniqueKeys

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

`Optional` silent: boolean