MysqlStore | @cashfarm/store

Type parameters

TTable: Table
TDto

Hierarchy

Store
- MysqlStore

Implements

IStore

Index

Constructors

constructor

Properties

Accessors

newQuery

Methods

Constructors

constructor

new MysqlStore(db: IPool): MysqlStore

- Defined in mysqlStore.ts:20
Parameters
- db: IPool
Returns MysqlStore

Properties

db

db: IPool

DTO

DTO: symbol = Sym.DTO

TABLE

TABLE: symbol = Sym.TABLE

Accessors

newQuery

newQuery:

Methods

compute

compute<TScalar>(expression: string, defaultValue?: TScalar): Promise<TScalar>
compute<TScalar>(queryOrBuilder: Types.QueryOrBuilder<TTable>, defaultValue?: TScalar): Promise<TScalar>

- Defined in mysqlStore.ts:62
Select a single field or expression and return its value

template

TScalar

memberof

MysqlStore

Type parameters
- TScalar
Parameters
- expression: string
  
  A select expression. E.g. "COUNT(id)"
- Optional defaultValue: TScalar
Returns Promise<TScalar>
- Defined in mysqlStore.ts:73
Select a single field or expression and return its value

template

TScalar

memberof

MysqlStore

Type parameters
- TScalar
Parameters
- queryOrBuilder: Types.QueryOrBuilder<TTable>
  
  A query or a query builder function. E.g. t => t.id
- Optional defaultValue: TScalar
Returns Promise<TScalar>

create

create(obj: TDto): Promise<TDto>

- Defined in mysqlStore.ts:103
Parameters
- obj: TDto
Returns Promise<TDto>

delete

delete(criteriaOrBuilder: CriteriaOrBuilder<TTable>): Promise<IOkResult>

- Defined in mysqlStore.ts:144
Parameters
- criteriaOrBuilder: CriteriaOrBuilder<TTable>
Returns Promise<IOkResult>

find

find(queryOrBuilder: Types.QueryBuilder<TTable>, dtoMapper?: function): Promise<TDto[]>

- Defined in mysqlStore.ts:30
Parameters
- queryOrBuilder: Types.QueryBuilder<TTable>
- Optional dtoMapper: function
  - - (rows: any[]): TDto[]
    - Parameters
      - rows: any[]
      Returns TDto[]
Returns Promise<TDto[]>

findOne

findOne(query: IQuery<TTable>): Promise<TDto>
findOne(query: Types.QueryBuilder<TTable>): Promise<TDto>

- Defined in mysqlStore.ts:36
Parameters
- query: IQuery<TTable>
Returns Promise<TDto>
- Defined in mysqlStore.ts:37
Parameters
- query: Types.QueryBuilder<TTable>
Returns Promise<TDto>

runCommand

runCommand(command: string): Promise<any>

- Defined in mysqlStore.ts:150
Parameters
- command: string
Returns Promise<any>

update

update(data: object, criteriaOrBuilder: CriteriaOrBuilder<TTable>, excludeFields?: string & keyof TTable[]): Promise<IOkResult>

- Defined in mysqlStore.ts:133
Parameters
- data: object
- criteriaOrBuilder: CriteriaOrBuilder<TTable>
- Default value excludeFields: string & keyof TTable[] = []
Returns Promise<IOkResult>

Generated using TypeDoc