diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index c134bca809..e25412b7ce 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -675,7 +675,7 @@ search and ordering purposes.) - +
<structname>pg_amop</structname> Columns @@ -818,7 +818,7 @@ is one row for each support function belonging to an operator family. -
+
<structname>pg_amproc</structname> Columns @@ -4421,7 +4421,7 @@ SCRAM-SHA-256$<iteration count>:&l Operator classes are described at length in . -
+
<structname>pg_opclass</structname> Columns @@ -4683,7 +4683,7 @@ SCRAM-SHA-256$<iteration count>:&l Operator families are described at length in . -
+
<structname>pg_opfamily</structname> Columns diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 6e6d0f42d1..bee8987c85 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1204,6 +1204,83 @@ testdb=> + + + \dAfo + [access-method-pattern + [operator-family-pattern]] + + + + + + Lists operators () associated + with access method operator families. If + access-method-patttern is + specified, only operators associated with access method whose name + matches pattern are shown. If + operator-family-pattern is + specified, only operators associated with families whose name matches + the pattern are shown. + + + + + + + \dAfp + [access-method-pattern + [operator-family-pattern]] + + + + + List procedures () associated + with access method operator families. + If access-method-patttern + is specified, only procedures associated with access method whose name + matches pattern are shown. + If operator-family-pattern + is specified, only procedures associated with families whose name + matches the pattern are shown. + + + + + + + \dAoc + [access-method-pattern + [operator-class-pattern]] + + + + + Shows index access method operator classes listed in + . + If access-method-patttern + is specified, only operator classes associated with access method whose + name matches pattern are shown. + If operator-class-pattern + is specified, only procedures associated with families whose name + matches the pattern are shown. + + + + + + \dAp [ pattern ] + + + + Shows access method properties listed in + . + If pattern is specified, + only access methods whose names match the pattern are shown. + + + + \db[+] [ pattern ] diff --git a/src/bin/psql/command.c b/src/bin/psql/command.c index ee88e1ca5c..7c35aed018 100644 --- a/src/bin/psql/command.c +++ b/src/bin/psql/command.c @@ -719,7 +719,24 @@ exec_command_d(PsqlScanState scan_state, bool active_branch, const char *cmd) success = listTables("tvmsE", NULL, show_verbose, show_system); break; case 'A': - success = describeAccessMethods(pattern, show_verbose); + { + char *pattern2 = NULL; + if (pattern) + pattern2 = psql_scan_slash_option(scan_state, OT_NORMAL, NULL, true); + + if (strncmp(cmd, "dAp", 3) == 0) + success = describeAccessMethodProperties(pattern); + else if (strncmp(cmd, "dAfo", 4) == 0) + success = listFamilyClassOperators(pattern, pattern2, show_verbose); + else if (strncmp(cmd, "dAfp", 4) == 0) + success = listOperatorFamilyProcedures(pattern, pattern2, show_verbose); + else if (strncmp(cmd, "dAoc", 4) == 0) + success = describeAccessMethodOperatorClasses(pattern, pattern2, show_verbose); + else + success = describeAccessMethods(pattern, show_verbose); + if (pattern2) + free(pattern2); + } break; case 'a': success = describeAggregates(pattern, show_verbose, show_system); diff --git a/src/bin/psql/describe.c b/src/bin/psql/describe.c index 0a181b01d9..4947fb69fa 100644 --- a/src/bin/psql/describe.c +++ b/src/bin/psql/describe.c @@ -5611,3 +5611,305 @@ printACLColumn(PQExpBuffer buf, const char *colname) "pg_catalog.array_to_string(%s, '\\n') AS \"%s\"", colname, gettext_noop("Access privileges")); } + +/* + * \dAp + * Describes access method properties. + * + * Takes an optional regexp to select particular access methods + */ +bool +describeAccessMethodProperties(const char *pattern) +{ + PQExpBufferData buf; + PGresult *res; + printQueryOpt myopt = pset.popt; + static const bool translate_columns[] = {false, false, false, false, false, false}; + + initPQExpBuffer(&buf); + + printfPQExpBuffer(&buf, + pset.sversion >= 90600 ? + "SELECT a.amname AS \"%s\",\n" + " pg_catalog.pg_indexam_has_property(a.oid, 'can_order') AS \"%s\",\n" + " pg_catalog.pg_indexam_has_property(a.oid, 'can_unique') AS \"%s\",\n" + " pg_catalog.pg_indexam_has_property(a.oid, 'can_multi_col') AS \"%s\",\n" + " pg_catalog.pg_indexam_has_property(a.oid, 'can_exclude') AS \"%s\",\n" + : + "SELECT a.amname AS \"%s\",\n" + " a.amcanorder AS \"%s\",\n" + " a.amcanunique AS \"%s\",\n" + " a.amcanmulticol AS \"%s\",\n" + " a.amgettuple <> 0 AS \"%s\",\n", + gettext_noop("AM"), + gettext_noop("Can order"), + gettext_noop("Support unique indexes"), + gettext_noop("Support indexes with multiple columns"), + gettext_noop("Support exclusion constraints")); + + appendPQExpBuffer(&buf, + pset.sversion >= 110000 + ? "pg_catalog.pg_indexam_has_property(a.oid, 'can_include') AS \"%s\"" + : "FALSE AS \"%s\"", + gettext_noop("Can include non-key columns")); + + appendPQExpBufferStr(&buf, + "\nFROM pg_catalog.pg_am a\n"); + + processSQLNamePattern(pset.db, &buf, pattern, false, false, + NULL, "amname", NULL, NULL); + + appendPQExpBufferStr(&buf, "ORDER BY 1;"); + res = PSQLexec(buf.data); + termPQExpBuffer(&buf); + if (!res) + return false; + + myopt.nullPrint = NULL; + myopt.title = _("Access method properties"); + myopt.translate_header = true; + myopt.translate_columns = translate_columns; + myopt.n_translate_columns = lengthof(translate_columns); + + printQuery(res, &myopt, pset.queryFout, false, pset.logfile); + + PQclear(res); + return true; +} + +/* + * \dAfo + * Lists operators associated with access method operator families. + * + * Takes an optional regexp to select particular access methods + * and operator families + */ +bool +listFamilyClassOperators(const char *access_method_pattern, + const char *family_pattern, bool verbose) +{ + PQExpBufferData buf; + PGresult *res; + printQueryOpt myopt = pset.popt; + bool have_where = false; + + static const bool translate_columns[] = {false, false, false, false, false, + false, false, true, false}; + + initPQExpBuffer(&buf); + + printfPQExpBuffer(&buf, + "SELECT DISTINCT\n" + " am.amname AS \"%s\",\n" + " nsf.nspname AS \"%s\",\n" + " of.opfname AS \"%s\",\n" + " pg_catalog.format_type(o.amoplefttype, NULL) AS \"%s\",\n" + " pg_catalog.format_type(o.amoprighttype, NULL) AS \"%s\",\n" + " CASE WHEN pg_catalog.pg_operator_is_visible(op.oid) \n" + " THEN op.oprname::pg_catalog.text \n" + " ELSE o.amopopr::pg_catalog.regoper::pg_catalog.text \n" + " END AS \"%s\"\n", + gettext_noop("AM"), + gettext_noop("Opfamily Schema"), + gettext_noop("Opfamily Name"), + gettext_noop("Left type"), + gettext_noop("Right type"), + gettext_noop("Operator")); + + if (verbose) + appendPQExpBuffer(&buf, + ", o.amopstrategy AS \"%s\",\n" + " CASE o.amoppurpose\n" + " WHEN 'o' THEN '%s'\n" + " WHEN 's' THEN '%s'\n" + " END AS \"%s\",\n" + " ofs.opfname AS \"%s\"\n", + gettext_noop("Strategy"), + gettext_noop("ordering"), + gettext_noop("search"), + gettext_noop("Purpose"), + gettext_noop("Sort family")); + appendPQExpBuffer(&buf, + "FROM pg_catalog.pg_amop o\n" + " LEFT JOIN pg_catalog.pg_operator op ON op.oid = o.amopopr\n" + " LEFT JOIN pg_catalog.pg_opfamily of ON of.oid = o.amopfamily\n" + " LEFT JOIN pg_catalog.pg_am am ON am.oid = of.opfmethod AND am.oid = o.amopmethod\n" + " LEFT JOIN pg_catalog.pg_namespace nsf ON of.opfnamespace = nsf.oid\n"); + if (verbose) + appendPQExpBuffer(&buf, + " LEFT JOIN pg_catalog.pg_opfamily ofs ON ofs.oid = o.amopsortfamily\n"); + + if (access_method_pattern) + have_where = processSQLNamePattern(pset.db, &buf, access_method_pattern, + false, false, NULL, "am.amname", + NULL, NULL); + + if (family_pattern) + processSQLNamePattern(pset.db, &buf, family_pattern, have_where, false, + "nsf.nspname", "of.opfname", NULL, NULL); + + appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 3, 4, 5, 6;"); + + res = PSQLexec(buf.data); + termPQExpBuffer(&buf); + if (!res) + return false; + + myopt.nullPrint = NULL; + myopt.title = _("List operators of family related to access method"); + myopt.translate_header = true; + myopt.translate_columns = translate_columns; + myopt.n_translate_columns = lengthof(translate_columns); + + printQuery(res, &myopt, pset.queryFout, false, pset.logfile); + + PQclear(res); + return true; +} + +/* + * \dAfp + * Lists procedures associated with access method operator families. + * + * Takes an optional regexp to select particular access methods + * and operator families + */ +bool +listOperatorFamilyProcedures(const char *access_method_pattern, + const char *family_pattern, bool verbose) +{ + PQExpBufferData buf; + PGresult *res; + printQueryOpt myopt = pset.popt; + bool have_where = false; + static const bool translate_columns[] = {false, false, false, false, false, false, false}; + + initPQExpBuffer(&buf); + + printfPQExpBuffer(&buf, + "SELECT DISTINCT\n" + " am.amname AS \"%s\",\n" + " ns.nspname AS \"%s\",\n" + " of.opfname AS \"%s\",\n" + " pg_catalog.format_type(ap.amproclefttype, NULL) AS \"%s\",\n" + " pg_catalog.format_type(ap.amprocrighttype, NULL) AS \"%s\",\n" + " ap.amprocnum AS \"%s\"\n", + gettext_noop("AM"), + gettext_noop("Family schema"), + gettext_noop("Family name"), + gettext_noop("Left"), + gettext_noop("Right"), + gettext_noop("Number")); + if (verbose) + appendPQExpBuffer(&buf, + ", ap.amproc::pg_catalog.regproc::pg_catalog.text AS \"%s\"\n", + gettext_noop("Proc name")); + appendPQExpBuffer(&buf, + "FROM pg_catalog.pg_amproc ap\n" + " LEFT JOIN pg_catalog.pg_opfamily of ON of.oid = ap.amprocfamily\n" + " LEFT JOIN pg_catalog.pg_am am ON am.oid = of.opfmethod\n" + " LEFT JOIN pg_catalog.pg_namespace ns ON of.opfnamespace = ns.oid\n"); + + if (access_method_pattern) + have_where = processSQLNamePattern(pset.db, &buf, access_method_pattern, + false, false, NULL, "am.amname", + NULL, NULL); + if (family_pattern) + processSQLNamePattern(pset.db, &buf, family_pattern, have_where, false, + "ns.nspname", "of.opfname", NULL, NULL); + + appendPQExpBufferStr(&buf, + "ORDER BY 1, 2, 3, 4, 5, 6;"); + + res = PSQLexec(buf.data); + termPQExpBuffer(&buf); + if (!res) + return false; + + myopt.nullPrint = NULL; + myopt.title = _("List of operator family procedures"); + myopt.translate_header = true; + myopt.translate_columns = translate_columns; + myopt.n_translate_columns = lengthof(translate_columns); + + printQuery(res, &myopt, pset.queryFout, false, pset.logfile); + + PQclear(res); + return true; +} + +/* + * \dAoc + * List index access method operator classes. + * Takes an optional regexp to select particular access method and operator class. + */ +bool +describeAccessMethodOperatorClasses(const char *access_method_pattern, + const char *opclass_pattern, bool verbose) +{ + PQExpBufferData buf; + PGresult *res; + printQueryOpt myopt = pset.popt; + bool have_where = false; + static const bool translate_columns[] = {false, false, false, false, false, + false, false, false}; + + initPQExpBuffer(&buf); + + printfPQExpBuffer(&buf, + "SELECT" + " am.amname AS \"%s\",\n" + " n.nspname AS \"%s\",\n" + " c.opcname AS \"%s\",\n", + gettext_noop("Access method"), + gettext_noop("Schema"), + gettext_noop("Name")); + if (verbose) + appendPQExpBuffer(&buf, + " pg_catalog.pg_get_userbyid(c.opcowner) AS \"%s\",\n", + gettext_noop("Owner")); + appendPQExpBuffer(&buf, + " (CASE WHEN pg_catalog.pg_opfamily_is_visible(of.oid) THEN '' ELSE ofn.nspname || '.' END) || of.opfname AS \"%s\",\n" + " c.opcintype::pg_catalog.regtype AS \"%s\"\n", + gettext_noop("Family"), + gettext_noop("Indexed type")); + if (verbose) + appendPQExpBuffer(&buf, + ", c.opcdefault AS \"%s\",\n" + " (CASE WHEN c.opckeytype = 0 OR c.opckeytype = c.opcintype\n" + " THEN NULL\n" + " ELSE c.opckeytype\n" + " END)::pg_catalog.regtype AS \"%s\"\n", + gettext_noop("Is default"), + gettext_noop("Stored type")); + appendPQExpBuffer(&buf, + "FROM pg_catalog.pg_opclass c\n" + " LEFT JOIN pg_catalog.pg_am am on am.oid = c.opcmethod\n" + " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.opcnamespace\n" + " LEFT JOIN pg_catalog.pg_opfamily of ON of.oid = c.opcfamily\n" + " LEFT JOIN pg_catalog.pg_namespace ofn ON ofn.oid = of.opfnamespace\n"); + + if (access_method_pattern) + have_where = processSQLNamePattern(pset.db, &buf, access_method_pattern, + false, false, NULL, "am.amname", NULL, NULL); + if (opclass_pattern) + processSQLNamePattern(pset.db, &buf, opclass_pattern, have_where, false, + "n.nspname", "c.opcname", NULL, NULL); + + appendPQExpBufferStr(&buf, "ORDER BY 1,2,3;"); + res = PSQLexec(buf.data); + termPQExpBuffer(&buf); + if (!res) + return false; + + myopt.nullPrint = NULL; + myopt.title = _("Index access method operator classes"); + myopt.translate_header = true; + myopt.translate_columns = translate_columns; + myopt.n_translate_columns = lengthof(translate_columns); + + printQuery(res, &myopt, pset.queryFout, false, pset.logfile); + + PQclear(res); + return true; +} diff --git a/src/bin/psql/describe.h b/src/bin/psql/describe.h index a4cc5efae0..24a596598f 100644 --- a/src/bin/psql/describe.h +++ b/src/bin/psql/describe.h @@ -111,4 +111,21 @@ bool describePublications(const char *pattern); /* \dRs */ bool describeSubscriptions(const char *pattern, bool verbose); +/* \dAfp */ +extern bool listOperatorFamilyProcedures(const char *access_method_pattern, + const char *family_pattern, + bool verbose); + +/* \dAfo */ +extern bool listFamilyClassOperators(const char *accessMethod_pattern, + const char *family_pattern, bool verbose); + +/* \dAp */ +extern bool describeAccessMethodProperties(const char *pattern); + +/* \dAoc */ +extern bool describeAccessMethodOperatorClasses(const char *access_method_pattern, + const char *opclass_pattern, + bool verbose); + #endif /* DESCRIBE_H */ diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c index 586aebddd3..cdc8b0d210 100644 --- a/src/bin/psql/help.c +++ b/src/bin/psql/help.c @@ -224,6 +224,10 @@ slashUsage(unsigned short int pager) fprintf(output, _(" \\d[S+] NAME describe table, view, sequence, or index\n")); fprintf(output, _(" \\da[S] [PATTERN] list aggregates\n")); fprintf(output, _(" \\dA[+] [PATTERN] list access methods\n")); + fprintf(output, _(" \\dAfo [AMPTRN [OPFPTRN]] list operators of family related to access method\n")); + fprintf(output, _(" \\dAfp [AMPTRN [OPFPTRN]] list procedures of operator family related to access method\n")); + fprintf(output, _(" \\dAoc[+][AMPTRN [OPCPTRN]] list operator classes of index access methods\n")); + fprintf(output, _(" \\dAp [PATTERN] list access methods with properties\n")); fprintf(output, _(" \\db[+] [PATTERN] list tablespaces\n")); fprintf(output, _(" \\dc[S+] [PATTERN] list conversions\n")); fprintf(output, _(" \\dC[+] [PATTERN] list casts\n")); diff --git a/src/bin/psql/tab-complete.c b/src/bin/psql/tab-complete.c index 9dbd555166..7e9f6a7d11 100644 --- a/src/bin/psql/tab-complete.c +++ b/src/bin/psql/tab-complete.c @@ -460,6 +460,23 @@ static const SchemaQuery Query_for_list_of_relations = { .result = "pg_catalog.quote_ident(c.relname)", }; +static const SchemaQuery Query_for_list_of_operator_families = { + /* min_server_version */ + 0, + /* catname */ + "pg_catalog.pg_opfamily c", + /* selcondition */ + NULL, + /* viscondition */ + "true", + /* namespace */ + "c.opfnamespace", + /* result */ + "pg_catalog.quote_ident(c.opfname)", + /* qualresult */ + NULL +}; + /* Relations supporting INSERT, UPDATE or DELETE */ static const SchemaQuery Query_for_list_of_updatables = { .catname = "pg_catalog.pg_class c", @@ -1329,7 +1346,8 @@ psql_completion(const char *text, int start, int end) "\\a", "\\connect", "\\conninfo", "\\C", "\\cd", "\\copy", "\\copyright", "\\crosstabview", - "\\d", "\\da", "\\dA", "\\db", "\\dc", "\\dC", "\\dd", "\\ddp", "\\dD", + "\\d", "\\da", "\\dA", "\\dAp", "\\dAfo", "\\dAfp", "\\dAoc", + "\\db", "\\dc", "\\dC", "\\dd", "\\ddp", "\\dD", "\\des", "\\det", "\\deu", "\\dew", "\\dE", "\\df", "\\dF", "\\dFd", "\\dFp", "\\dFt", "\\dg", "\\di", "\\dl", "\\dL", "\\dm", "\\dn", "\\do", "\\dO", "\\dp", @@ -3414,6 +3432,10 @@ psql_completion(const char *text, int start, int end) } else if (TailMatchesCS("\\da*")) COMPLETE_WITH_VERSIONED_SCHEMA_QUERY(Query_for_list_of_aggregates, NULL); + else if (TailMatchesCS("\\dAf*")) + COMPLETE_WITH_QUERY(Query_for_list_of_access_methods); + else if (TailMatchesCS("\\dAf*", MatchAny)) + COMPLETE_WITH_SCHEMA_QUERY(Query_for_list_of_operator_families, NULL); else if (TailMatchesCS("\\dA*")) COMPLETE_WITH_QUERY(Query_for_list_of_access_methods); else if (TailMatchesCS("\\db*")) diff --git a/src/test/regress/expected/psql.out b/src/test/regress/expected/psql.out index 3818cfea7e..1b24a0a307 100644 --- a/src/test/regress/expected/psql.out +++ b/src/test/regress/expected/psql.out @@ -3243,3 +3243,94 @@ last error message: division by zero \echo 'last error code:' :LAST_ERROR_SQLSTATE last error code: 22012 \unset FETCH_COUNT +-- check printing info about access methods +\dA +List of access methods + Name | Type +--------+------- + brin | Index + btree | Index + gin | Index + gist | Index + hash | Index + spgist | Index +(6 rows) + +\dA+ + List of access methods + Name | Type | Handler | Description +--------+-------+-------------+---------------------------------------- + brin | Index | brinhandler | block range index (BRIN) access method + btree | Index | bthandler | b-tree index access method + gin | Index | ginhandler | GIN index access method + gist | Index | gisthandler | GiST index access method + hash | Index | hashhandler | hash index access method + spgist | Index | spghandler | SP-GiST index access method +(6 rows) + +\dA gin +List of access methods + Name | Type +------+------- + gin | Index +(1 row) + +\dA+ gin + List of access methods + Name | Type | Handler | Description +------+-------+------------+------------------------- + gin | Index | ginhandler | GIN index access method +(1 row) + +\dAp gin + Access method properties + AM | Can order | Support unique indexes | Support indexes with multiple columns | Support exclusion constraints | Can include non-key columns +-----+-----------+------------------------+---------------------------------------+-------------------------------+----------------------------- + gin | f | f | t | f | f +(1 row) + +\dAfo brin uuid_minmax_ops + List operators of family related to access method + AM | Opfamily Schema | Opfamily Name | Left type | Right type | Operator +------+-----------------+-----------------+-----------+------------+---------- + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | < + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | <= + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | = + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | > + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | >= +(5 rows) + +\dAfo * pg_catalog.jsonb_path_ops + List operators of family related to access method + AM | Opfamily Schema | Opfamily Name | Left type | Right type | Operator +-----+-----------------+----------------+-----------+------------+---------- + gin | pg_catalog | jsonb_path_ops | jsonb | jsonb | @> +(1 row) + +\dAfp brin uuid_minmax_ops + List of operator family procedures + AM | Family schema | Family name | Left | Right | Number +------+---------------+-----------------+------+-------+-------- + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | 1 + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | 2 + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | 3 + brin | pg_catalog | uuid_minmax_ops | uuid | uuid | 4 +(4 rows) + +\dAfp * pg_catalog.uuid_ops + List of operator family procedures + AM | Family schema | Family name | Left | Right | Number +-------+---------------+-------------+------+-------+-------- + btree | pg_catalog | uuid_ops | uuid | uuid | 1 + btree | pg_catalog | uuid_ops | uuid | uuid | 2 + hash | pg_catalog | uuid_ops | uuid | uuid | 1 + hash | pg_catalog | uuid_ops | uuid | uuid | 2 +(4 rows) + +\dAoc brin pg*.oid* + Index access method operator classes + Access method | Schema | Name | Family | Indexed type +---------------+------------+----------------+----------------+-------------- + brin | pg_catalog | oid_minmax_ops | oid_minmax_ops | oid +(1 row) + diff --git a/src/test/regress/sql/psql.sql b/src/test/regress/sql/psql.sql index b45da9bb8d..ffe0803767 100644 --- a/src/test/regress/sql/psql.sql +++ b/src/test/regress/sql/psql.sql @@ -688,3 +688,15 @@ select 1/(15-unique2) from tenk1 order by unique2 limit 19; \echo 'last error code:' :LAST_ERROR_SQLSTATE \unset FETCH_COUNT + +-- check printing info about access methods +\dA +\dA+ +\dA gin +\dA+ gin +\dAp gin +\dAfo brin uuid_minmax_ops +\dAfo * pg_catalog.jsonb_path_ops +\dAfp brin uuid_minmax_ops +\dAfp * pg_catalog.uuid_ops +\dAoc brin pg*.oid*