1
0
mirror of https://github.com/postgres/postgres.git synced 2025-07-28 23:42:10 +03:00

amcheck: Improve error message for partitioned index target.

Previously, amcheck could produce misleading error message when
a partitioned index was passed to functions like bt_index_check().
For example, bt_index_check() with a partitioned btree index produced:

    ERROR:  expected "btree" index as targets for verification
    DETAIL:  Relation ... is a btree index.

Reporting "expected btree index as targets" even when the specified
index was a btree was confusing. In this case, the function should fail
since the partitioned index specified is not valid target. This commit
improves the error reporting to better reflect this actual issue. Now,
bt_index_check() with a partitioned index, the error message is:

    ERROR:  expected index as targets for verification
    DETAIL:  This operation is not supported for partitioned indexes.

This commit also applies the following minor changes:

- Simplifies index_checkable() by using get_am_name() to retrieve
   the access method name.

- Changes index_checkable() from extern to static, as it is only used
   in verify_common.c.

- Updates the error code for invalid indexes to
   ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE,
   aligning with usage in similar modules like pgstattuple.

Author: Masahiro Ikeda <ikedamsh@oss.nttdata.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/8829854bbfc8635ddecd0846bb72dfda@oss.nttdata.com
This commit is contained in:
Fujii Masao
2025-07-14 20:01:06 +09:00
parent 6b1c4d326b
commit 88a658a42e
4 changed files with 27 additions and 14 deletions

View File

@ -60,6 +60,14 @@ SELECT bt_index_parent_check('bttest_a_brin_idx');
ERROR: expected "btree" index as targets for verification ERROR: expected "btree" index as targets for verification
DETAIL: Relation "bttest_a_brin_idx" is a brin index. DETAIL: Relation "bttest_a_brin_idx" is a brin index.
ROLLBACK; ROLLBACK;
-- verify partitioned indexes are rejected (error)
BEGIN;
CREATE TABLE bttest_partitioned (a int, b int) PARTITION BY list (a);
CREATE INDEX bttest_btree_partitioned_idx ON bttest_partitioned USING btree (b);
SELECT bt_index_parent_check('bttest_btree_partitioned_idx');
ERROR: expected index as targets for verification
DETAIL: This operation is not supported for partitioned indexes.
ROLLBACK;
-- normal check outside of xact -- normal check outside of xact
SELECT bt_index_check('bttest_a_idx'); SELECT bt_index_check('bttest_a_idx');
bt_index_check bt_index_check

View File

@ -52,6 +52,13 @@ CREATE INDEX bttest_a_brin_idx ON bttest_a USING brin(id);
SELECT bt_index_parent_check('bttest_a_brin_idx'); SELECT bt_index_parent_check('bttest_a_brin_idx');
ROLLBACK; ROLLBACK;
-- verify partitioned indexes are rejected (error)
BEGIN;
CREATE TABLE bttest_partitioned (a int, b int) PARTITION BY list (a);
CREATE INDEX bttest_btree_partitioned_idx ON bttest_partitioned USING btree (b);
SELECT bt_index_parent_check('bttest_btree_partitioned_idx');
ROLLBACK;
-- normal check outside of xact -- normal check outside of xact
SELECT bt_index_check('bttest_a_idx'); SELECT bt_index_check('bttest_a_idx');
-- more expansive tests -- more expansive tests

View File

@ -18,11 +18,13 @@
#include "verify_common.h" #include "verify_common.h"
#include "catalog/index.h" #include "catalog/index.h"
#include "catalog/pg_am.h" #include "catalog/pg_am.h"
#include "commands/defrem.h"
#include "commands/tablecmds.h" #include "commands/tablecmds.h"
#include "utils/guc.h" #include "utils/guc.h"
#include "utils/syscache.h" #include "utils/syscache.h"
static bool amcheck_index_mainfork_expected(Relation rel); static bool amcheck_index_mainfork_expected(Relation rel);
static bool index_checkable(Relation rel, Oid am_id);
/* /*
@ -155,23 +157,21 @@ amcheck_lock_relation_and_check(Oid indrelid,
* callable by non-superusers. If granted, it's useful to be able to check a * callable by non-superusers. If granted, it's useful to be able to check a
* whole cluster. * whole cluster.
*/ */
bool static bool
index_checkable(Relation rel, Oid am_id) index_checkable(Relation rel, Oid am_id)
{ {
if (rel->rd_rel->relkind != RELKIND_INDEX || if (rel->rd_rel->relkind != RELKIND_INDEX)
rel->rd_rel->relam != am_id) ereport(ERROR,
{ (errcode(ERRCODE_WRONG_OBJECT_TYPE),
HeapTuple amtup; errmsg("expected index as targets for verification"),
HeapTuple amtuprel; errdetail_relkind_not_supported(rel->rd_rel->relkind)));
amtup = SearchSysCache1(AMOID, ObjectIdGetDatum(am_id)); if (rel->rd_rel->relam != am_id)
amtuprel = SearchSysCache1(AMOID, ObjectIdGetDatum(rel->rd_rel->relam));
ereport(ERROR, ereport(ERROR,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED), (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
errmsg("expected \"%s\" index as targets for verification", NameStr(((Form_pg_am) GETSTRUCT(amtup))->amname)), errmsg("expected \"%s\" index as targets for verification", get_am_name(am_id)),
errdetail("Relation \"%s\" is a %s index.", errdetail("Relation \"%s\" is a %s index.",
RelationGetRelationName(rel), NameStr(((Form_pg_am) GETSTRUCT(amtuprel))->amname)))); RelationGetRelationName(rel), get_am_name(rel->rd_rel->relam))));
}
if (RELATION_IS_OTHER_TEMP(rel)) if (RELATION_IS_OTHER_TEMP(rel))
ereport(ERROR, ereport(ERROR,
@ -182,7 +182,7 @@ index_checkable(Relation rel, Oid am_id)
if (!rel->rd_index->indisvalid) if (!rel->rd_index->indisvalid)
ereport(ERROR, ereport(ERROR,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED), (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
errmsg("cannot check index \"%s\"", errmsg("cannot check index \"%s\"",
RelationGetRelationName(rel)), RelationGetRelationName(rel)),
errdetail("Index is not valid."))); errdetail("Index is not valid.")));

View File

@ -26,5 +26,3 @@ extern void amcheck_lock_relation_and_check(Oid indrelid,
Oid am_id, Oid am_id,
IndexDoCheckCallback check, IndexDoCheckCallback check,
LOCKMODE lockmode, void *state); LOCKMODE lockmode, void *state);
extern bool index_checkable(Relation rel, Oid am_id);