Member Junction
    Preparing search index...

    Interface CreateQueryInput

    Input type for CreateQuery mutation calls - creates a new query with optional hierarchical category path

    interface CreateQueryInput {
        AutoResolveCollision?: boolean;
        CategoryID?: string;
        CategoryPath?: string;
        Description?: string;
        ExecutionCostRank?: number;
        Feedback?: string;
        Name: string;
        OriginalSQL?: string;
        ParameterHints?: QueryParameterHintInput[];
        Permissions?: QueryPermissionInput[];
        QualityRank?: number;
        SQL?: string;
        Status?: "Pending" | "Approved" | "Rejected" | "Expired";
        TechnicalDescription?: string;
        UserQuestion?: string;
        UsesTemplate?: boolean;
    }
    Index

    Properties

    AutoResolveCollision? CategoryID? CategoryPath? Description? ExecutionCostRank? Feedback? Name OriginalSQL? ParameterHints? Permissions? QualityRank? SQL? Status? TechnicalDescription? UserQuestion? UsesTemplate?

    Properties

    AutoResolveCollision?: boolean

    When true, the server will automatically resolve name collisions by appending sequential numeric suffixes (e.g., "Name (1)", "Name (2)") instead of returning an error. The resolved name is returned in the result's Query.Name field.

    CategoryID?: string

    Optional existing category ID to assign the query to

    CategoryPath?: string

    Optional category path for automatic hierarchy creation (e.g., "Reports/Sales/Monthly") - takes precedence over CategoryID

    Description?: string

    Optional general description of what the query does

    ExecutionCostRank?: number

    Optional execution cost indicator (higher = more expensive to run)

    Feedback?: string

    Optional user feedback about the query

    Name: string

    Required name for the query (must be unique within category)

    OriginalSQL?: string

    Optional original SQL before optimization or modification

    ParameterHints?: QueryParameterHintInput[]

    Optional caller-provided parameter sample values. When provided, these override LLM-generated sampleValues during the extraction pipeline. Each entry maps a parameter name to a tested/validated sample value.

    Permissions?: QueryPermissionInput[]

    Optional array of permissions to create for the query

    QualityRank?: number

    Optional quality indicator (higher = better quality, defaults to 0)

    SQL?: string

    Optional SQL query text to execute (can contain Nunjucks template syntax)

    Status?: "Pending" | "Approved" | "Rejected" | "Expired"

    Optional query approval status (defaults to 'Pending')

    TechnicalDescription?: string

    Optional technical documentation for developers

    UserQuestion?: string

    Optional natural language question this query answers

    UsesTemplate?: boolean

    Optional flag indicating if the query uses Nunjucks template syntax (auto-detected if not specified)

    Settings

    Member Visibility

    On This Page

    Properties