fix: add link on how to enable explain on the explain() method (#507)

dshukertjr · soedirgo · web-flow · commit 197b4d29930d · 2024-01-02T20:30:52.000+08:00
* add link on how to enable explain on the explain() method

* Update src/PostgrestTransformBuilder.ts

Co-authored-by: Tyler &lt;dshukertjr@gmail.com&gt;

* keep docs link

---------

Co-authored-by: Bobbie Soedirgo &lt;bobbie@soedirgo.dev&gt;
diff --git a/src/PostgrestTransformBuilder.ts b/src/PostgrestTransformBuilder.ts
@@ -234,6 +234,10 @@ export default class PostgrestTransformBuilder<
   /**
    * Return `data` as the EXPLAIN plan for the query.
    *
+   * You need to enable the
+   * [db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)
+   * setting before using this method.
+   *
    * @param options - Named parameters
    *
    * @param options.analyze - If `true`, the query will be executed and the

Original file line number	Diff line number	Diff line change
`@@ -234,6 +234,10 @@ export default class PostgrestTransformBuilder<`
`234`	`234`	`/**`
`235`	`235`	* Return `data` as the EXPLAIN plan for the query.
`236`	`236`	`*`
	`237`	`+ * You need to enable the`
	`238`	`+ * [db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)`
	`239`	`+ * setting before using this method.`
	`240`	`+ *`
`237`	`241`	`* @param options - Named parameters`
`238`	`242`	`*`
`239`	`243`	* @param options.analyze - If `true`, the query will be executed and the