Class BaseNumberDataType<Options>

constructor

• new BaseNumberDataType<Options>(options?): BaseNumberDataType<Options>

• Type Parameters

  • Options extends NumberOptions = NumberOptions

  Parameters

  • Optional options: Options

  Returns BaseNumberDataType<Options>

Readonly options

UNSIGNED

• get UNSIGNED(): this

• Returns this

ZEROFILL

• get ZEROFILL(): this

• Returns this

Static UNSIGNED

• get UNSIGNED(): BaseNumberDataType<{
      unsigned: true;
  }>

• Returns BaseNumberDataType<{
      unsigned: true;
  }>

Static ZEROFILL

• get ZEROFILL(): BaseNumberDataType<{
      zerofill: true;
  }>

• Returns BaseNumberDataType<{
      zerofill: true;
  }>

escape

• escape(value): string

• Escapes a value for the purposes of inlining it in a SQL query. The resulting value will be inlined as-is with no further escaping.

  Parameters

  • value: AcceptedNumber

    The value to escape.

  Returns string

getBindParamSql

• getBindParamSql(value, options): string

• This method is called when AbstractQueryGenerator needs to add a bind parameter to a query it is building. This method allows for customizing both the SQL to add to the query, and convert the bind parameter value to a DB-compatible value.

  If you only need to prepare the bind param value, implement toBindableValue instead.

  This method must return the SQL to add to the query. You can obtain a bind parameter ID by calling BindParamOptions#bindParam with the value associated to that bind parameter.

  An example of a data type that requires customizing the SQL is the GEOMETRY data type.

  Parameters

  • value: AcceptedNumber

    The value to bind.
  • options: BindParamOptions

    Options.

  Returns string

toBindableValue

• toBindableValue(num): string | number

• Converts a JS value to a value compatible with the connector library for this Data Type. Unlike escape, this value does not need to be escaped. It is passed separately to the database, which will handle escaping.

  Parameters

  • num: AcceptedNumber

    The value to convert.

  Returns string | number

toSql

• toSql(): string

• Returns a SQL declaration of this data type. e.g. 'VARCHAR(255)', 'TEXT', etc…

  Returns string

validate

• validate(value): asserts value is number

• Checks whether the JS value is compatible with (or can be converted to) the SQL data type. Throws if that is not the case.

  Parameters

  • value: any

  Returns asserts value is number