change property name

Author: bogdantruta-firebolt

README.md

@@ -196,13 +196,15 @@ type ClientCredentialsAuth = {
   client_secret: string;
 };
 
+type PreparedStatementParamStyle = "native" | "fb_numeric";
+
 type ConnectionOptions = {
   auth: AccessTokenAuth | ServiceAccountAuth;
   database: string;
   engineName?: string;
   engineEndpoint?: string;
   account?: string;
-  useServerSidePreparedStatement?: boolean;
+  preparedStatementParamStyle?: PreparedStatementParamStyle;
 };
 ```
 
@@ -263,7 +265,7 @@ const connection = await firebolt.connect({
 <a id="serverSidePreparedStatementConnectionOption"></a>
 #### Server-side prepared statement
 Driver has the option to use server-side prepared statements, so all parameters are set on the server side, preventing SQL injection attacks.
-This behavior can be enabled by setting `useServerSidePreparedStatement` to `true` in the connection options, otherwise, prepared statements will retain default behavior and queries will be formatted client side.
+This behavior can be enabled by setting `preparedStatementParamStyle` to `fb_numeric` in the connection options, otherwise, prepared statements will retain default behavior(same behavior if value is set to `native`) and queries will be formatted client side.
 ```typescript
 const connection = await firebolt.connect({
   auth: {
@@ -273,7 +275,7 @@ const connection = await firebolt.connect({
   engineName: 'engine_name',
   account: 'account_name',
   database: 'database',
-  useServerSidePreparedStatement: true
+  preparedStatementParamStyle: 'fb_numeric'
 });
 ```
 

src/connection/connection_v2.ts

@@ -129,7 +129,7 @@ export class ConnectionV2 extends BaseConnection {
     query: string,
     executeQueryOptions: ExecuteQueryOptions = {}
   ): Promise<Statement> {
-    if (this.options.useServerSidePreparedStatement) {
+    if (this.options.preparedStatementParamStyle === "fb_numeric") {
       return this.executePreparedStatement(query, executeQueryOptions);
     }
     return super.execute(query, executeQueryOptions);

src/types.ts

@@ -84,6 +84,8 @@ export type ServiceAccountAuth = {
 
 export type AuthOptions = UsernamePasswordAuth | ServiceAccountAuth;
 
+export type PreparedStatementParamStyle = "native" | "fb_numeric";
+
 export type ConnectionOptions = {
   database?: string;
   engineName?: string;
@@ -92,7 +94,7 @@ export type ConnectionOptions = {
   account?: string;
   auth: AuthOptions;
   useCache?: boolean;
-  useServerSidePreparedStatement?: boolean;
+  preparedStatementParamStyle?: PreparedStatementParamStyle;
 };
 
 export type FireboltClientOptions = {

test/integration/v2/preparedStatement.test.ts

@@ -1,15 +1,16 @@
 import BigNumber from "bignumber.js";
-import { Firebolt } from "../../../src";
+import { ConnectionOptions, Firebolt } from "../../../src";
+import { PreparedStatementParamStyle } from "../../../src/types";
 
-const connectionParams = {
+const connectionParams: ConnectionOptions = {
   auth: {
     client_id: process.env.FIREBOLT_CLIENT_ID as string,
     client_secret: process.env.FIREBOLT_CLIENT_SECRET as string
   },
-  account: process.env.FIREBOLT_ACCOUNT as string,
-  database: process.env.FIREBOLT_DATABASE as string,
-  engineName: process.env.FIREBOLT_ENGINE_NAME as string,
-  useServerSidePreparedStatement: true
+  account: process.env.FIREBOLT_ACCOUNT,
+  database: process.env.FIREBOLT_DATABASE,
+  engineName: process.env.FIREBOLT_ENGINE_NAME,
+  preparedStatementParamStyle: "fb_numeric"
 };
 
 jest.setTimeout(250000);

test/unit/v2/connection.test.ts

@@ -720,7 +720,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);
@@ -781,7 +781,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);
@@ -840,7 +840,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);
@@ -906,7 +906,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);
@@ -965,7 +965,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);
@@ -1023,7 +1023,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);
@@ -1080,7 +1080,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);
@@ -1142,7 +1142,7 @@ describe("Connection V2", () => {
         client_secret: "dummy"
       },
       account: "my_account",
-      useServerSidePreparedStatement: true
+      preparedStatementParamStyle: "fb_numeric"
     };
 
     const connection = await firebolt.connect(connectionParams);