Class QueryBuilder

Fluent query builder for a single table. Created by DataModule.from. All methods return { data, error }.

Example

const products = client.db.from('products');
const { data } = await products.select({ active: true });
await products.insert({ name: 'Widget', price: 9.99 });
await products.update('abc123', { price: 12.99 });
await products.delete('abc123');

Index

Constructors

constructor

Methods

delete insert select update

Constructors

constructor

new QueryBuilder(table: string, api: ApiClient): QueryBuilder
Parameters
- table: string
- api: ApiClient
Returns QueryBuilder
- Defined in src/modules/data/DataModule.ts:80

Methods

delete

delete(id: string | number): Promise<DypaiResponse<any>>
Deletes a row by ID. Calls DELETE /api/v0/{table}/{id}.
Parameters
- id: string | number
  Row identifier.
Returns Promise<DypaiResponse<any>>
- Defined in src/modules/data/DataModule.ts:114

insert

insert(data: Record<string, any>): Promise<DypaiResponse<any>>
Inserts a new row. Calls POST /api/v0/{table}.
Parameters
- data: Record<string, any>
  The row data to insert.
Returns Promise<DypaiResponse<any>>
- Defined in src/modules/data/DataModule.ts:97

select

select(filters?: Record<string, any>): Promise<DypaiResponse<any>>
Fetches rows from the table. Calls GET /api/v0/{table}.
Parameters
- filters: Record<string, any> = {}
  Optional key-value filters sent as query parameters.
Returns Promise<DypaiResponse<any>>
- Defined in src/modules/data/DataModule.ts:89

update

update(
id: string | number,
data: Record<string, any>,
): Promise<DypaiResponse<any>>
Updates an existing row by ID. Calls PATCH /api/v0/{table}/{id}.
Parameters
- id: string | number
  Row identifier.
- data: Record<string, any>
  Fields to update.
Returns Promise<DypaiResponse<any>>
- Defined in src/modules/data/DataModule.ts:106

Class QueryBuilder

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns QueryBuilder

Methods

delete

Parameters

Returns Promise<DypaiResponse<any>>

insert

Parameters

Returns Promise<DypaiResponse<any>>

select

Parameters

Returns Promise<DypaiResponse<any>>

update

Parameters

Returns Promise<DypaiResponse<any>>

Settings

On This Page