QueryOpt_preview label

tigergraph · Apr 22, 2024 · e17a651 · e17a651
1 parent a2ca858
commit e17a651
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/modules/querying/pages/query-optimizer/enable-cost-optimizer.adoc b/modules/querying/pages/query-optimizer/enable-cost-optimizer.adoc
@@ -1,9 +1,16 @@
-= Enabling Cost-Based Optimization
+= Enabling Cost-Based Optimization (Preview Feature)
 :sectnums:
 :description: Steps to enable the query optimizer.
 
 This page walks you through the steps to enable cost-based optimization.
 
+[IMPORTANT]
+====
+Query Optimizer is currently a Preview Feature. Preview Features give users an early look at future production-level features.
+
+Preview Features should not be used for production deployments.
+====
+
 == Before you begin
 * You have created a query that contains a xref:select-statement/index.adoc[`SELECT` statement] that uses a xref:select-statement/index.adoc#_path_pattern[path pattern] in its `FROM` clause with one or more hops.
 * You have the privilege to install queries on the graph where you are operating.

diff --git a/modules/querying/pages/query-optimizer/index.adoc b/modules/querying/pages/query-optimizer/index.adoc
@@ -1,4 +1,4 @@
-= Query Optimizer
+= Query Optimizer (Preview Feature)
 :description: Overview of the query optimizer.
 
 The query optimizer optimizes the execution plan of a query.
@@ -7,6 +7,13 @@ When writing a GSQL query with multi-hop `SELECT` statements, the xref:querying:
 In other words, it specifies the structure of paths to be matched, without specifying the particulars of how the graph is traversed to find these paths.
 It is the query optimizer's job to determine the best graph traversal plan to satisfy the query.
 
+[IMPORTANT]
+====
+Query Optimizer is currently a Preview Feature. Preview Features give users an early look at future production-level features.
+
+Preview Features should not be used for production deployments.
+====
+
 == Heuristics-based optimization
 
 By default, the query optimizer chooses traversal plans based on heuristics.

diff --git a/modules/querying/pages/query-optimizer/stats-api.adoc b/modules/querying/pages/query-optimizer/stats-api.adoc
@@ -1,8 +1,15 @@
-= Statistics REST APIs
+= Statistics REST APIs (Preview Feature)
 
 The endpoints on this page calculate cardinality and histogram statistics of vertex and edge types and attributes.
 The statistics are required for effective optimization.
 
+[IMPORTANT]
+====
+Query Optimizer is currently a Preview Feature. Preview Features give users an early look at future production-level features.
+
+Preview Features should not be used for production deployments.
+====
+
 == Cardinality
 
 The following endpoints compute, fetch and delete vertex and edge counts (cardinality) of a graph.