sqlkit/docs/index.html at main · sqlkit-dev/sqlkit

History

417 lines (412 loc) · 30.5 KB

Raw

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

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

<!doctype html>

<head>

<title>sqlkit</title>

</head>

<body>

document.documentElement.dataset.theme =

localStorage.getItem("tsd-theme") || "os";

document.body.style.display = "none";

setTimeout(

() =>

window.app

? app.showPage()

: document.body.style.removeProperty("display"),

500,

);

</script>

<a href="index.html" class="title">sqlkit</a>

<svg

width="16"

height="16"

viewBox="0 0 16 16"

fill="none"

aria-hidden="true"

</svg>

</button>

<input

role="combobox"

id="tsd-search-input"

aria-controls="tsd-search-results"

aria-autocomplete="list"

aria-expanded="true"

autocapitalize="off"

autocomplete="off"

placeholder="Search the docs"

maxlength="100"

<div>Preparing search index...</div>

</div>

</dialog>

href="#"

class="tsd-widget menu"

id="tsd-toolbar-menu-trigger"

data-toggle="menu"

aria-label="Menu"

><svg

width="16"

height="16"

viewBox="0 0 16 16"

fill="none"

aria-hidden="true"

<use href="assets/icons.svg#icon-menu"></use></svg

></a>

</div>

</header>

<div class="tsd-page-title"><h1>sqlkit</h1></div>

sqlkit<a

href="#sqlkit"

aria-label="Permalink"

class="tsd-anchor-icon"

><svg viewBox="0 0 24 24" aria-hidden="true">

<use href="assets/icons.svg#icon-anchor"></use></svg

></a>

</h1>

sqlkit is a zero-dependency lightweight and

expressive SQL query builder and repository layer for TypeScript

with PostgreSQL support.

<hr />

🔧 Installation<a

href="#🔧-installation"

aria-label="Permalink"

class="tsd-anchor-icon"

><svg viewBox="0 0 24 24" aria-hidden="true">

<use href="assets/icons.svg#icon-anchor"></use></svg

></a>

</h2>

<pre><code class="bash">npm install sqlkit

</code><button type="button">Copy</button></pre>

🚀 Usage Examples<a

href="#🚀-usage-examples"

aria-label="Permalink"

class="tsd-anchor-icon"

><svg viewBox="0 0 24 24" aria-hidden="true">

<use href="assets/icons.svg#icon-anchor"></use></svg

></a>

</h2>

Define Your Domain Model

<pre><code class="ts">interface User { id: string; name: string; email: string; age?: number; }

</code><button type="button">Copy</button></pre>

1. Query Builder (Build Mode)<a

href="#1-query-builder-build-mode"

aria-label="Permalink"

class="tsd-anchor-icon"

><svg viewBox="0 0 24 24" aria-hidden="true">

<use href="assets/icons.svg#icon-anchor"></use></svg

></a>

</h3>

<pre><code class="ts">import { SelectQueryBuilder } from "sqlkit"; const builder = new SelectQueryBuilder<User>("users"); const { sql, values } = builder .select(["id", "name"]) .where({ key: "age", operator: ">", value: 18 }) // OR .where(eq("age", 18)) .build(); console.log(sql); // SELECT "users"."id","users"."name" FROM "users" WHERE "users"."age" > $1 console.log(values); // [18]

</code><button type="button">Copy</button></pre>

2. Query Execution (Commit Mode)<a

href="#2-query-execution-commit-mode"

aria-label="Permalink"

class="tsd-anchor-icon"

><svg viewBox="0 0 24 24" aria-hidden="true">

<use href="assets/icons.svg#icon-anchor"></use></svg

></a>

</h3>

<pre><code class="ts">import { PostgresAdapter, SelectQueryBuilder } from "sqlkit"; import { Pool } from "pg"; const pool = new Pool({ /* your config */ }); const executor = new PostgresAdapter(pool); const builder = new SelectQueryBuilder<User>("users", executor); const users = await builder .select(["id", "name"]) .where({ key: "age", operator: ">", value: 18 }) // OR .where(eq("age", 18)) .commit(); console.log(users); // => [{ id: "1", name: "John Doe" }, ...]

</code><button type="button">Copy</button></pre>

3. Repository API 🔥<a

href="#3-repository-api-🔥"

aria-label="Permalink"

class="tsd-anchor-icon"

><svg viewBox="0 0 24 24" aria-hidden="true">

<use href="assets/icons.svg#icon-anchor"></use></svg

></a>

</h3>

<pre><code class="ts">import { Repository, gt, like, and } from "sqlkit"; import { PostgresAdapter } from "sqlkit"; import { Pool } from "pg"; const pool = new Pool({ /* your config */ }); const executor = new PostgresAdapter(pool); const userRepo = new Repository<User>("users", executor); // Find many const users = await userRepo.findRows<User>({ where: and(gt("age", 25), like("name", "%Doe%")), }); // Paginate const result = await userRepo.paginate({ page: 1, limit: 10, offset: 2, where: gt("age", 18), columns: ["age", "email"], orderBy: [asc("age")], }); console.log(result.nodes); // array of users console.log(result.meta); /* { totalCount: 100, currentPage: 2, totalPages: 10, hasNextPage: true } */ // Find one const user = await userRepo.findRow<User>(like("email", "%@example.com")); // Count const count = await userRepo.count<User>(gt("age", 30)); // Insert const newUser = await userRepo.insertOne<User>({ name: "Rayhan", email: "ray@example.com", }); // Update const updated = await userRepo.update<User>( { name: "Ray" }, like("email", "%ray%") ); // Delete const deleted = await userRepo.delete<User>(like("name", "Ray%"));

</code><button type="button">Copy</button></pre>

🔍 Supported Operators<a

href="#🔍-supported-operators"

aria-label="Permalink"

class="tsd-anchor-icon"

><svg viewBox="0 0 24 24" aria-hidden="true">

<use href="assets/icons.svg#icon-anchor"></use></svg

></a>

</h3>

Comparison

<ul>

<li>eq("field", value) – Equal (=)</li>

<li>neq("field", value) – Not Equal (!=)</li>

<li>gt("field", value) – Greater Than (>)</li>

<li>

gte("field", value) – Greater Than or Equal (>=)

</li>

<li>lt("field", value) – Less Than (<)</li>

<li>lte("field", value) – Less Than or Equal (<=)</li>

<li>between("field", min, max) – BETWEEN</li>

<li>like("field", pattern) – LIKE</li>

<li>

ilike("field", pattern) – ILIKE (case-insensitive)

</li>

<li>regexp("field", pattern) – REGEXP</li>

<li>

iregexp("field", pattern) – Case-insensitive REGEXP

</li>

<li>inArray("field", [a, b, c]) – IN</li>

<li>notInArray("field", [a, b]) – NOT IN</li>

<li>isNull("field") – IS NULL</li>

<li>isNotNull("field") – IS NOT NULL</li>

</ul>

Logical

<ul>

<li>and(...conditions)</li>

<li>or(...conditions)</li>

<li>not(condition)</li>

<li>xor(condA, condB) [⚠️ -- Not tested properly]</li>

</ul>

Sorting

<ul>

<li>asc("field")</li>

<li>desc("field")</li>

<li>nullsFirst("field")</li>

<li>nullsLast("field")</li>

</ul>

</div>

<svg

width="20"

height="20"

viewBox="0 0 24 24"

fill="none"

aria-hidden="true"

</svg>

<h3>Settings</h3>

</summary>

Member Visibility

<label class="tsd-filter-input"

><input

type="checkbox"

id="tsd-filter-protected"

name="protected"

/><svg

width="32"

height="32"

viewBox="0 0 32 32"

aria-hidden="true"

<rect

class="tsd-checkbox-background"

width="30"

height="30"

x="1"

y="1"

rx="6"

fill="none"

></rect>

<path

class="tsd-checkbox-checkmark"

d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"

stroke="none"

stroke-width="3.5"

stroke-linejoin="round"

fill="none"

></path></svg

>Protected</label

</li>

<label class="tsd-filter-input"

><input

type="checkbox"

id="tsd-filter-inherited"

name="inherited"

checked

/><svg

width="32"

height="32"

viewBox="0 0 32 32"

aria-hidden="true"

<rect

class="tsd-checkbox-background"

width="30"

height="30"

x="1"

y="1"

rx="6"

fill="none"

></rect>

<path

class="tsd-checkbox-checkmark"

d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"

stroke="none"

stroke-width="3.5"

stroke-linejoin="round"

fill="none"

></path></svg

>Inherited</label

</li>

<label class="tsd-filter-input"

><input

type="checkbox"

id="tsd-filter-external"

name="external"

/><svg

width="32"

height="32"

viewBox="0 0 32 32"

aria-hidden="true"

<rect

class="tsd-checkbox-background"

width="30"

height="30"

x="1"

y="1"

rx="6"

fill="none"

></rect>

<path

class="tsd-checkbox-checkmark"

d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"

stroke="none"

stroke-width="3.5"

stroke-linejoin="round"

fill="none"

></path></svg

>External</label

</li>

</ul>

</div>

<label class="settings-label" for="tsd-theme">Theme</label

><select id="tsd-theme">

<option value="light">Light</option>

</select>

</div>

</details>

</div>

<svg

width="20"

height="20"

viewBox="0 0 24 24"

fill="none"

aria-hidden="true"

</svg>

</summary>

<a href="#sqlkit">sqlkit</a>

<ul>

<li>

<a href="#🔧-installation"

>🔧 Installation</a

</li>

<li>

<a href="#🚀-usage-examples"

>🚀 Usage Examples</a

</li>

<li>

<ul>

<li>

<a href="#1-query-builder-build-mode"

><span

>1. Query Builder (Build

Mode)</span

></a

</li>

<li>

<a href="#2-query-execution-commit-mode"

><span

>2. Query Execution (Commit

Mode)</span

></a

</li>

<li>

<a href="#3-repository-api-🔥"

>3. Repository API 🔥</a

</li>

<li>

<a href="#🔍-supported-operators"

>🔍 Supported Operators</a

</li>

</ul>

</li>

</ul>

</div>

</details>

</div>

<a href="modules.html">sqlkit</a>

<li>Loading...</li>

</ul>

</nav>

</div>

Generated using

<a href="https://typedoc.org/" target="_blank">TypeDoc</a>

Hello

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls