Add forgotten test files

9e2f8b6 forgot to contain the .sql and expected/.out files for
hints_anywhere feature. Add them.

Fix SEGV caused by duplicate memoize hints

HintTypeName was missing the item for the Memoize hint. This causes
SEGV or "(null)" printing by printf on erroring of duplicate memoize
hints.

Add the missing item and a static assertion to check the same kind of
fault.

Reported by ShangBenX <https://github.com/ShangBenX>

Properly free all elements in a list

HintStateDelete tried to free the elements of hstate->all_hints[] but
actually it only freed part of them.  Correct the code as it intended.

Some other palloced blocks are being hanged under the struct but we
don't bother trying to be perfect at cleaning up the whole struct
since it will be freed up at query end.

Fix many typos in doc

Many misspellings were left alone in the documentation.  Rechecked the
whole documentation and fixed the misspellings.

Reported-by: qianglingjie <86580516+qianglingjie@users.noreply.github.com>

Use standard way of deleteing list cell

When the list implementation was changed, pg_hint_plan followed that
change by modifying existing use-side code.  Use instead
foreach_delete_current, which is the standard provided API to do the
same.

Allow hints to be placed anywhere in query

Hints description is restriected to be placed before certain
characters. That is effectively at the beginning of a query, or after
EXPLAIN or PREPARE.  This commit adds a new setting parameter
pg_hint_plan.hints_anywhere, which gets rid of that restriction.  When
it is on, pg_hint_plan ignores SQL syntax at all while reading hints
so there's no restricion on where hint string is placed in a query
string. On the other hand it may lead to false reads from a non-hint
strings.

Create README.md

Add standard README.md file.  This file is a simple conversion from
existing document as a starter.

Add LD option --build-id only at RPM-build time

That option harms not only SunOS but also BSDs.  It is required by
rpmbuild so it is sensible to move the option from Makefile to SPEC
file.

Fix behavior for pg_hint_plan.debug_print

It was a kind of broken that some debug code paths are never visited
or that higher debug_level doesn't offer detailed messages.
Fix some debug messages' debug_level condition so that we can see the
proper messages for every debug_level.

Fix versions and copyright year of doc

[DOC] Fix default value for pg_hint_plan.message_level

The actual default value for the variable is LOG so that the messages
are emitted to server log. Fix the documentation.

Per the report from jianggq@cn.fujitsu.com.

Light-Weight spelling and grammar fixes

Fix some fixes of spelling and grammar in the doc.

Followup change to support PG14

One improvement and on fix.

Ressurect post_parse_analysys_hook function to avoid redandunt
computation of jumble state if it is generated in-core.

Properly handle the case where compute_query_id is turned off while
pg_hint_plan.enable_hint_talbe is on.  This operation lead to a crash.

Update copyright year of files

Allow run make check of PostgreSQL with loading pg_hint.plan

Automatically switch environment when pg_hint_plan is installed as a
part of "make check" of PostgreSQL.  That test is executed with the
following command line in the top directory of PostgreSQL tree.

make check EXTRA_INSTALL=<this directory> EXTRA_REGRESS_OPTS="--temp-config <this directory>/pg_hint_plan.conf"

make check-world fails for test that requires extra modules.

Support "Memoize" Hint.

PostgreSQL 14 introduced the new optimization item "memoize", which
allows a join to memoize the inner result.  Add a hint to control this
feature.

Support PostgreSQL 14

In PostgreSQL 14, planner was restructured in regard to query string
passing.  This change allows us to remove fair amount of lines and
complexity that had been added as a struggle for retrieving proper
query string.

Two callbacks, post_parse_analyze_hook and ProcessUtility_hook are no
longer used.  get_query_string is removed altogether.  Also
current_hint_retrieved juggling, which was complex and fragile,
disappears. Now pg_hint_plan_planner alone can retrieve hint string by
looking into the given string.

In PostgreSQL 14, a new optimization item "memoize" is added. It is
not handled in this commit and leave it for a later commit.

Change version to 1.3.7.

Make HashJoin hint more coercive.

Even with HashJoin hint, hash joins may be rejected by planner if hash
table for the inner-rel is estimated too large.  Make HashJoin hint
more coercive by increasing hash_mem_multiplier.

Change copyright year of docs to 2020

Stabilize regression test.

I was annoyed by frequent nonsubstantial change of title line length
of explain output.  This commit makes maskout.sh replace the title
lines with fixed content.

Follow a behavioral change in core.

Commit 894f5dea76 has changed the core's behavior of naming indexes.
Follow the changes. This is regression-result changes only.

Update core.c and make_join_rel.c.

From this version core.c and make_join_rel.c are automatically
generated from core code.  Adjust them to auto-generated content.

New tool to generate source files for copied functions

Previously core.c and make_join_rel.c are maintained by hand. This
tool generates the files from corresponding core source files.

Add *.bc to .gitignore

Added *.bc and *~ to .gitignore

Follow the semantic change of pg_list part 2

Commit 7ed93ce forgot to fix another place where list_delete_cell() is
used. Fix it.

Support PostgreSQL 13.

- Follow change of some planner functions.

- Follow a change of the semantics of List.

- Take in changes in copied core code.

- Adjust regression tests.
  Amost all of the differences are come from aliasing policy, and some
  come from a new GUC parameter.

Version 1.3.6.

Fixed some bugs.

Add description of *ScanRegExp hints in the document.

English version of hint list is missing regexp versions of scan
hints. Add them.

Mask non-significant parts of regression output

To stabilize test, mask more of non-significant parts of EXPLAIN output.

Fix segfault when use Set, Rows and Parallel hints together

Fix some spelling errors in comments

Mark hint table as a configuration table.

The table hint_plan.hints is a configuration table of
pg_hint_plan. Mark it as such, as well as its sequence table.

Back patch to pg_hint_plan96.

Preparation for branch PG12

Change version to 12-1.3.5. Adjust SPEC file.

Support PG12.

As the prepparation for making PG12 branch, change PG version to 12
and adjust for the latest PG12.

Change copyright year to 2020.

Restore current hint state when returned from non-hinted query planning.

If no hint is given for the current level query, pg_hint_plan_planner
calls the next level of planner after erasing the
current_hint_state. But it forgot to restore the state before the
planning of the rest part of the current-level query.  It is
(a-kind-of) broken by the commit d422966 but overlooked as an
inevitable side-effect of the fix.  Get back the behavior by restoring
current_hint_state after returned from the lower level planner with
unhinted query.

Issue: https://github.com/ossc-db/pg_hint_plan/issues/30
Reported-by: higuchi-daisuke

Use proper type for non-integer GUC options.

pg_hint_plan internally preserved numeric options into integer
variable regardless of their types, which leads to unintentional
change of the values.  Handle double values in the proper way.

Fix Rows hint parsing

This is a long standing bug that Rows hint with no parameter causees a
crash. Fixed the Rows hint parser.

Give correct query location to generate_normalized_query.

There was a thinko about query_loc of generate_normalized_query which
causes a crash. For example a query is following a sequence of
semicolons (by \; in psql input) longer than the length after the last
placeholder to the end of the query, the function causes assertion
failure. Anyway prepared statements lose that value so we just pass 0
as the query_loc for consistent behavior.

Fix behavior of nested planning

Issue: https://github.com/ossc-db/pg_hint_plan/issues/39

When planning is nested by function call, the hints in the function
should affect the corresponding query. Maybe 9599067 introduced
that. Fix the nested planning behavior.

Fix crash bug caused by plancache invalidation

https://github.com/ossc-db/pg_hint_plan/issues/41

After plancache is invalidated then revaliated, get_query_string
accesses query_list of invalid plansource then crash. Ignore invalid
plancache and get the correct hint string and Query node at the next
planning time during revalidation.

On the way fixing this, a bug related to planner reentrance is
fixed. That fix causes behavioral change for nested
planning. Previously outer-level hint (wrongly) overrides inner-level
query but currenlty outer-level hint no longer affects inner-level
query.

Fix  compiling error on Solaris

The 'LDFLAGS+=-Wl,--build-id' option is for rpm building in Linux like
OS.  The SunOS is not native support the option
'LDFLAGS+=-Wl,--build-id' . So, we disable this option in SunOS while
compiling.

Committed a bit tweaked version from the orignal.

Fix the previous commit.

The previous commit left a line to be removed. Remove it.

Do null-check of error_context_stack before use

The variable is accessed without null checking when planner is called
in the context of pl/pgsql. Fix it. Back-patched up to pg_hint_plan94.

Reporter: egashira-yusuke
Issue: https://github.com/ossc-db/pg_hint_plan/issues/42
Original-Author: sun-wei <30999182+Dagouhan@users.noreply.github.com>
Original-patch: https://github.com/ossc-db/pg_hint_plan/pull/45/commits/8fe092ef73a9af6cfb41e20717d7cb35aa74fce2

Fix regression tests.

Fix regression tests to work for PG12.

Follow the change in PG12.

Commit 428b260f87 breaks the prior assumptions by adding one more
planning cycle for updates on partitioned tables. Follow the change.

Update core.c based on PG12.0

The following commits changes the original functions in core.c as of
REL_12_0. Took in the changes.

7ad6498fd5a654de6e743814c36cf619a3b5ddb6
45f8eaa8e3031c9cb12deb1b5e294bc052b378f2
f49842d1ee31b976c681322f76025d7732e860f3
7ad6498fd5a654de6e743814c36cf619a3b5ddb6

Fix definition of is_dummy_rel based on changes in community

fix spelling mistakes in file pg_hint_plan.html

Use ParallelHint in ParallelHintCreate()

Silence some compilers

Some compilers seem to complain about the previous patch, that
prev_hint_str is used uninitialized. Actually it is not but move the
initialization code out of the PG_TRY() section so that such compilers
would be quiet.

Correctly handle planner nesting

pg_hint_plan assumed that plpgsql is the only source of nested planner
calls. Actually nested call can be made in any shapes. Most of the
cases doesn't harm but in a special case where pg_dbms_stats makes a
SPI call during query planning, that affects subsequent planner
work. Hints lose effect when pg_dbms_stats searches "locked
statistics" tables while planning the target query.

9.5 is not affected. Back patched back to 9.6.

Follow core's cobe/havor chages

Take in some changes took place in core code.

Commit 608b167f9f has largely changed the behavior around
CTE. Although I didn't confirmed that the all changes are valid as the
test for pg_hint_plan, just took in all plan differences.

Change version to 1.3.4.

Fixed a minor bug of 1.3.3.

Fix condition to regenerate gather paths

Core has additional condition to determine whether to generate gather
paths and pg_hint_plan forgot it. Fix it.

Change version to 1.3.3

Version bumped to 1.3.3. SPEC file is updated.

Fix reverse link of hint_list.html

pg_hint_plan.html and hint_list.html pointed to the Japanese version
of main document. Fixed it.

Fix documentation.

Fixed wrong or stale descriptions, and poor or broken styles of
the documentation.

Include all pg_hint_plan--*.sql files in installation

make install didn't install upgrade scripts. Fix it.

Change copyright year to 2019

Fix content of llvmjit package

The previous release is missing index.bc file and mislocating .bc file
in the llvmjit subpackage. The former is created at make install time
so use the standard make file to rpm-build.

Catch up with the latest master

Some refactoring of header files and commits afb0d0712f and 1db5667bac
of core hit this. Catch up with them.

Call standrad_ProcessUtility when no hook is set

The last commit d5ec243 forgot the case of no previous hook function
in the ProcessUtility hook function. Fix it.

Support prepared statements on extended protocol

However pg_hint_plan doesn't fully consider the extended protocol,
commit c05bb31 accidentially broke the case where an analyzed prepared
statement is executed on extended protocol. This patch fixes that only
for the hints-in-comment case. Hint-table still doesn't work in the
case since query-normalization needs Query, which is not available in
planner_hook.

Remove an useless variable

commit c05bb31 made the variable stmt_name useless. Remove it.

Adjust regression test

Core behavior has changed, adjust regression test.

Adjust regression test

Some regression test items need adjustment due to change of server
behavior. The way the regression test ignores unstable portions of
EXPLAIN output is changed along with that.

Fix for union-on-inheritance case

setup_hint_enforcement may pick up a wrong hint when multiple
subqueries access inheritance tables. This leads to failure to apply
hints on other than the first subquery.

Don't reset plpgsql nest level at every command end

Clean up code for global exit is forgetting about loops that run
hinted commands multiple times. This leads to pg_hint_plan's failure
to affect after the first execution of the inner commands.
The hint below worked only for the first time.

FOR outer IN EXECUTE 'outer-command' LOOP
  FOR inner IN EXECUTE '/*+ hint */ inner-command' LOOP
    <something>
  END LOOP;
END LOOP;

Minor document fix

Just fix versions of PostgreSQL and OS.

Change target version to PG11 and fix the SPEC file

Change targetr version to PG11. SPEC file was changed so that genearte
a subpackage llvmjit, which installs a bitcode file needed for JIT
compilation.

Fix copyright year

Fix regression test following core's behavior

Some changes has been made on GUC default value and behavior. Follow
the change. No change was made on pg_hint_plan's behavior.

Update core.c and make_jion_rel.c following core

Apply changes ever made on core.

Change version to 1.3.2.

Fix debug output level control

Previously parse_messages and message_level were binded to the same
internal variable. Separate the two GUCs. On the way doing this some
mssages that did not honor the variable were fixed. Default behavior
is not changed but the the two variables works differently from the
previous version, perhaps closer to expected.

Fix bogus error handling

For somewhat reason set_config_int32_options does bogus error
handling. Howerver that error cannot be happen, fixed it.

Change version to 1.3.1.

1.3.0 has a crash bug in Describe message of extended protocol
path. If server receives the message after invalidation of
corresponding query cache, pg_hint_plan crashes.

Took in several improvements of pg_stat_statements

Following two commits are took in.

83f2061dd0 Teach contrib/pg_stat_statements to handle multi-statement commands better.
0bb51aa967 Improve parsetree representation of special functions such as CURRENT_DATE.

The following one makes change of documented behavior of pg_hint_plan
so it is not took in.

a6f22e8356 Show ignored constants as "$N" rather than "?" in pg_stat_statements.

Support PG11

Support PG11. Just adapted to PG11 in this version. No behavior
changes except Parallel hint. PG11 gets many new parallel features and
as a matter of course they made deadly impact on Parallel hint. It no
longer works in the same way with the earlier version except for quite
simple cases.

Fix a crash bug in case debug_query_string is NULL

pg_hint_plan believed that debug_query_string cannot be null when
parse_analyze is called, but for example in the case under
exec_describe_statement_message, it is not. We see the query string in
pstate even in the case, so use it instead in the case. Since pstate
is storing the query of the lowermost level, we should use
debug_query_string in other cases.

Move expected/ut-W.out to output/ut-W.source

ut-W.out contained an absolute path of my working directory. Moved the
file into output so that we can remove the path replacing with
@abs_srcdir@.

Use @abs_srcdir@ within ut-fdw.source

The file contained absolute path of a specific working directory,
replace them with @abs_srcdir@.

Added and removed some entries in .gitignore

Removed core.c, that is not appropriate.
Added .deps and RPMS.

Remove mark_dummy_rel() from core.c

The function is exposed by the commit
f49842d1ee31b976c681322f76025d7732e860f3 so remove it from the file.

Use pg_strcasecmp instead of strcasecmp for the sake of portability

Back patched to branches PG93-96 and PG10.

Change version to 1.3.0

Added a notice in the manual.

Added an item that explains about letter case handling of object names
in hints.

Prepare for rpm build for PostgreSQL 10

Edited Makefile and SPEC file so that RPM package for PostgreSQL 10 is
built.

Added a regtest for partitioned table.

Added a minimal regression test that checks this works also on
partitioned tables. Currently partitioned tables are handled in almost
the same way with inheritance tables so this would be enough.

Corrected copyright year and a indentation.

Edited a copyright notice in which year is left alone. Correct an
indentation in make_join_rel.c. No functional change.

Reflected changes as of release 10.0.

add_paths_to_append_rel gets modified as of relase 10.0. Reflected it
to core.c

Add a regression about forcing gather-merge.

The previous commit is said to allow enforce gather merge but no
regression for that is not included. This adds that.

Modify expected files.

At 10 beta2, planner seems to get some changes to affect plans used in
regression test. Tentatively modify it just to pass the regression.
Probably it is no problem but should be checked later.

Up to date with 10 beta 2

Make copied code to be up to date with the core as of 10 beta 2.

Support DECLARE CURSOR syntax and added regression for table hinting.

Previous version forgets to treat DECLARE CURSOR. Added that.
Addition to that, regression test for table hinting is added.

Support PostgreSQL 10 beta 1 step 2/2

Changed the logic to tweak parallel execution paths so that it handles
more wider (parallel index scans or gather merge, specifically) range
of parallel paths.

Support PostgreSQL 10 beta 1 step 1/2

The first half of the work to support PostgreSQL 10.

This just makes it can work with the version of PG. So partial index
paths are lost during Parallel hint processing.  Regression tests are
heavily modified but most of them just comes from the change of
original planner behavior introduced at the point of Pg10.

Fix a bug of target query retrieval

The previous patch leaves a bug that get_query_string returns a Query
that JumbleQuery doesn't accept. This fixes that bug.