@ckpack/pg-helper
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

fieldsSql

  • fieldsSql(params: string[]): string

includeSql

  • includeSql(params?: SqlUtilsType.Include[]): string

  • build include Sql

    Parameters

    • Optional params: SqlUtilsType.Include[]

    Returns string

insertSql

  • insertSql(params: SqlUtilsType.Insert): { data: any[]; sql: string }

  • build insert sql

    Parameters

    • params: SqlUtilsType.Insert

    Returns { data: any[]; sql: string }

    • data: any[]
    • sql: string

limitOffsetSql

  • limitOffsetSql(params: SqlUtilsType.LimitOffset): string

  • build limit offset sql

    Parameters

    • params: SqlUtilsType.LimitOffset

    Returns string

literalSql

  • literalSql(sql: string): { [symbolLiteral]: string }

  • Functions used internally to build sql, It is useful to construct some special SQL, the returned sql will not be used as a template for the key

    Parameters

    • sql: string

    Returns { [symbolLiteral]: string }

    • [symbolLiteral]: string

objHump2underline

  • objHump2underline(obj: EmptyObj): EmptyObj

orderSql

  • orderSql(orders?: SqlUtilsType.Order[]): string

  • build order sql

    Parameters

    • orders: SqlUtilsType.Order[] = ...

    Returns string

returningSql

  • returningSql(returning?: SqlUtilsType.Returning): string

  • build returning sql

    Parameters

    • Optional returning: SqlUtilsType.Returning

    Returns string

rowsUnderline2hump

  • rowsUnderline2hump(rows: EmptyObj[]): EmptyObj[]

sqlTemplate

  • sqlTemplate(sqlTemp: SqlTemplate, sqlParams?: SqlTempParams): { sql: string; values: any[] }

  • sqlTemp to pg query params

    sqlTemp: `select * from ${USERS}  where username = {username}`
sqlParams: {username: 'xiaohong'}
to
sql: `select * from ${USERS}  where username = $1`
values: ['xiaohong']

    Parameters

    • sqlTemp: SqlTemplate

      sql

    • Optional sqlParams: SqlTempParams

      value

    Returns { sql: string; values: any[] }

    • sql: string
    • values: any[]

updateSql

  • updateSql(params?: SqlUtilsType.Update): string

  • build update sql

    Parameters

    • params: SqlUtilsType.Update = ...

    Returns string

whereSql

  • whereSql(where?: SqlUtilsType.Where): string

  • build where sql

    Parameters

    • Optional where: SqlUtilsType.Where

    Returns string

Legend

  • Constructor
  • Method
  • Private property
  • Private method

Generated using TypeDoc