timing

Author: penberg

docs/api.md

@@ -171,6 +171,10 @@ Toggle raw mode.
 
 This function enables or disables raw mode. Prepared statements return objects by default, but if raw mode is enabled, the functions return arrays instead.
 
+### timed([toggle]) ⇒ this
+
+Toggle query duration timing.
+
 ### columns() ⇒ array of objects
 
 Returns the columns in the result set returned by this prepared statement.

index.d.ts

@@ -55,6 +55,7 @@ export declare class Statement {
   iterateSync(params?: unknown | undefined | null): RowsIterator
   pluck(pluck?: boolean | undefined | null): this
   raw(raw?: boolean | undefined | null): this
+  timed(timed?: boolean | undefined | null): this
   columns(): unknown[]
   safeIntegers(toggle?: boolean | undefined | null): this
   interrupt(): void

promise.js

@@ -240,6 +240,16 @@ class Statement {
     return this;
   }
 
+  /**
+   * Toggle query timing.
+   *
+   * @param timing Enable or disable query timing. If you don't pass the parameter, query timing is enabled.
+   */
+  timing(timingMode) {
+    this.stmt.timing(timingMode);
+    return this;
+  }
+
   get reader() {
     throw new Error("not implemented");
   }

src/lib.rs

@@ -516,6 +516,7 @@ pub struct Statement {
     safe_ints: AtomicBool,
     raw: AtomicBool,
     pluck: AtomicBool,
+    timed: AtomicBool,
 }
 
 #[napi]
@@ -539,6 +540,7 @@ impl Statement {
             safe_ints: AtomicBool::new(safe_ints),
             raw: AtomicBool::new(raw),
             pluck: AtomicBool::new(pluck),
+            timed: AtomicBool::new(false),
         }
     }
 
@@ -576,14 +578,19 @@ impl Statement {
         let safe_ints = self.safe_ints.load(Ordering::SeqCst);
         let raw = self.raw.load(Ordering::SeqCst);
         let pluck = self.pluck.load(Ordering::SeqCst);
+        let timed = self.timed.load(Ordering::SeqCst);
 
-        let start = std::time::Instant::now();
+        let start = if timed {
+            Some(std::time::Instant::now())
+        } else {
+            None
+        };
         rt.block_on(async move {
             let mut stmt = self.stmt.lock().await;
             let params = map_params(&stmt, params)?;
             let mut rows = stmt.query(params).await.map_err(Error::from)?;
             let row = rows.next().await.map_err(Error::from)?;
-            let duration = start.elapsed().as_secs_f64();
+            let duration: Option<f64> = start.map(|start| start.elapsed().as_secs_f64());
             let result = Self::get_internal(
                 &env,
                 &row,
@@ -605,7 +612,7 @@ impl Statement {
         safe_ints: bool,
         raw: bool,
         pluck: bool,
-        duration: f64,
+        duration: Option<f64>,
     ) -> Result<napi::JsUnknown> {
         match row {
             Some(row) => {
@@ -616,10 +623,12 @@ impl Statement {
                     let mut js_object =
                         map_row_object(&env, &column_names, &row, safe_ints, pluck)?
                             .coerce_to_object()?;
-                    let mut metadata = env.create_object()?;
-                    let js_duration = env.create_double(duration)?;
-                    metadata.set_named_property("duration", js_duration)?;
-                    js_object.set_named_property("_metadata", metadata)?;
+                    if let Some(duration) = duration {
+                        let mut metadata = env.create_object()?;
+                        let js_duration = env.create_double(duration)?;
+                        metadata.set_named_property("duration", js_duration)?;
+                        js_object.set_named_property("_metadata", metadata)?;
+                    }
                     Ok(js_object.into_unknown())
                 }
             }
@@ -691,12 +700,6 @@ impl Statement {
         ))
     }
 
-    #[napi]
-    pub fn pluck(&self, pluck: Option<bool>) -> Result<&Self> {
-        self.pluck.store(pluck.unwrap_or(true), Ordering::SeqCst);
-        Ok(self)
-    }
-
     #[napi]
     pub fn raw(&self, raw: Option<bool>) -> Result<&Self> {
         let rt = runtime()?;
@@ -713,6 +716,18 @@ impl Statement {
         Ok(self)
     }
 
+    #[napi]
+    pub fn pluck(&self, pluck: Option<bool>) -> Result<&Self> {
+        self.pluck.store(pluck.unwrap_or(true), Ordering::SeqCst);
+        Ok(self)
+    }
+
+    #[napi]
+    pub fn timing(&self, timed: Option<bool>) -> Result<&Self> {
+        self.timed.store(timed.unwrap_or(true), Ordering::SeqCst);
+        Ok(self)
+    }
+
     #[napi]
     pub fn columns(&self, env: Env) -> Result<Array> {
         let rt = runtime()?;

wrapper.js

@@ -244,6 +244,16 @@ class Statement {
     return this;
   }
 
+  /**
+   * Toggle query timing.
+   *
+   * @param timing Enable or disable query timing. If you don't pass the parameter, query timing is enabled.
+   */
+  timing(timingMode) {
+    this.stmt.timing(timingMode);
+    return this;
+  }
+
   get reader() {
     throw new Error("not implemented");
   }