@azure/functions/types/sql.d.ts

Microsoft Azure Functions NodeJS Framework

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License.

import { FunctionInput, FunctionOptions, FunctionOutput, FunctionResult, FunctionTrigger } from './index';
import { InvocationContext } from './InvocationContext';

export type SqlHandler = (changes: SqlChange[], context: InvocationContext) => FunctionResult;

export interface SqlFunctionOptions extends SqlTriggerOptions, Partial<FunctionOptions> {
    handler: SqlHandler;

    trigger?: SqlTrigger;
}

export interface SqlTriggerOptions {
    /**
     * The name of the table monitored by the trigger.
     */
    tableName: string;

    /**
     * An app setting (or environment variable) with the connection string for the database containing the table monitored for changes
     */
    connectionStringSetting: string;
}
export type SqlTrigger = FunctionTrigger & SqlTriggerOptions;

export interface SqlChange {
    Item: unknown;
    Operation: SqlChangeOperation;
}

export enum SqlChangeOperation {
    Insert = 0,
    Update = 1,
    Delete = 2,
}

export interface SqlInputOptions {
    /**
     * The Transact-SQL query command or name of the stored procedure executed by the binding.
     */
    commandText: string;

    /**
     * The command type value
     */
    commandType: 'Text' | 'StoredProcedure';

    /**
     * An app setting (or environment variable) with the connection string for the database against which the query or stored procedure is being executed
     */
    connectionStringSetting: string;

    /**
     * Zero or more parameter values passed to the command during execution as a single string.
     * Must follow the format @param1=param1,@param2=param2.
     * Neither the parameter name nor the parameter value can contain a comma (,) or an equals sign (=).
     */
    parameters?: string;
}
export type SqlInput = FunctionInput & SqlInputOptions;

export interface SqlOutputOptions {
    /**
     * The name of the table being written to by the binding.
     */
    commandText: string;

    /**
     * An app setting (or environment variable) with the connection string for the database to which data is being written
     */
    connectionStringSetting: string;
}
export type SqlOutput = FunctionOutput & SqlOutputOptions;