ilana-orm/orm/QueryBuilder.d.ts at main · raphyabak/ilana-orm · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

import Collection from './Collection';

import Model from './Model';

export interface PaginationResult<T> {

data: Collection<T>;

total: number;

perPage: number;

currentPage: number;

lastPage: number;

from: number | null;

to: number | null;

nextPage: number | null;

}

export interface SimplePaginationResult<T> {

data: Collection<T>;

hasMore: boolean;

}

export interface CursorPaginationResult<T> {

data: Collection<T>;

nextCursor?: string;

prevCursor?: string;

hasNextPage: boolean;

hasPrevPage: boolean;

path: string;

perPage: number;

}

export default class QueryBuilder {

protected query: any;

protected modelClass: typeof Model;

protected connectionName?: string;

protected eagerLoad: string[];

protected eagerLoadConstraints: { [key: string]: (query: QueryBuilder) => void };

protected _transaction?: any;

protected _includeTrashed?: boolean;

protected _onlyTrashed?: boolean;

protected _withoutTrashed?: boolean;

constructor(tableName: string, modelClass: typeof Model, connectionName?: string);

// Where clauses

where(column: string, value: any): this;

where(column: string, operator: string, value: any): this;

orWhere(column: string, value: any): this;

orWhere(column: string, operator: string, value: any): this;

whereIn(column: string, values: any[]): this;

whereNotIn(column: string, values: any[]): this;

whereNull(column: string): this;

whereNotNull(column: string): this;

whereBetween(column: string, range: [any, any]): this;

whereJsonContains(column: string, value: any): this;

whereJsonLength(column: string, operator: string, value: number): this;

whereDate(column: string, value: string): this;

whereDate(column: string, operator: string, value: string): this;

whereMonth(column: string, month: number): this;

whereYear(column: string, year: number): this;

whereNotBetween(column: string, range: [any, any]): this;

orWhereNull(column: string): this;

orWhereNotNull(column: string): this;

orWhereIn(column: string, values: any[]): this;

orWhereNotIn(column: string, values: any[]): this;

orWhereRaw(sql: string, bindings?: any[]): this;

whereDay(column: string, operatorOrValue: any, value?: any): this;

whereTime(column: string, operatorOrValue: any, value?: any): this;

when<T>(condition: T, callback: (query: this, condition: T) => void, otherwise?: (query: this) => void): this;

unless<T>(condition: T, callback: (query: this) => void, otherwise?: (query: this, condition: T) => void): this;

// Joins

join(table: string, first: string, operator: string, second: string): this;

leftJoin(table: string, first: string, operator: string, second: string): this;

rightJoin(table: string, first: string, operator: string, second: string): this;

innerJoin(table: string, first: string, operator: string, second: string): this;

crossJoin(table: string): this;

// Ordering and limits

orderBy(column: string, direction?: 'asc' | 'desc'): this;

orderByRaw(sql: string): this;

latest(column?: string): this;

oldest(column?: string): this;

inRandomOrder(): this;

limit(count: number): this;

offset(count: number): this;

take(count: number): this;

skip(count: number): this;

from(table: string): this;

forPage(page: number, perPage?: number): this;

// Grouping

groupBy(...columns: string[]): this;

having(column: string, operator: string, value: any): this;

having(rawSql: string): this;

havingRaw(sql: string, bindings?: any[]): this;

whereExists(callback: (query: QueryBuilder) => void): this;

whereNotExists(callback: (query: QueryBuilder) => void): this;

// Locking

lockForUpdate(): this;

sharedLock(): this;

skipLocked(): this;

noWait(): this;

// Selection

select(...columns: any[]): this;

addSelect(...columns: any[]): this;

addSelect(subqueries: { [alias: string]: (query: QueryBuilder) => void }): this;

distinct(): this;

// Raw queries

whereRaw(sql: string, bindings?: any[]): this;

selectRaw(sql: string, bindings?: any[]): this;

// Advanced subqueries

orderBySubquery(callback: (query: QueryBuilder) => void, direction?: 'asc' | 'desc'): this;

// Pending attributes (scope defaults)

withPendingAttributes(attributes: { [key: string]: any }): this;

new(attributes?: { [key: string]: any }): Promise<import('./Model').default>;

create(attributes?: { [key: string]: any }): Promise<import('./Model').default>;

// Aggregates

count(column?: string): Promise<number>;

sum(column: string): Promise<number>;

avg(column: string): Promise<number>;

min(column: string): Promise<any>;

max(column: string): Promise<any>;

// Eager loading

with(...relations: string[]): this;

withConstraints(relation: string, callback: (query: QueryBuilder) => void): this;

withConstraints(relations: { [key: string]: (query: QueryBuilder) => void }): this;

withCount(...relations: string[]): this;

whereHas(relation: string, callback?: (query: QueryBuilder) => void): this;

doesntHave(relation: string): this;

whereDoesntHave(relation: string, callback?: (query: QueryBuilder) => void): this;

has(relation: string, operator?: '=' | '!=' | '<' | '<=' | '>' | '>=', count?: number): this;

// Execution methods

get(): Promise<Collection<Model>>;

first(): Promise<Model | null>;

firstOrFail(): Promise<Model>;

find(id: any): Promise<Model | null>;

findOrFail(id: any): Promise<Model>;

pluck(column: string): Promise<any[]>;

exists(): Promise<boolean>;

doesntExist(): Promise<boolean>;

sole(): Promise<Model>;

tap(callback: (query: this) => void): this;

// Pagination

paginate(page?: number, perPage?: number): Promise<PaginationResult<Model>>;

simplePaginate(page?: number, perPage?: number): Promise<SimplePaginationResult<Model>>;

cursorPaginate(perPage?: number, cursor?: string, column?: string, direction?: 'asc' | 'desc'): Promise<CursorPaginationResult<Model>>;

// Chunking

chunk(size: number, callback: (models: Collection<Model>) => Promise<void>): Promise<void>;

cursor(chunkSize?: number): AsyncGenerator<Model, void, unknown>;

lazy(chunkSize?: number): AsyncGenerator<Model, void, unknown>;

// Insert/Update/Delete

insert(data: any | any[]): Promise<any>;

insertGetId(data: any): Promise<any>;

update(data: any): Promise<number>;

increment(column: string, amount?: number): Promise<number>;

decrement(column: string, amount?: number): Promise<number>;

delete(): Promise<number>;

upsert(data: any[], uniqueBy: string[], update?: string[]): Promise<any>;

// Connection switching

connection(name: string): QueryBuilder;

on(connectionOrTrx: string | any): QueryBuilder;

// Clone query

clone(): QueryBuilder;

// Get underlying Knex query

toKnex(): any;

// Soft delete methods

withTrashed(): this;

onlyTrashed(): this;

withoutTrashed(): this;

restore(): Promise<number>;

// Plain object result (no model hydration)

values(): Promise<any[]>;

// Debug

toSql(): string;

// Protected methods

protected loadRelations(models: Model[]): Promise<void>;

protected loadRelation(models: Model[], relationName: string): Promise<void>;

}

ilana-orm/orm/QueryBuilder.d.ts at main · raphyabak/ilana-orm · GitHub

Repository navigation

Expand file tree

Breadcrumbs

QueryBuilder.d.ts

Latest commit

History

Breadcrumbs

QueryBuilder.d.ts

File metadata and controls