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

* add link on how to enable explain on the explain() method * Update src/PostgrestTransformBuilder.ts Co-authored-by: Tyler <[email protected]> * keep docs link --------- Co-authored-by: Bobbie Soedirgo <[email protected]>
supabase · Jan 2, 2024 · 197b4d2 · 197b4d2
1 parent f91aa29
commit 197b4d2
Showing 1 changed file with 4 additions and 0 deletions.
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