From 73d18641afc6adeaf8f2d4ba0892727a60fa5081 Mon Sep 17 00:00:00 2001
From: Naseem <naseem@transit.app>
Date: Thu, 27 Aug 2020 23:18:27 -0400
Subject: [PATCH] fix: add typedoc for getDbStatement

Signed-off-by: Naseem <naseem@transit.app>
---
 plugins/node/opentelemetry-plugin-mysql/src/utils.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/plugins/node/opentelemetry-plugin-mysql/src/utils.ts b/plugins/node/opentelemetry-plugin-mysql/src/utils.ts
index c93cb849d6..81cd5b50fe 100644
--- a/plugins/node/opentelemetry-plugin-mysql/src/utils.ts
+++ b/plugins/node/opentelemetry-plugin-mysql/src/utils.ts
@@ -69,6 +69,11 @@ function getJDBCString(
   return jdbcString;
 }
 
+/**
+ * Conjures up the value for the db.statement attribute by formatting a SQL query.
+ *
+ * @returns the database statement being executed.
+ */
 export function getDbStatement(
   query: string | Query | QueryOptions,
   format: Function,