v6 of bt_page_items pretty-print

Author: reshke

contrib/pageinspect/Makefile

@@ -13,7 +13,7 @@ OBJS = \
 	rawpage.o
 
 EXTENSION = pageinspect
-DATA =  pageinspect--1.8--1.9.sql \
+DATA = pageinspect--1.9--1.10.sql pageinspect--1.8--1.9.sql \
 	pageinspect--1.7--1.8.sql pageinspect--1.6--1.7.sql \
 	pageinspect--1.5.sql pageinspect--1.5--1.6.sql \
 	pageinspect--1.4--1.5.sql pageinspect--1.3--1.4.sql \

contrib/pageinspect/btreefuncs.c

@@ -29,6 +29,7 @@
 
 #include "access/nbtree.h"
 #include "access/relation.h"
+#include "access/tupdesc.h"
 #include "catalog/namespace.h"
 #include "catalog/pg_am.h"
 #include "catalog/pg_type.h"
@@ -38,6 +39,8 @@
 #include "utils/array.h"
 #include "utils/builtins.h"
 #include "utils/rel.h"
+#include "utils/ruleutils.h"
+#include "utils/lsyscache.h"
 #include "utils/varlena.h"
 
 PG_FUNCTION_INFO_V1(bt_metap);
@@ -294,6 +297,8 @@ struct user_args
 	bool		leafpage;
 	bool		rightmost;
 	TupleDesc	tupd;
+	Relation	indexRel;
+	bool		pretty_print;
 };
 
 /*-------------------------------------------------------
@@ -372,17 +377,118 @@ bt_page_print_tuples(struct user_args *uargs)
 	if (dlen < 0 || dlen > INDEX_SIZE_MASK)
 		elog(ERROR, "invalid tuple length %d for tuple at offset number %u",
 			 dlen, offset);
-	dump = palloc0(dlen * 3 + 1);
-	datacstring = dump;
-	for (off = 0; off < dlen; off++)
+
+	if (!uargs->pretty_print)
 	{
-		if (off > 0)
-			*dump++ = ' ';
-		sprintf(dump, "%02x", *(ptr + off) & 0xff);
-		dump += 2;
+		/* Old-style, print hex bytes */
+		dump = palloc0(dlen * 3 + 1);
+		datacstring = dump;
+		for (off = 0; off < dlen; off++)
+		{
+			if (off > 0)
+				*dump++ = ' ';
+			sprintf(dump, "%02x", *(ptr + off) & 0xff);
+			dump += 2;
+		}
+		values[j++] = CStringGetTextDatum(datacstring);
+		pfree(datacstring);
+	}
+	else
+	{
+		/* Do pretty-print, akin to record_out() */
+		StringInfoData buf;
+		TupleDesc tupdesc;
+
+		Datum		itup_values[INDEX_MAX_KEYS];
+		bool		itup_isnull[INDEX_MAX_KEYS];
+		char		*index_columns;
+
+		/*
+		* Included attributes are added when dealing with leaf pages, discarded
+		* for non-leaf pages as these include only data for key attributes.
+		*/
+		int printflags = RULE_INDEXDEF_PRETTY;
+		if (P_ISLEAF((BTPageOpaque) PageGetSpecialPointer(page)))
+		{
+			tupdesc = RelationGetDescr(uargs->indexRel);
+		}
+		else
+		{
+			tupdesc = CreateTupleDescCopy(RelationGetDescr(uargs->indexRel));
+			tupdesc->natts = IndexRelationGetNumberOfKeyAttributes(uargs->indexRel);
+			printflags |= RULE_INDEXDEF_KEYS_ONLY;
+		}
+
+		index_columns = pg_get_indexdef_columns_extended(RelationGetRelid(uargs->indexRel),
+														printflags);
+
+
+		index_deform_tuple(itup, tupdesc,
+						   itup_values, itup_isnull);
+
+
+		initStringInfo(&buf);
+		appendStringInfo(&buf, "(%s)=(", index_columns);
+
+		for (int i = 0; i < tupdesc->natts; i++)
+		{
+			char	   *value;
+			char	   *tmp;
+			bool		nq = false;
+
+			if (itup_isnull[i])
+				value = "null";
+			else
+			{
+				Oid			foutoid;
+				bool		typisvarlena;
+				Oid			typoid;
+
+				typoid = TupleDescAttr(tupdesc, i)->atttypid;
+				getTypeOutputInfo(typoid, &foutoid, &typisvarlena);
+				value = OidOutputFunctionCall(foutoid, itup_values[i]);
+			}
+
+			if (i == IndexRelationGetNumberOfKeyAttributes(uargs->indexRel))
+				appendStringInfoString(&buf, ") INCLUDE (");
+			else if (i > 0)
+				appendStringInfoString(&buf, ", ");
+
+			/* Check whether we need double quotes for this value */
+			nq = (value[0] == '\0');	/* force quotes for empty string */
+			for (tmp = value; *tmp; tmp++)
+			{
+				char		ch = *tmp;
+
+				if (ch == '"' || ch == '\\' ||
+					ch == '(' || ch == ')' || ch == ',' ||
+					isspace((unsigned char) ch))
+				{
+					nq = true;
+					break;
+				}
+			}
+
+			/* And emit the string */
+			if (nq)
+				appendStringInfoCharMacro(&buf, '"');
+			for (tmp = value; *tmp; tmp++)
+			{
+				char		ch = *tmp;
+
+				if (ch == '"' || ch == '\\')
+					appendStringInfoCharMacro(&buf, ch);
+				appendStringInfoCharMacro(&buf, ch);
+			}
+			if (nq)
+				appendStringInfoCharMacro(&buf, '"');
+		}
+
+		appendStringInfoChar(&buf, ')');
+
+		values[j++] = CStringGetTextDatum(buf.data);
+		pfree(buf.data);
 	}
-	values[j++] = CStringGetTextDatum(datacstring);
-	pfree(datacstring);
 
 	/*
 	 * We need to work around the BTreeTupleIsPivot() !heapkeyspace limitation
@@ -458,6 +564,11 @@ bt_page_items_internal(PG_FUNCTION_ARGS, enum pageinspect_version ext_version)
 	FuncCallContext *fctx;
 	MemoryContext mctx;
 	struct user_args *uargs;
+	bool		pretty_print = false;
+
+	if (PG_NARGS() >= 3) {
+		pretty_print = PG_GETARG_BOOL(2);
+	}
 
 	if (!superuser())
 		ereport(ERROR,
@@ -521,7 +632,6 @@ bt_page_items_internal(PG_FUNCTION_ARGS, enum pageinspect_version ext_version)
 		memcpy(uargs->page, BufferGetPage(buffer), BLCKSZ);
 
 		UnlockReleaseBuffer(buffer);
-		relation_close(rel, AccessShareLock);
 
 		uargs->offset = FirstOffsetNumber;
 
@@ -537,6 +647,8 @@ bt_page_items_internal(PG_FUNCTION_ARGS, enum pageinspect_version ext_version)
 		}
 		uargs->leafpage = P_ISLEAF(opaque);
 		uargs->rightmost = P_RIGHTMOST(opaque);
+		uargs->pretty_print = pretty_print;
+		uargs->indexRel = rel;
 
 		/* Build a tuple descriptor for our result type */
 		if (get_call_result_type(fcinfo, NULL, &tupleDesc) != TYPEFUNC_COMPOSITE)
@@ -560,6 +672,9 @@ bt_page_items_internal(PG_FUNCTION_ARGS, enum pageinspect_version ext_version)
 		SRF_RETURN_NEXT(fctx, result);
 	}
 
+	if (uargs->indexRel)
+		relation_close(uargs->indexRel, AccessShareLock);
+
 	SRF_RETURN_DONE(fctx);
 }
 
@@ -654,6 +769,10 @@ bt_page_items_bytea(PG_FUNCTION_ARGS)
 		uargs->leafpage = P_ISLEAF(opaque);
 		uargs->rightmost = P_RIGHTMOST(opaque);
 
+		uargs->pretty_print = false;
+		/* For bytea function, we cannot do pretty-print */
+		uargs->indexRel = NULL;
+
 		/* Build a tuple descriptor for our result type */
 		if (get_call_result_type(fcinfo, NULL, &tupleDesc) != TYPEFUNC_COMPOSITE)
 			elog(ERROR, "return type must be a row type");
@@ -676,6 +795,9 @@ bt_page_items_bytea(PG_FUNCTION_ARGS)
 		SRF_RETURN_NEXT(fctx, result);
 	}
 
+	if (uargs->indexRel)
+		relation_close(uargs->indexRel, AccessShareLock);
+
 	SRF_RETURN_DONE(fctx);
 }
 

contrib/pageinspect/expected/btree.out

@@ -1,6 +1,7 @@
 CREATE TABLE test1 (a int8, b int4range);
 INSERT INTO test1 VALUES (72057594037927937, '[0,1)');
 CREATE INDEX test1_a_idx ON test1 USING btree (a);
+CREATE INDEX test1_a_b_idx ON test1 USING btree (a, b);
 \x
 SELECT * FROM bt_metap('test1_a_idx');
 -[ RECORD 1 ]-------------+-------
@@ -34,6 +35,30 @@ btpo_flags    | 3
 
 SELECT * FROM bt_page_stats('test1_a_idx', 2);
 ERROR:  block number out of range
+SELECT * FROM bt_page_items('test1_a_idx', 1, true);
+-[ RECORD 1 ]-----------------------
+itemoffset | 1
+ctid       | (0,1)
+itemlen    | 16
+nulls      | f
+vars       | f
+data       | (a)=(72057594037927937)
+dead       | f
+htid       | (0,1)
+tids       | 
+
+SELECT * FROM bt_page_items('test1_a_b_idx', 1, true);
+-[ RECORD 1 ]-----------------------------------
+itemoffset | 1
+ctid       | (0,1)
+itemlen    | 32
+nulls      | f
+vars       | t
+data       | (a, b)=(72057594037927937, "[0,1)")
+dead       | f
+htid       | (0,1)
+tids       | 
+
 SELECT * FROM bt_page_items('test1_a_idx', -1);
 ERROR:  invalid block number
 SELECT * FROM bt_page_items('test1_a_idx', 0);

contrib/pageinspect/pageinspect--1.9--1.10.sql

@@ -0,0 +1,17 @@
+
+
+DROP FUNCTION bt_page_items(text, int8);
+CREATE FUNCTION bt_page_items(IN relname text, IN blkno int8,
+    IN pretty_print boolean DEFAULT FALSE,
+    OUT itemoffset smallint,
+    OUT ctid tid,
+    OUT itemlen smallint,
+    OUT nulls bool,
+    OUT vars bool,
+    OUT data text,
+    OUT dead boolean,
+    OUT htid tid,
+    OUT tids tid[])
+RETURNS SETOF record
+AS 'MODULE_PATHNAME', 'bt_page_items_1_9'
+LANGUAGE C STRICT PARALLEL SAFE;

contrib/pageinspect/pageinspect.control

@@ -1,5 +1,5 @@
 # pageinspect extension
 comment = 'inspect the contents of database pages at a low level'
-default_version = '1.9'
+default_version = '1.10'
 module_pathname = '$libdir/pageinspect'
 relocatable = true

contrib/pageinspect/sql/btree.sql

@@ -1,6 +1,7 @@
 CREATE TABLE test1 (a int8, b int4range);
 INSERT INTO test1 VALUES (72057594037927937, '[0,1)');
 CREATE INDEX test1_a_idx ON test1 USING btree (a);
+CREATE INDEX test1_a_b_idx ON test1 USING btree (a, b);
 
 \x
 
@@ -11,6 +12,9 @@ SELECT * FROM bt_page_stats('test1_a_idx', 0);
 SELECT * FROM bt_page_stats('test1_a_idx', 1);
 SELECT * FROM bt_page_stats('test1_a_idx', 2);
 
+SELECT * FROM bt_page_items('test1_a_idx', 1, true);
+SELECT * FROM bt_page_items('test1_a_b_idx', 1, true);
+
 SELECT * FROM bt_page_items('test1_a_idx', -1);
 SELECT * FROM bt_page_items('test1_a_idx', 0);
 SELECT * FROM bt_page_items('test1_a_idx', 1);