MySql Changes for JS (#319)

* mysql changes

* fix indentation

* fix indentation

* fix indentation

* fix indentation

* Fix comment formatting in InvocationContext.d.ts

* Update link to MySQL trigger documentation

---------

Co-authored-by: hallvictoria <[email protected]>

Author: guptaheena

src/app.ts

@@ -11,6 +11,7 @@ import {
     HttpHandler,
     HttpMethod,
     HttpMethodFunctionOptions,
+    MySqlFunctionOptions,
     ServiceBusQueueFunctionOptions,
     ServiceBusTopicFunctionOptions,
     SqlFunctionOptions,
@@ -136,6 +137,10 @@ export function sql(name: string, options: SqlFunctionOptions): void {
     generic(name, convertToGenericOptions(options, trigger.sql));
 }
 
+export function mySql(name: string, options: MySqlFunctionOptions): void {
+    generic(name, convertToGenericOptions(options, trigger.mySql));
+}
+
 export function webPubSub(name: string, options: WebPubSubFunctionOptions): void {
     generic(name, convertToGenericOptions(options, trigger.webPubSub));
 }

src/index.ts

@@ -22,3 +22,7 @@ export enum SqlChangeOperation {
     Update = 1,
     Delete = 2,
 }
+
+export enum MySqlChangeOperation {
+    Update = 0,
+}

src/input.ts

@@ -6,6 +6,8 @@ import {
     CosmosDBInputOptions,
     FunctionInput,
     GenericInputOptions,
+    MySqlInput,
+    MySqlInputOptions,
     SqlInput,
     SqlInputOptions,
     StorageBlobInput,
@@ -47,6 +49,13 @@ export function sql(options: SqlInputOptions): SqlInput {
     });
 }
 
+export function mySql(options: MySqlInputOptions): MySqlInput {
+    return addInputBindingName({
+        ...options,
+        type: 'mysql',
+    });
+}
+
 export function webPubSubConnection(options: WebPubSubConnectionInputOptions): WebPubSubConnectionInput {
     return addInputBindingName({
         ...options,

src/output.ts

@@ -12,6 +12,8 @@ import {
     GenericOutputOptions,
     HttpOutput,
     HttpOutputOptions,
+    MySqlOutput,
+    MySqlOutputOptions,
     ServiceBusQueueOutput,
     ServiceBusQueueOutputOptions,
     ServiceBusTopicOutput,
@@ -99,6 +101,13 @@ export function sql(options: SqlOutputOptions): SqlOutput {
     });
 }
 
+export function mySql(options: MySqlOutputOptions): MySqlOutput {
+    return addOutputBindingName({
+        ...options,
+        type: 'mysql',
+    });
+}
+
 export function webPubSub(options: WebPubSubOutputOptions): WebPubSubOutput {
     return addOutputBindingName({
         ...options,

src/trigger.ts

@@ -12,6 +12,8 @@ import {
     GenericTriggerOptions,
     HttpTrigger,
     HttpTriggerOptions,
+    MySqlTrigger,
+    MySqlTriggerOptions,	
     ServiceBusQueueTrigger,
     ServiceBusQueueTriggerOptions,
     ServiceBusTopicTrigger,
@@ -110,6 +112,13 @@ export function sql(options: SqlTriggerOptions): SqlTrigger {
     });
 }
 
+export function mySql(options: MySqlTriggerOptions): MySqlTrigger {
+    return addTriggerBindingName({
+        ...options,
+        type: 'mysqlTrigger',
+    });
+}
+
 export function webPubSub(options: WebPubSubTriggerOptions): WebPubSubTrigger {
     return addTriggerBindingName({
         ...options,

types/InvocationContext.d.ts

@@ -6,6 +6,7 @@ import { EventGridOutput, EventGridPartialEvent } from './eventGrid';
 import { EventHubOutput } from './eventHub';
 import { HttpOutput, HttpResponse } from './http';
 import { FunctionInput, FunctionOutput, FunctionTrigger, LogLevel } from './index';
+import { MySqlInput, MySqlOutput } from './mySql';
 import { ServiceBusQueueOutput, ServiceBusTopicOutput } from './serviceBus';
 import { SqlInput, SqlOutput } from './sql';
 import { StorageBlobInput, StorageBlobOutput, StorageQueueOutput } from './storage';
@@ -128,6 +129,12 @@ export interface InvocationContextExtraInputs {
      * @input the configuration object for this SQL input
      */
     get(input: SqlInput): unknown;
+	
+    /**
+     * Get a secondary MySql items input for this invocation
+     * @input the configuration object for this MySql input
+     */
+    get(input: MySqlInput): unknown;
 
     /**
      * Get a secondary generic input for this invocation
@@ -216,6 +223,13 @@ export interface InvocationContextExtraOutputs {
      * @message the output event(s) value
      */
     set(output: EventGridOutput, events: EventGridPartialEvent | EventGridPartialEvent[]): void;
+	
+    /**
+     * Set a secondary MySql items output for this invocation
+     * @output the configuration object for this MySql output
+     * @documents the output item(s) value
+     */
+    set(output: MySqlOutput, items: unknown): void;
 
     /**
      * Set a secondary Web PubSub output for this invocation

types/app.d.ts

@@ -6,6 +6,7 @@ import { EventGridFunctionOptions } from './eventGrid';
 import { EventHubFunctionOptions } from './eventHub';
 import { GenericFunctionOptions } from './generic';
 import { HttpFunctionOptions, HttpHandler, HttpMethodFunctionOptions } from './http';
+import { MySqlFunctionOptions } from './mySql';
 import { ServiceBusQueueFunctionOptions, ServiceBusTopicFunctionOptions } from './serviceBus';
 import { SetupOptions } from './setup';
 import { SqlFunctionOptions } from './sql';
@@ -173,6 +174,13 @@ export function warmup(name: string, options: WarmupFunctionOptions): void;
  */
 export function sql(name: string, options: SqlFunctionOptions): void;
 
+/**
+ * Registers a MySql function in your app that will be triggered when a row is created or updated
+ * @param name The name of the function. The name must be unique within your app and will mostly be used for your own tracking purposes
+ * @param options Configuration options describing the inputs, outputs, and handler for this function
+ */
+export function mySql(name: string, options: MySqlFunctionOptions): void;
+
 /**
  * Registers a generic function in your app that will be triggered based on the type specified in `options.trigger.type`
  * Use this method if your desired trigger type does not already have its own method

types/index.d.ts

@@ -17,6 +17,7 @@ export * from './hooks/logHooks';
 export * from './http';
 export * as input from './input';
 export * from './InvocationContext';
+export * from './mySql';
 export * as output from './output';
 export * from './serviceBus';
 export * from './setup';

types/input.d.ts

@@ -7,6 +7,7 @@ import { FunctionInput } from './index';
 import { SqlInput, SqlInputOptions } from './sql';
 import { StorageBlobInput, StorageBlobInputOptions } from './storage';
 import { TableInput, TableInputOptions } from './table';
+import { MySqlInput, MySqlInputOptions } from './mySql';
 import {
     WebPubSubConnectionInput,
     WebPubSubConnectionInputOptions,
@@ -34,6 +35,11 @@ export function cosmosDB(options: CosmosDBInputOptions): CosmosDBInput;
  */
 export function sql(options: SqlInputOptions): SqlInput;
 
+/**
+ * [Link to docs and examples](https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-azure-mysql-input?pivots=programming-language-javascript)
+ */
+export function mySql(options: MySqlInputOptions): MySqlInput;
+
 /**
  * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-input?pivots=programming-language-javascript)
  */

types/mySql.d.ts

@@ -0,0 +1,73 @@
+// 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 MySqlHandler = (changes: MySqlChange[], context: InvocationContext) => FunctionResult;
+
+export interface MySqlFunctionOptions extends MySqlTriggerOptions, Partial<FunctionOptions> {
+    handler: MySqlHandler;
+
+    trigger?: MySqlTrigger;
+}
+
+export interface MySqlTriggerOptions {
+    /**
+     * 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 MySqlTrigger = FunctionTrigger & MySqlTriggerOptions;
+
+export interface MySqlChange {
+    Item: unknown;
+    Operation: MySqlChangeOperation;
+}
+
+export enum MySqlChangeOperation {
+    Update = 0,
+}
+
+export interface MySqlInputOptions {
+    /**
+     * 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 MySqlInput = FunctionInput & MySqlInputOptions;
+
+export interface MySqlOutputOptions {
+    /**
+     * 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 MySqlOutput = FunctionOutput & MySqlOutputOptions;

types/output.d.ts

@@ -16,6 +16,7 @@ import {
 import { SqlOutput, SqlOutputOptions } from './sql';
 import { StorageBlobOutput, StorageBlobOutputOptions, StorageQueueOutput, StorageQueueOutputOptions } from './storage';
 import { TableOutput, TableOutputOptions } from './table';
+import { MySqlOutput, MySqlOutputOptions } from './mySql';
 import { WebPubSubOutput, WebPubSubOutputOptions } from './webpubsub';
 
 /**
@@ -68,6 +69,11 @@ export function cosmosDB(options: CosmosDBOutputOptions): CosmosDBOutput;
  */
 export function sql(options: SqlOutputOptions): SqlOutput;
 
+/**
+ * [Link to docs and examples](https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-azure-mysql-output?pivots=programming-language-javascript)
+ */
+export function mySql(options: MySqlOutputOptions): MySqlOutput;
+
 /**
  * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-output?pivots=programming-language-javascript)
  */

types/trigger.d.ts

@@ -7,6 +7,7 @@ import { EventHubTrigger, EventHubTriggerOptions } from './eventHub';
 import { GenericTriggerOptions } from './generic';
 import { HttpTrigger, HttpTriggerOptions } from './http';
 import { FunctionTrigger } from './index';
+import { MySqlTrigger, MySqlTriggerOptions } from './mySql';
 import {
     ServiceBusQueueTrigger,
     ServiceBusQueueTriggerOptions,
@@ -23,6 +24,7 @@ import {
 import { TimerTrigger, TimerTriggerOptions } from './timer';
 import { WarmupTrigger, WarmupTriggerOptions } from './warmup';
 import { WebPubSubTrigger, WebPubSubTriggerOptions } from './webpubsub';
+
 /**
  * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-http-webhook-trigger?&pivots=programming-language-javascript)
  */
@@ -78,6 +80,11 @@ export function warmup(options: WarmupTriggerOptions): WarmupTrigger;
  */
 export function sql(options: SqlTriggerOptions): SqlTrigger;
 
+/**
+ * [Link to docs and examples](https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-azure-mysql-trigger?pivots=programming-language-javascript)
+ */
+export function mySql(options: MySqlTriggerOptions): MySqlTrigger;
+
 /**
  * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-web-pubsub-trigger?pivots=programming-language-javascript)
  */