Base interface for query parameter information. Describes parameters that can be passed to parameterized queries.

interface IQueryParameterInfoBase {
    DefaultValue: string;
    Description: string;
    ID: string;
    IsRequired: boolean;
    Name: string;
    QueryID: string;
    SampleValue: string;
    Type: string;
    ValidationFilters: string;
}

Implemented by

Properties

DefaultValue: string

Default value to use when parameter is not provided

Description: string

Human-readable description of what this parameter is for

ID: string

Unique identifier for this parameter record

IsRequired: boolean

Whether this parameter must be provided when executing the query

Name: string

The name of the parameter as it appears in the template (e.g., {{parameterName}})

QueryID: string

Foreign key to the parent query

SampleValue: string

Example value demonstrating the proper format for this parameter

Type: string

Data type of the parameter for validation and type casting

ValidationFilters: string

JSON array of Nunjucks filter definitions for value transformation