psql tab completion broken for storage servers, tags, profiles and resource groups (pre-PG15 query format)
Maintainers usually reply within 2 days
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
Research direction
The four macros Query_for_list_of_tags, Query_for_list_of_resgroups, Query_for_list_of_storage_servers and Query_for_list_of_profiles are in src/bin/psql/tab-complete.c. Compare them with Query_for_list_of_servers, which already uses the PG16 form with a single LIKE '%s'. Convert the four to that form, rebuild psql, and check that TAB after ALTER TAG t_ or ALTER STORAGE SERVER s_ completes names with no coordinator ERROR. The related COMMENT and DROP STORAGE SERVER rules are separate and can be handled here or in #2312.
Written by the indexing model from the issue text.
Description
Apache Cloudberry version
main
What happened
psql tab completion of object names does not work for four Cloudberry-specific object types: storage servers, tags, profiles and resource groups. Pressing TAB after ALTER STORAGE SERVER , ALTER TAG , DROP TAG , ALTER PROFILE , ALTER RESOURCE GROUP , etc. offers nothing, even when matching objects exist. Each attempt also logs a server-side ERROR on the coordinator.
Root cause. These four query macros in src/bin/psql/tab-complete.c still use the pre-PG15 template form:
Query_for_list_of_tags ... WHERE substring(pg_catalog.quote_ident(tagname),1,%d)='%s'
Query_for_list_of_resgroups ... WHERE substring(pg_catalog.quote_ident(rsgname),1,%d)='%s'
Query_for_list_of_storage_servers ... WHERE substring(pg_catalog.quote_ident(srvname),1,%d)='%s'
Query_for_list_of_profiles ... WHERE substring(pg_catalog.quote_ident(profilename),1,%d)='%s'
Upstream commit 02b8048ba5d ("psql: improve tab-complete's handling of variant SQL names", PG15) changed the template contract. _complete_from_query() now does
appendPQExpBuffer(&query_buffer, simple_query, e_object_like, e_ref_object, e_ref_schema);
and expects a single LIKE '%s'. Upstream's own macros were converted when the PG16 code was merged, but these Cloudberry-specific ones were not. As a result, %d receives a char * (undefined behavior) and %s receives the NULL e_ref_object. The generated query looks like this:
ERROR: negative substring length not allowed
STATEMENT: SELECT pg_catalog.quote_ident(srvname) FROM pg_catalog.gp_storage_server
WHERE substring(pg_catalog.quote_ident(srvname),1,-1478678816)='(null)'
When the garbage length happens to be positive, the query runs but matches nothing.
What you think should happen instead
Object names should complete. Convert the four macros to the PG16 form, as Query_for_list_of_servers already does:
#define Query_for_list_of_storage_servers \
" SELECT srvname "\
" FROM pg_catalog.gp_storage_server "\
" WHERE srvname LIKE '%s'"
The other three need the same change. The storage-server conversion has been verified: with psql rebuilt and driven through a pty, ALTER STORAGE SERVER <TAB> lists the servers, and the coordinator ERROR disappears.
How to reproduce
CREATE TAG t_demo;
CREATE PROFILE p_demo;
CREATE STORAGE SERVER s_demo OPTIONS (endpoint 'x');
In interactive psql, press TAB after each of the following. None of them completes:
ALTER TAG t_ALTER PROFILE p_ALTER STORAGE SERVER s_ALTER RESOURCE GROUP admin_
The coordinator log gets one bad query per completion attempt, against gp_storage_server, pg_tag, pg_profile and pg_resgroup, all of the substring(...,1,<garbage>)='(null)' form.
Related completion bugs for storage servers (same area)
The single-word {"SERVER", Query_for_list_of_servers} entry in words_after_create, and the generic COMMENT ON X Y → IS rule, win over the multi-word "STORAGE SERVER". This gives:
DROP STORAGE SERVER <TAB>andCREATE STORAGE USER MAPPING FOR u STORAGE SERVER <TAB>complete foreign servers (for examplegp_exttable_server).COMMENT ON STORAGE SERVER <TAB>completesISinstead of a server name.ALTER STORAGE SERVER s <TAB>offersRENAME TO, but the grammar has no such form.
The following additions were verified to fix the first three cases (the user-mapping case still needs its own rule):
else if (Matches("COMMENT", "ON", "STORAGE", "SERVER"))
COMPLETE_WITH_QUERY(Query_for_list_of_storage_servers);
...
else if (Matches("DROP", "STORAGE", "SERVER") ||
Matches("DROP", "STORAGE", "SERVER", "IF", "EXISTS"))
COMPLETE_WITH_QUERY(Query_for_list_of_storage_servers);
Operating System
Linux (platform independent)
Anything else
Found while reviewing #2312. That PR touches the ALTER STORAGE SERVER <name> completion line but not the issues above. The storage-server part can be fixed there or here.
- Dominant language
- C
- Stars
- 1.4k
- Forks
- 273
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 105
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/cloudberry
-
isolation2 lockmodes fails on cassert builds: extra AccessShareLock on partition rootPossibly taken @tuhaihe claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/cloudberry#2356 ·
Maintainers usually reply within 2 days
-
[Bug] Expand fails to recognize user-defined tablespacesPossibly taken @nix-oss claimed this 92 days ago. Opentype: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/cloudberry#1885 · 2 reactions ·
Maintainers usually reply within 2 days
-
gpexpand first stage fails: 'SyncPackages' object has no attribute 'ret' (extension sync never runs; regression)Possibly taken @talmacschen-arch claimed this 153 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
apache/cloudberry#1825 ·
Maintainers usually reply within 2 days
-
type: Bug
Difficulty 4/5 3-5 days Newbie friendliness 53/100
apache/cloudberry#2350 · 1 reaction ·
Maintainers usually reply within 2 days
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
apache/cloudberry#2348 · 1 comment ·
Maintainers usually reply within 2 days
All issues in apache/cloudberry
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
windows-artifacts: the win-arm64 job uses a Visual Studio generator missing from windows-11-armOpen
Difficulty 1/5 Under an hour Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
wasm-micro-runtime/wasm-micro-runtime#5217 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
HandBrake/HandBrake#8278 · 1 comment ·
Maintainers usually reply within 1 day