Interface Executable<O>

interface Executable<O> {
    execute(options?: AbortableQueryOptions): Promise<SimplifyResult<O>[]>;
    executeTakeFirst(
        options?: AbortableQueryOptions,
    ): Promise<SimplifySingleResult<O>>;
    executeTakeFirstOrThrow(
        options?:
            | NoResultErrorConstructor
            | ExecuteTakeFirstOrThrowOptions
            | ((node: QueryNode) => Error),
    ): Promise<SimplifyResult<O>>;
}

Type Parameters

O

Hierarchy (View Summary)

Executable
- SelectQueryBuilder

Implemented by

Index

Methods

execute executeTakeFirst executeTakeFirstOrThrow

Methods

execute

execute(options?: AbortableQueryOptions): Promise<SimplifyResult<O>[]>
Executes the query and returns an array of rows.

Also see the executeTakeFirst and executeTakeFirstOrThrow methods.
Parameters
- Optionaloptions: AbortableQueryOptions
Returns Promise<SimplifyResult<O>[]>
- Defined in util/executable.ts:12

executeTakeFirst

executeTakeFirst(
options?: AbortableQueryOptions,
): Promise<SimplifySingleResult<O>>
Executes the query and returns the first result or undefined if the query returned no result.
Parameters
- Optionaloptions: AbortableQueryOptions
Returns Promise<SimplifySingleResult<O>>
- Defined in util/executable.ts:18

executeTakeFirstOrThrow

executeTakeFirstOrThrow(
    options?:
        | NoResultErrorConstructor
        | ExecuteTakeFirstOrThrowOptions
        | ((node: QueryNode) => Error),
): Promise<SimplifyResult<O>>
Executes the query and returns the first result or throws if the query returned no result.

By default an instance of NoResultError is thrown, but you can provide a custom error class, or callback to throw a different error.
Parameters
- Optionaloptions:
      | NoResultErrorConstructor
      | ExecuteTakeFirstOrThrowOptions
      | ((node: QueryNode) => Error)
Returns Promise<SimplifyResult<O>>
- Defined in util/executable.ts:30