Class SqliteQueryBuilder

Utility class to build sql queries

Hierarchy

  • SqliteQueryBuilder

Constructors

constructor

Methods

buildCount buildInsert buildInsertFromColumnNames buildObjectUpdate buildQuery buildUpdate buildUpdateOrInsertObject fixColumnName

Constructors

constructor

Methods

Static buildCount

  • Builds a count statement

    Returns

    count statement

    Parameters

    • tables: string

      table names to query for

    • Optional where: string

      where clause

    Returns string

Static buildInsert

  • Builds an insert statement using the properties of the object

    Returns

    insert statement

    Parameters

    • table: string

      table to insert into

    • object: any

      object to insert

    Returns string

Static buildInsertFromColumnNames

  • Builds an insert statement from the object.getColumnNames method

    Returns

    insert statement

    Parameters

    • table: string

      table to insert into

    • object: any

      object with a getColumnNames method

    Returns string

Static buildObjectUpdate

  • Builds an update from an object

    Returns

    update statement

    Parameters

    • table: string

      table name to update

    • object: any

      object with values to update

    Returns string

Static buildQuery

  • Builds a query

    Returns

    Parameters

    • distinct: boolean

      whether query should be distinct or not

    • tables: string

      table names to query, added to the query from clause

    • Optional columns: string[]

      columns to query for

    • Optional where: string

      where clause

    • Optional join: string

      join clause

    • Optional groupBy: string

      group by clause

    • Optional having: string

      having clause

    • Optional orderBy: string

      order by clause

    • Optional limit: number

      limit

    • Optional offset: number

      offset

    Returns string

Static buildUpdate

  • Builds an update statement

    Returns

    object with a sql property containing the update statement and an args property with bind arguments

    Parameters

    • table: string

      table to update

    • values: Record<string, DBValue>

      object with values to update

    • Optional where: string

      where clause

    • Optional whereArgs: DBValue | DBValue[]

      where bind parameters

    Returns {
        args: DBValue[];
        sql: string;
    }

Static buildUpdateOrInsertObject

  • Builds an update or insert object to bind to a statement

    Returns

    bind parameters

    Parameters

    • object: any

      object to create bind parameters from

    Returns any

Static fixColumnName

  • Replaces all whitespace in a column name with underscores

    Returns

    Parameters

    • columnName: string

      column name to fix

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc