Move brin.c(h) files into src subdirectory

Add brin support in upgrade script

Fix some code problems

Fix test_init

Fix Indices section in the doc

Author: Vitaly Davydov

Diff for: Makefile

@@ -11,7 +11,7 @@ MODULE_big = pg_sphere
 OBJS       = src/sscan.o src/sparse.o src/sbuffer.o src/vector3d.o src/point.o \
              src/euler.o src/circle.o src/line.o src/ellipse.o src/polygon.o \
              src/path.o src/box.o src/output.o src/gq_cache.o src/gist.o \
-             src/key.o src/gnomo.o src/epochprop.o brin.o
+             src/key.o src/gnomo.o src/epochprop.o src/brin.o
 
 ifneq ($(USE_HEALPIX),0)
 OBJS      += src/healpix.o src/moc.o src/process_moc.o \
@@ -43,7 +43,7 @@ REGRESS_9_5 = index_9.5 # experimental for spoint3
 
 TESTS       = init_test tables points euler circle line ellipse poly path box \
               index contains_ops contains_ops_compat bounding_box_gist gnomo \
-              epochprop contains overlaps
+              epochprop contains overlaps spoint_brin
 
 ifneq ($(USE_HEALPIX),0)
 TESTS      += healpix moc mocautocast
@@ -262,7 +262,7 @@ endif
 pg_sphere--1.2.2--1.2.3.sql:
 	cat upgrade_scripts/$@.in > $@
 
-pg_sphere--1.2.3--1.3.0.sql:
+pg_sphere--1.2.3--1.3.0.sql: pgs_brin.sql.in
 	cat upgrade_scripts/$@.in > $@
 
 # end of local stuff

Diff for: doc/indices.sgm

@@ -29,9 +29,6 @@
           linkend="op.equal"><literal>=</literal></link>, and <link
           linkend="op.equal"><literal>!=</literal></link>. 
         </para>
-        <title>
-          Create a spherical index
-        </title>
         <para>
           You can create a GiST index with the following spherical data types:
         </para>

Diff for: expected/init_test_healpix.out.in

@@ -1,2 +1,2 @@
-psql:pg_sphere.test.sql:9271: NOTICE:  return type smoc is only a shell
-psql:pg_sphere.test.sql:9277: NOTICE:  argument type smoc is only a shell
+psql:pg_sphere.test.sql:9682: NOTICE:  return type smoc is only a shell
+psql:pg_sphere.test.sql:9688: NOTICE:  argument type smoc is only a shell

Diff for: expected/spoint_brin.out

@@ -1,56 +1,87 @@
-CREATE TABLE
-COPY 77
-CREATE FUNCTION
-CREATE INDEX
-SET
-SET
-SET
- ?column? |  qnodes
+CREATE TABLE test_points (
+    p spoint
+);
+COPY test_points (p) FROM stdin;
+CREATE OR REPLACE FUNCTION qnodes(q text) RETURNS text
+LANGUAGE 'plpgsql' AS
+$$
+DECLARE
+  exp TEXT;
+  mat TEXT[];
+  ret TEXT[];
+BEGIN
+  FOR exp IN EXECUTE 'EXPLAIN ' || q
+  LOOP
+    --RAISE NOTICE 'EXP: %', exp;
+    mat := regexp_matches(exp, ' *(?:-> *)?(.*Scan)');
+    --RAISE NOTICE 'MAT: %', mat;
+    IF mat IS NOT NULL THEN
+      ret := array_append(ret, mat[1]);
+    END IF;
+    --RAISE NOTICE 'RET: %', ret;
+  END LOOP;
+  RETURN array_to_string(ret,',');
+END;
+$$;
+CREATE INDEX brin_spoint ON test_points USING brin (p) WITH (pages_per_range = 16);
+set enable_indexscan = off;
+set enable_bitmapscan = off;
+set enable_seqscan = on;
+SELECT 'scan_seq', qnodes('SELECT * FROM test_points WHERE p <@ sbox ''( (10d,10d), (20d,20d) )''');
+ ?column? |  qnodes  
 ----------+----------
  scan_seq | Seq Scan
 (1 row)
 
-                    p
+SELECT * FROM test_points WHERE p <@ sbox '( (10d,10d), (20d,20d) )';
+                    p                    
 -----------------------------------------
  (0.349065850398866 , 0.174532925199433)
 (1 row)
 
- ?column? |  qnodes
+SELECT 'scan_seq', qnodes('SELECT * FROM test_points WHERE p && sbox ''( (10d,10d), (20d,20d) )''');
+ ?column? |  qnodes  
 ----------+----------
  scan_seq | Seq Scan
 (1 row)
 
-                    p
+SELECT * FROM test_points WHERE p && sbox '( (10d,10d), (20d,20d) )';
+                    p                    
 -----------------------------------------
  (0.349065850398866 , 0.174532925199433)
 (1 row)
 
-SET
-SET
-SET
- ?column? |               qnodes
+set enable_indexscan = off;
+set enable_bitmapscan = on;
+set enable_seqscan = off;
+SELECT 'scan_idx', qnodes('SELECT * FROM test_points WHERE p <@ sbox ''( (10d,10d), (20d,20d) )''');
+ ?column? |               qnodes               
 ----------+------------------------------------
  scan_idx | Bitmap Heap Scan,Bitmap Index Scan
 (1 row)
 
-                    p
+SELECT * FROM test_points WHERE p <@ sbox '( (10d,10d), (20d,20d) )';
+                    p                    
 -----------------------------------------
  (0.349065850398866 , 0.174532925199433)
 (1 row)
 
- ?column? |               qnodes
+SELECT 'scan_idx', qnodes('SELECT * FROM test_points WHERE p && sbox ''( (10d,10d), (20d,20d) )''');
+ ?column? |               qnodes               
 ----------+------------------------------------
  scan_idx | Bitmap Heap Scan,Bitmap Index Scan
 (1 row)
 
-                    p
+SELECT * FROM test_points WHERE p && sbox '( (10d,10d), (20d,20d) )';
+                    p                    
 -----------------------------------------
  (0.349065850398866 , 0.174532925199433)
 (1 row)
 
-DROP INDEX
-DROP TABLE
-DROP FUNCTION
-SET
-SET
-SET
+-- cleanup
+DROP INDEX brin_spoint;
+DROP TABLE test_points;
+DROP FUNCTION qnodes(text);
+set enable_indexscan = on;
+set enable_bitmapscan = on;
+set enable_seqscan = on;

Diff for: brin.c renamed to src/brin.c

@@ -53,14 +53,15 @@ spoint_brin_inclusion_add_value(PG_FUNCTION_ARGS)
 		PG_RETURN_BOOL(true);
 	}
 
-	spherepoint_gen_key(&spointkey, newval);
+	spherepoint_gen_key(spointkey, newval);
 
 	/*
 	 * If spherekey pointer is NULL, we consider the spoint entry as 'empty'.
 	 *
 	 * The OpClass support empty entries: we need to set the "contains empty"
 	 * flag in the element (unless already set).
 	 */
+	/*
 	if (spointkey == NULL)
 	{
 		if (!DatumGetBool(column->bv_values[INCLUSION_CONTAINS_EMPTY]))
@@ -71,6 +72,7 @@ spoint_brin_inclusion_add_value(PG_FUNCTION_ARGS)
 
 		PG_RETURN_BOOL(false);
 	}
+	*/
 
 	/* if the recorded value is null, we just need to store the spherekey */
 	if (column->bv_allnulls)
@@ -121,14 +123,15 @@ sbox_brin_inclusion_add_value(PG_FUNCTION_ARGS)
 		PG_RETURN_BOOL(true);
 	}
 
-	spherebox_gen_key(&sboxkey, newval);
+	spherebox_gen_key(sboxkey, newval);
 
 	/*
 	 * If spherekey pointer is NULL, we consider the spoint entry as 'empty'.
 	 *
 	 * The OpClass support empty entries: we need to set the "contains empty"
 	 * flag in the element (unless already set).
 	 */
+	/*
 	if (sboxkey == NULL)
 	{
 		if (!DatumGetBool(column->bv_values[INCLUSION_CONTAINS_EMPTY]))
@@ -139,6 +142,7 @@ sbox_brin_inclusion_add_value(PG_FUNCTION_ARGS)
 
 		PG_RETURN_BOOL(false);
 	}
+	*/
 
 	/* if the recorded value is null, we just need to store the spherekey */
 	if (column->bv_allnulls)
@@ -178,7 +182,7 @@ spoint_overlaps_spherekey(PG_FUNCTION_ARGS)
 	SPoint	   *p1 = (SPoint *) PG_GETARG_POINTER(0);
 	int32	   *k2 = (int32 *) PG_GETARG_POINTER(1);
 
-	spherepoint_gen_key(&k1, p1);
+	spherepoint_gen_key(k1, p1);
 	if (spherekey_interleave(k1, k2) == SCKEY_OVERLAP)
 	{
 		PG_RETURN_BOOL(true);
@@ -194,7 +198,7 @@ spoint_contains_spherekey(PG_FUNCTION_ARGS)
 	SPoint	   *p1 = (SPoint *) PG_GETARG_POINTER(0);
 	int32	   *k2 = (int32 *) PG_GETARG_POINTER(1);
 
-	spherepoint_gen_key(&k1, p1);
+	spherepoint_gen_key(k1, p1);
 	if (spherekey_interleave(k1, k2) == SCKEY_IN)
 	{
 		PG_RETURN_BOOL(true);
@@ -210,7 +214,7 @@ spoint_iscontained_spherekey(PG_FUNCTION_ARGS)
 	SPoint	   *p1 = (SPoint *) PG_GETARG_POINTER(0);
 	int32	   *k2 = (int32 *) PG_GETARG_POINTER(1);
 
-	spherepoint_gen_key(&k1, p1);
+	spherepoint_gen_key(k1, p1);
 	if (spherekey_interleave(k2, k1) == SCKEY_IN)
 	{
 		PG_RETURN_BOOL(true);
@@ -226,7 +230,7 @@ sbox_overlaps_spherekey(PG_FUNCTION_ARGS)
 	SBOX	   *p1 = (SBOX *) PG_GETARG_POINTER(0);
 	int32	   *k2 = (int32 *) PG_GETARG_POINTER(1);
 
-	spherebox_gen_key(&k1, p1);
+	spherebox_gen_key(k1, p1);
 	if (spherekey_interleave(k1, k2) == SCKEY_OVERLAP)
 	{
 		PG_RETURN_BOOL(true);
@@ -242,7 +246,7 @@ sbox_contains_spherekey(PG_FUNCTION_ARGS)
 	SBOX	   *p1 = (SBOX *) PG_GETARG_POINTER(0);
 	int32	   *k2 = (int32 *) PG_GETARG_POINTER(1);
 
-	spherebox_gen_key(&k1, p1);
+	spherebox_gen_key(k1, p1);
 	if (spherekey_interleave(k1, k2) == SCKEY_IN)
 	{
 		PG_RETURN_BOOL(true);
@@ -258,7 +262,7 @@ sbox_iscontained_spherekey(PG_FUNCTION_ARGS)
 	SBOX	   *p1 = (SBOX *) PG_GETARG_POINTER(0);
 	int32	   *k2 = (int32 *) PG_GETARG_POINTER(1);
 
-	spherebox_gen_key(&k1, p1);
+	spherebox_gen_key(k1, p1);
 	if (spherekey_interleave(k2, k1) == SCKEY_IN)
 	{
 		PG_RETURN_BOOL(true);
@@ -317,8 +321,8 @@ spoint_overlaps_sbox(PG_FUNCTION_ARGS)
 	int32		k2[6];
 	SBOX	   *p2 = (SBOX *) PG_GETARG_POINTER(1);
 
-	spherepoint_gen_key(&k1, p1);
-	spherebox_gen_key(&k2, p2);
+	spherepoint_gen_key(k1, p1);
+	spherebox_gen_key(k2, p2);
 
 	if (spherekey_interleave(k1, k2) == SCKEY_OVERLAP)
 	{
@@ -336,8 +340,8 @@ sbox_iscontained_spoint(PG_FUNCTION_ARGS)
 	int32		k2[6];
 	SPoint	   *p2 = (SPoint *) PG_GETARG_POINTER(1);
 
-	spherebox_gen_key(&k1, p1);
-	spherepoint_gen_key(&k2, p2);
+	spherebox_gen_key(k1, p1);
+	spherepoint_gen_key(k2, p2);
 
 	if (spherekey_interleave(k1, k2) == SCKEY_IN)
 	{