Add optimization flags to debug functions

Nikita Glukhov · Nikita Glukhov · commit b2248ec22a22 · 2019-05-08T15:53:07.000+03:00
diff --git a/jsonb_gin_ops.c b/jsonb_gin_ops.c
@@ -765,37 +765,76 @@ gin_extract_jsonb_value_path(PG_FUNCTION_ARGS)
 	PG_RETURN_POINTER(gin_extract_jsonb_value_path_internal(jb, nentries, NULL));
 }
 
-Datum
-gin_debug_query_value_path(PG_FUNCTION_ARGS)
+static text *
+gin_debug_query_internal(FunctionCallInfo fcinfo,
+						 MakeEntryHandler makeHandler,
+						 CheckEntryHandler checkHandler, Pointer extra)
 {
-	JsQuery	   *jq;
-	Entries		e = {0};
+	JsQuery	   *jq = PG_GETARG_JSQUERY(0);
 	ExtractedNode *root;
 	char	   *s;
+	int			optimize = 0;
+
+	if (PG_GETARG_BOOL(1))
+		optimize |= optFlatten;
+	if (PG_GETARG_BOOL(2))
+		optimize |= optSimplify;
+	if (PG_GETARG_BOOL(3))
+		optimize |= optSelectivity;
 
-	jq = PG_GETARG_JSQUERY(0);
-	root = extractJsQuery(jq, make_value_path_entry_handler,
-							check_value_path_entry_handler, (Pointer)&e);
+	root = extractJsQuery(jq, optimize, makeHandler, checkHandler, extra);
 	s = debugExtractedQuery(root);
 
-	PG_RETURN_TEXT_P(cstring_to_text(s));
+	return cstring_to_text(s);
 }
 
-#ifndef NO_JSONPATH
 Datum
-gin_debug_jsonpath_value_path(PG_FUNCTION_ARGS)
+gin_debug_query_value_path(PG_FUNCTION_ARGS)
 {
-	JsonPath   *jp;
 	Entries		e = {0};
+
+	PG_RETURN_TEXT_P(gin_debug_query_internal(fcinfo,
+											  make_value_path_entry_handler,
+											  check_value_path_entry_handler,
+											  (Pointer) &e));
+}
+
+#ifndef NO_JSONPATH
+static text *
+gin_debug_jsonpath_internal(FunctionCallInfo fcinfo,
+							bool arrayPathItems,
+							MakeEntryHandler makeHandler,
+							CheckEntryHandler checkHandler, Pointer extra)
+{
+	JsonPath   *jp = PG_GETARG_JSONPATH_P(0);
 	ExtractedNode *root;
 	char	   *s;
-
-	jp = PG_GETARG_JSONPATH_P(0);
-	root = extractJsonPath(jp, false, false, make_value_path_entry_handler,
-						   check_value_path_entry_handler, (Pointer)&e);
+	int			optimize = 0;
+	bool		exists = PG_GETARG_BOOL(1);
+
+	if (PG_GETARG_BOOL(2))
+		optimize |= optFlatten;
+	if (PG_GETARG_BOOL(3))
+		optimize |= optSimplify;
+	if (PG_GETARG_BOOL(4))
+		optimize |= optSelectivity;
+
+	root = extractJsonPath(jp, exists, arrayPathItems, optimize,
+						   makeHandler, checkHandler, extra);
 	s = debugExtractedQuery(root);
 
-	PG_RETURN_TEXT_P(cstring_to_text(s));
+	return cstring_to_text(s);
+}
+
+Datum
+gin_debug_jsonpath_value_path(PG_FUNCTION_ARGS)
+{
+	Entries		e = {0};
+
+	PG_RETURN_TEXT_P(gin_debug_jsonpath_internal(fcinfo, false,
+												 make_value_path_entry_handler,
+												 check_value_path_entry_handler,
+												 (Pointer) &e));
 }
 #endif
 
@@ -843,12 +882,14 @@ gin_extract_jsonb_query_value_path(PG_FUNCTION_ARGS)
 				root = extractJsonPath(PG_GETARG_JSONPATH_P(0),
 									   strategy == JsonpathExistsStrategyNumber,
 									   false,
+									   optAll,
 									   make_value_path_entry_handler,
 									   check_value_path_entry_handler,
 									   (Pointer)&e);
 			else
 #endif
 				root = extractJsQuery(PG_GETARG_JSQUERY(0),
+									  optAll,
 									  make_value_path_entry_handler,
 									  check_value_path_entry_handler,
 									  (Pointer)&e);
@@ -1257,21 +1298,16 @@ gin_extract_jsonb_laxpath_value(PG_FUNCTION_ARGS)
 static Datum
 gin_debug_query_path_value_internal(FunctionCallInfo fcinfo, bool lax)
 {
-	JsQuery	   *jq;
 	Entries		e = {0};
 	PathValueExtra extra;
-	ExtractedNode *root;
-	char	   *s;
 
 	extra.entries = &e;
 	extra.lax = lax;
 
-	jq = PG_GETARG_JSQUERY(0);
-	root = extractJsQuery(jq, make_path_value_entry_handler,
-						  check_path_value_entry_handler, (Pointer) &extra);
-	s = debugExtractedQuery(root);
-
-	PG_RETURN_TEXT_P(cstring_to_text(s));
+	PG_RETURN_TEXT_P(gin_debug_query_internal(fcinfo,
+											  make_path_value_entry_handler,
+											  check_path_value_entry_handler,
+											  (Pointer) &extra));
 }
 
 Datum
@@ -1287,38 +1323,31 @@ gin_debug_query_laxpath_value(PG_FUNCTION_ARGS)
 }
 
 #ifndef NO_JSONPATH
-static Datum
+static text *
 gin_debug_jsonpath_path_value_internal(FunctionCallInfo fcinfo, bool lax)
 {
-	JsonPath   *jp;
 	Entries		e = {0};
 	PathValueExtra extra;
-	ExtractedNode *root;
-	char	   *s;
 
 	extra.entries = &e;
 	extra.lax = lax;
 
-	jp = PG_GETARG_JSONPATH_P(0);
-	root = extractJsonPath(jp, false, !lax,
-						   make_path_value_entry_handler,
-						   check_path_value_entry_handler,
-						   (Pointer) &extra);
-	s = debugExtractedQuery(root);
-
-	PG_RETURN_TEXT_P(cstring_to_text(s));
+	return gin_debug_jsonpath_internal(fcinfo, !lax,
+									   make_path_value_entry_handler,
+									   check_path_value_entry_handler,
+									   (Pointer) &extra);
 }
 
 Datum
 gin_debug_jsonpath_path_value(PG_FUNCTION_ARGS)
 {
-	PG_RETURN_DATUM(gin_debug_jsonpath_path_value_internal(fcinfo, false));
+	PG_RETURN_TEXT_P(gin_debug_jsonpath_path_value_internal(fcinfo, false));
 }
 
 Datum
 gin_debug_jsonpath_laxpath_value(PG_FUNCTION_ARGS)
 {
-	PG_RETURN_DATUM(gin_debug_jsonpath_path_value_internal(fcinfo, true));
+	PG_RETURN_TEXT_P(gin_debug_jsonpath_path_value_internal(fcinfo, true));
 }
 #endif
 
@@ -1355,12 +1384,14 @@ gin_extract_jsonb_query_path_value_internal(FunctionCallInfo fcinfo, bool lax)
 				root = extractJsonPath(PG_GETARG_JSONPATH_P(0),
 									   strategy == JsonpathExistsStrategyNumber,
 									   !lax,
+									   optAll,
 									   make_path_value_entry_handler,
 									   check_path_value_entry_handler,
 									   (Pointer) &extra);
 			else
 #endif
 				root = extractJsQuery(PG_GETARG_JSQUERY(0),
+									  optAll,
 									  make_path_value_entry_handler,
 									  check_path_value_entry_handler,
 									  (Pointer) &extra);
diff --git a/jsquery--1.1.sql b/jsquery--1.1.sql
@@ -315,17 +315,17 @@ CREATE OPERATOR CLASS jsonb_laxpath_value_ops
 	FUNCTION 6  gin_triconsistent_jsonb_path_value(internal, smallint, anyarray, integer, internal, internal, internal),
 	STORAGE bytea;
 
-CREATE OR REPLACE FUNCTION gin_debug_query_value_path(jsquery)
+CREATE OR REPLACE FUNCTION gin_debug_query_value_path(jsquery, flatten bool = true, simplify bool = true, selectivity bool = true)
 	RETURNS text
 	AS 'MODULE_PATHNAME'
 	LANGUAGE C STRICT IMMUTABLE;
 
-CREATE OR REPLACE FUNCTION gin_debug_query_path_value(jsquery)
+CREATE OR REPLACE FUNCTION gin_debug_query_path_value(jsquery, flatten bool = true, simplify bool = true, selectivity bool = true)
 	RETURNS text
 	AS 'MODULE_PATHNAME'
 	LANGUAGE C STRICT IMMUTABLE;
 
-CREATE OR REPLACE FUNCTION gin_debug_query_laxpath_value(jsquery)
+CREATE OR REPLACE FUNCTION gin_debug_query_laxpath_value(jsquery, flatten bool = true, simplify bool = true, selectivity bool = true)
 	RETURNS text
 	AS 'MODULE_PATHNAME'
 	LANGUAGE C STRICT IMMUTABLE;
@@ -357,17 +357,17 @@ BEGIN
 		ALTER OPERATOR FAMILY jsonb_value_path_ops USING gin
 			ADD OPERATOR 16 @@ (jsonb, jsonpath);
 
-		CREATE OR REPLACE FUNCTION gin_debug_jsonpath_value_path(jsonpath)
+		CREATE OR REPLACE FUNCTION gin_debug_jsonpath_value_path(jsonpath, is_exists bool = false, flatten bool = true, simplify bool = true, selectivity bool = true)
 			RETURNS text
 			AS 'MODULE_PATHNAME'
 			LANGUAGE C STRICT IMMUTABLE;
 
-		CREATE OR REPLACE FUNCTION gin_debug_jsonpath_path_value(jsonpath)
+		CREATE OR REPLACE FUNCTION gin_debug_jsonpath_path_value(jsonpath, is_exists bool = false, flatten bool = true, simplify bool = true, selectivity bool = true)
 			RETURNS text
 			AS 'MODULE_PATHNAME'
 			LANGUAGE C STRICT IMMUTABLE;
 
-		CREATE OR REPLACE FUNCTION gin_debug_jsonpath_laxpath_value(jsonpath)
+		CREATE OR REPLACE FUNCTION gin_debug_jsonpath_laxpath_value(jsonpath, is_exists bool = false, flatten bool = true, simplify bool = true, selectivity bool = true)
 			RETURNS text
 			AS 'MODULE_PATHNAME'
 			LANGUAGE C STRICT IMMUTABLE;
diff --git a/jsquery.h b/jsquery.h
@@ -242,10 +242,20 @@ typedef int (*MakeEntryHandler)(ExtractedNode *node, Pointer extra);
 typedef bool (*CheckEntryHandler)(ExtractedNode *node, Pointer extra);
 bool isLogicalNodeType(ExtractedNodeType type);
 
-ExtractedNode *extractJsQuery(JsQuery *jq, MakeEntryHandler makeHandler,
+typedef enum
+{
+	optFlatten =		0x01,
+	optSimplify =		0x02,
+	optSelectivity =	0x04,
+	optAll =			0x07
+} JsQueryOptFlags;
+
+ExtractedNode *extractJsQuery(JsQuery *jq, int optimize,
+								MakeEntryHandler makeHandler,
 								CheckEntryHandler checkHandler, Pointer extra);
 #ifndef NO_JSONPATH
 ExtractedNode *extractJsonPath(JsonPath *jp, bool exists, bool arrayPathItems,
+							   int optimize,
 							   MakeEntryHandler makeHandler,
 							   CheckEntryHandler checkHandler, Pointer extra);
 #endif
diff --git a/jsquery_extract.c b/jsquery_extract.c
@@ -33,7 +33,7 @@ static int compareJsQueryItem(JsQueryItem *v1, JsQueryItem *v2);
 static void processGroup(ExtractedNode *node, int start, int end);
 static void simplifyRecursive(ExtractedNode *node);
 static SelectivityClass getScalarSelectivityClass(ExtractedNode *node);
-static ExtractedNode *makeEntries(ExtractedNode *node, MakeEntryHandler handler, Pointer extra);
+static ExtractedNode *makeEntries(ExtractedNode *node, bool skipNonSelective, MakeEntryHandler handler, Pointer extra);
 static void setSelectivityClass(ExtractedNode *node, CheckEntryHandler checkHandler, Pointer extra);
 static void debugPath(StringInfo buf, PathItem *path);
 static void debugValue(StringInfo buf, JsQueryItem *v);
@@ -1204,7 +1204,8 @@ getScalarSelectivityClass(ExtractedNode *node)
  * Make entries for all leaf tree nodes using user-provided handler.
  */
 static ExtractedNode *
-makeEntries(ExtractedNode *node, MakeEntryHandler handler, Pointer extra)
+makeEntries(ExtractedNode *node, bool skipNonSelective,
+			MakeEntryHandler handler, Pointer extra)
 {
 	if (node->type == eAnd || node->type == eOr)
 	{
@@ -1216,11 +1217,12 @@ makeEntries(ExtractedNode *node, MakeEntryHandler handler, Pointer extra)
 			if (!child)
 				continue;
 			/* Skip non-selective AND children */
-			if (child->sClass > node->sClass &&
+			if (skipNonSelective &&
+				child->sClass > node->sClass &&
 				node->type == eAnd &&
 				!child->forceIndex)
 				continue;
-			child = makeEntries(child, handler, extra);
+			child = makeEntries(child, skipNonSelective, handler, extra);
 			if (child)
 			{
 				node->args.items[j] = child;
@@ -1319,34 +1321,48 @@ setSelectivityClass(ExtractedNode *node, CheckEntryHandler checkHandler,
 	}
 }
 
+static ExtractedNode *
+emitExtractedQuery(ExtractedNode *root, int optimize,
+				   MakeEntryHandler makeHandler,
+				   CheckEntryHandler checkHandler,
+				   Pointer extra)
+{
+	if (!root)
+		return NULL;
+
+	if (optimize & optFlatten)
+		flatternTree(root);
+
+	if (optimize & optSimplify)
+		simplifyRecursive(root);
+
+	setSelectivityClass(root, checkHandler, extra);
+
+	return makeEntries(root, (optimize & optSelectivity) != 0, makeHandler, extra);
+}
+
 /*
  * Turn jsquery into tree of entries using user-provided handler.
  */
 ExtractedNode *
-extractJsQuery(JsQuery *jq, MakeEntryHandler makeHandler,
-								CheckEntryHandler checkHandler, Pointer extra)
+extractJsQuery(JsQuery *jq, int optimize, MakeEntryHandler makeHandler,
+			   CheckEntryHandler checkHandler, Pointer extra)
 {
 	ExtractedNode	*root;
 	JsQueryItem		jsq;
 
 	jsqInit(&jsq, jq);
 	root = recursiveExtract(&jsq, false, false, NULL);
-	if (root)
-	{
-		flatternTree(root);
-		simplifyRecursive(root);
-		setSelectivityClass(root, checkHandler, extra);
-		root = makeEntries(root, makeHandler, extra);
-	}
-	return root;
+
+	return emitExtractedQuery(root, optimize, makeHandler, checkHandler, extra);
 }
 
 #ifndef NO_JSONPATH
 /*
  * Turn jsonpath into tree of entries using user-provided handler.
  */
 ExtractedNode *
-extractJsonPath(JsonPath *jp, bool exists, bool arrayPathItems,
+extractJsonPath(JsonPath *jp, bool exists, bool arrayPathItems, int optimize,
 				MakeEntryHandler makeHandler,
 				CheckEntryHandler checkHandler, Pointer extra)
 {
@@ -1358,14 +1374,8 @@ extractJsonPath(JsonPath *jp, bool exists, bool arrayPathItems,
 	root = exists
 		? extractJsonPathExists(&jsp, lax, NULL)
 		: recursiveExtractJsonPathExpr(&jsp, lax, false, NULL);
-	if (root)
-	{
-		flatternTree(root);
-		simplifyRecursive(root);
-		setSelectivityClass(root, checkHandler, extra);
-		root = makeEntries(root, makeHandler, extra);
-	}
-	return root;
+
+	return emitExtractedQuery(root, optimize, makeHandler, checkHandler, extra);
 }
 #endif
 
