Class Repository<T>

Type Parameters

T

Index

Constructors

Properties

executor logging readTable writeTable

Methods

count delete find findOne insert paginate update

Constructors

constructor

new Repository<T>(config: RepositoryConfig): Repository<T>
Type Parameters
- T
Parameters
- config: RepositoryConfig
Returns Repository<T>
- Defined in repository/repository.ts:32

Properties

`Protected` `Readonly`executor

executor: SqlExecutor

`Protected` `Readonly`logging

logging: boolean

`Protected` `Readonly`readTable

readTable: string

`Protected` `Readonly`writeTable

writeTable: string

Methods

count

count(where?: WhereCondition<T>): Promise<number>
Parameters
- Optionalwhere: WhereCondition<T>
Returns Promise<number>
- Defined in repository/repository.ts:117

delete

delete(
    args: {
        operationName?: string;
        returning?: (keyof T)[];
        where: WhereCondition<T>;
    },
): Promise<QueryResult<T> | null>
Parameters
- args: { operationName?: string; returning?: (keyof T)[]; where: WhereCondition<T> }
Returns Promise<QueryResult<T> | null>
- Defined in repository/repository.ts:187

find

find(payload?: QueryRowsPayload<T>): Promise<T[]>
Parameters
- Optionalpayload: QueryRowsPayload<T>
Returns Promise<T[]>
- Defined in repository/repository.ts:39

findOne

findOne(
    whereOrPayload:
        | WhereCondition<T>
        | Omit<QueryRowsPayload<T>, "offset" | "limit"> & {
            where: WhereCondition<T>;
        },
): Promise<T | null>
Return the first matching row, or null. Pass a where condition or a full query payload (must include where).
Parameters
- whereOrPayload:
      | WhereCondition<T>
      | Omit<QueryRowsPayload<T>, "offset" | "limit"> & {
          where: WhereCondition<T>;
      }
Returns Promise<T | null>
- Defined in repository/repository.ts:71

insert

insert(
data: Partial<T> | Partial<T>[],
returning?: (keyof T)[],
): Promise<QueryResult<T>>
Parameters
- data: Partial<T> | Partial<T>[]
- Optionalreturning: (keyof T)[]
Returns Promise<QueryResult<T>>
- Defined in repository/repository.ts:131

paginate

paginate(options: PaginationOptions<T>): Promise<PaginatedResult<T>>
Paginate the result of a query
Parameters
- options: PaginationOptions<T>
Returns Promise<PaginatedResult<T>>
- Defined in repository/repository.ts:104

update

update(
    args: {
        data: Partial<T>;
        operationName?: string;
        returning?: (keyof T)[];
        where: WhereCondition<T>;
    },
): Promise<QueryResult<T>>
Parameters
- args: {
      data: Partial<T>;
      operationName?: string;
      returning?: (keyof T)[];
      where: WhereCondition<T>;
  }
Returns Promise<QueryResult<T>>
- Defined in repository/repository.ts:157