Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/g4brym/workers-qb
Zero dependencies Query Builder for Cloudflare Workers
https://github.com/g4brym/workers-qb
cloudflare cloudflare-d1 cloudflare-workers d1sql javascript nodejs query-builder sql-builder typescript worker workers
Last synced: 3 days ago
JSON representation
Zero dependencies Query Builder for Cloudflare Workers
- Host: GitHub
- URL: https://github.com/g4brym/workers-qb
- Owner: G4brym
- License: mit
- Created: 2022-07-30T17:50:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-16T10:12:46.000Z (over 1 year ago)
- Last Synced: 2023-12-02T10:00:44.436Z (about 1 year ago)
- Topics: cloudflare, cloudflare-d1, cloudflare-workers, d1sql, javascript, nodejs, query-builder, sql-builder, typescript, worker, workers
- Language: TypeScript
- Homepage: https://workers-qb.massadas.com
- Size: 280 KB
- Stars: 187
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Zero-dependency Query Builder for Cloudflare Workers
## Overview
workers-qb is a lightweight query builder designed specifically for Cloudflare Workers. It provides a simple, standardized interface while maintaining the performance benefits of raw queries over traditional ORMs.
📚 [Read the full documentation](https://workers-qb.massadas.com/)
### Key Differences from ORMs
- Focused on direct SQL access with convenient wrapper methods
- Maintains raw query performance
- Zero dependencies
- Lightweight and Worker-optimized
## Supported Databases
- ☁️ [Cloudflare D1](https://workers-qb.massadas.com/databases/cloudflare-d1/)
- 💾 [Cloudflare Durable Objects](https://workers-qb.massadas.com/databases/cloudflare-do/)
- 🐘 [PostgreSQL (via node-postgres)](https://workers-qb.massadas.com/databases/postgresql/)
- 🔌 [Bring Your Own Database](https://workers-qb.massadas.com/databases/bring-your-own-database/)
## Features
### Core Features
- Zero dependencies
- Full TypeScript support
- Database schema migrations
- Type checking for data reads
- Lazy row loading
### Query Operations
- Table operations (create/drop)
- CRUD operations (insert/update/select/delete)
- Bulk inserts
- JOIN queries
- Modular SELECT queries
- ON CONFLICT handling
- UPSERT support
## Installation
```bash
npm install workers-qb --save
```
## Usage Examples
### Cloudflare D1
```typescript
import { D1QB } from 'workers-qb'
export interface Env {
DB: D1Database
}
export default {
async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise {
const qb = new D1QB(env.DB)
type Employee = {
name: string
role: string
level: number
}
// Using object syntax
const employeeList = await qb
.fetchAll({
tableName: 'employees',
where: {
conditions: 'active = ?1',
params: [true],
},
})
.execute()
// Using method chaining
const employeeListModular = await qb
.select('employees')
.where('active = ?', true)
.execute()
return Response.json({
activeEmployees: employeeList.results?.length || 0,
})
},
}
```
### Cloudflare Durable Objects
```typescript
import { DOQB } from 'workers-qb'
export class DOSRS extends DurableObject {
getEmployees() {
const qb = new DOQB(this.ctx.storage.sql)
return qb
.fetchAll({
tableName: 'employees',
})
.execute()
.results
}
}
```
### PostgreSQL Integration
First, install the required PostgreSQL client:
```bash
npm install pg --save
```
Enable Node compatibility in `wrangler.toml`:
```toml
node_compat = true
```
Example usage:
```typescript
import { PGQB } from 'workers-qb'
import { Client } from 'pg'
export interface Env {
DB_URL: string
}
export default {
async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise {
const qb = new PGQB(new Client(env.DB_URL))
await qb.connect()
const fetched = await qb
.fetchOne({
tableName: 'employees',
fields: 'count(*) as count',
where: {
conditions: 'active = ?1',
params: [true],
},
})
.execute()
// Important: Close the connection
ctx.waitUntil(qb.close())
return Response.json({
activeEmployees: fetched.results?.count || 0,
})
},
}
```
## Documentation
Visit our [comprehensive documentation](https://workers-qb.massadas.com/) for detailed information about:
- [Basic Queries](https://workers-qb.massadas.com/basic-queries/)
- [Advanced Queries](https://workers-qb.massadas.com/advanced-queries/)
- [Migrations](https://workers-qb.massadas.com/migrations/)
- [Type Checking](https://workers-qb.massadas.com/type-check/)
- [Database-specific guides](https://workers-qb.massadas.com/databases/)
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.