Database-Parameter-Config.md

'Parameter' object (database-driven)

The Parameter is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected StoredProcedure.Type.

Example

A YAML example is as follows:

tables:
- { name: Table, schema: Test, create: true, update: true, upsert: true, delete: true, merge: true, udt: true, getAll: true, getAllOrderBy: [ Name Des ], excludeColumns: [ Other ], permission: TestSec,
    storedProcedures: [
      { name: GetByArgs, type: GetColl, excludeColumns: [ Count ],
        parameters: [
          { name: Name, nullable: true, operator: LIKE },
          { name: MinCount, operator: GE, column: Count },
          { name: MaxCount, operator: LE, column: Count, nullable: true }
        ]
      },
      { name: Get, type: Get, withHints: NOLOCK,
        execute: [
          { statement: EXEC Demo.Before, location: Before },
          { statement: EXEC Demo.After }
        ]
      },
      { name: Update, type: Update }
    ]
  }

Properties

The Parameter object supports a number of properties that control the generated code output. The following properties with a bold name are those that are more typically used (considered more important).

Property	Description
name	The parameter name (without the @ prefix). [Mandatory]
column	The corresponding column name; used to infer characteristics. † Defaults to Name.
sqlType	The SQL type definition (overrides inherited Column definition) including length/precision/scale.
nullable	Indicates whether the parameter is nullable. † Note that when the parameter value is NULL it will not be included in the query.
treatColumnNullAs	Indicates whether the column value where NULL should be treated as the specified value; results in: ISNULL([x].[col], value).
collection	Indicates whether the parameter is a collection (one or more values to be included IN the query).
collectionType	The collection type. Valid options are: JSON, UDT. † Values are JSON being a JSON array (preferred) or UDT for a User-Defined Type (legacy). Defaults to StoredProcedure.CollectionType.
operator	The where clause equality operator Valid options are: EQ, NE, LT, LE, GT, GE, LIKE. † Defaults to EQ.