TediousUtils.Interface.SqlParamDefVariants

tedious-plus / TediousUtils / SqlParamDefVariants

Interface: SqlParamDefVariants

Defined in: TediousUtils.ts:325

This structure provides variants for specifying SQL parameters.

Only one of the variants may be used.

In the SQL code, the parameters are referenced with an @ prefix, e.g. @p1.

Properties

paramDefArray?

paramDefArray?: SqlParamDef[];

Defined in: TediousUtils.ts:371

This variant is used to specify full parameter definitions as an array.

Example:

[
   {name: "p1", type: Tedious.TYPES.Int, value: 123},
   {name: "p2", type: Tedious.TYPES.NVarChar, value: "abc"}
]

---

paramDefs?

paramDefs?: Record<string, SqlParamValueAndDataType>;

Defined in: TediousUtils.ts:358

This variant is used to specify full parameter definitions as an object.

Example:

{
   p1: {type: Tedious.TYPES.Int, value: 123},
   p2: {type: Tedious.TYPES.NVarChar, value: "abc"}
}

---

params?

params?: Record<string, unknown>;

Defined in: TediousUtils.ts:334

This variant is used to specify parameter names and values.

Example: {p1: 123, p2: "abc"}

The data types are derived from the values (see deriveParamDataTypeFromValue).

---

paramValues?

paramValues?: unknown[];

Defined in: TediousUtils.ts:345

This variant is used to specify only the parameter values.

Example: [123, "abc"]

The parameter names a, b, c, ... are generated (see genParamName), so the parameters are referenced as @a, @b, @c, ... in the SQL code. The data types are derived from the values (see deriveParamDataTypeFromValue).