Skip to content

Commit e17a651

Browse files
Joseph NewmanJoseph Newman
Joseph Newman
authored and
Joseph Newman
committed
QueryOpt_preview label
1 parent a2ca858 commit e17a651

File tree

3 files changed

+24
-3
lines changed

3 files changed

+24
-3
lines changed

modules/querying/pages/query-optimizer/enable-cost-optimizer.adoc

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1-
= Enabling Cost-Based Optimization
1+
= Enabling Cost-Based Optimization (Preview Feature)
22
:sectnums:
33
:description: Steps to enable the query optimizer.
44

55
This page walks you through the steps to enable cost-based optimization.
66

7+
[IMPORTANT]
8+
====
9+
Query Optimizer is currently a Preview Feature. Preview Features give users an early look at future production-level features.
10+
11+
Preview Features should not be used for production deployments.
12+
====
13+
714
== Before you begin
815
* 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.
916
* You have the privilege to install queries on the graph where you are operating.

modules/querying/pages/query-optimizer/index.adoc

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Query Optimizer
1+
= Query Optimizer (Preview Feature)
22
:description: Overview of the query optimizer.
33

44
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:
77
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.
88
It is the query optimizer's job to determine the best graph traversal plan to satisfy the query.
99

10+
[IMPORTANT]
11+
====
12+
Query Optimizer is currently a Preview Feature. Preview Features give users an early look at future production-level features.
13+
14+
Preview Features should not be used for production deployments.
15+
====
16+
1017
== Heuristics-based optimization
1118

1219
By default, the query optimizer chooses traversal plans based on heuristics.

modules/querying/pages/query-optimizer/stats-api.adoc

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
= Statistics REST APIs
1+
= Statistics REST APIs (Preview Feature)
22

33
The endpoints on this page calculate cardinality and histogram statistics of vertex and edge types and attributes.
44
The statistics are required for effective optimization.
55

6+
[IMPORTANT]
7+
====
8+
Query Optimizer is currently a Preview Feature. Preview Features give users an early look at future production-level features.
9+
10+
Preview Features should not be used for production deployments.
11+
====
12+
613
== Cardinality
714

815
The following endpoints compute, fetch and delete vertex and edge counts (cardinality) of a graph.

0 commit comments

Comments
 (0)