describe.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
bool	describeAggregates (const char *pattern, bool verbose, bool showSystem)
bool	describeAccessMethods (const char *pattern, bool verbose)
bool	describeTablespaces (const char *pattern, bool verbose)
bool	describeFunctions (const char *functypes, const char *func_pattern, char **arg_patterns, int num_arg_patterns, bool verbose, bool showSystem)
bool	describeTypes (const char *pattern, bool verbose, bool showSystem)
bool	describeOperators (const char *oper_pattern, char **arg_patterns, int num_arg_patterns, bool verbose, bool showSystem)
bool	describeRoles (const char *pattern, bool verbose, bool showSystem)
bool	listDbRoleSettings (const char *pattern, const char *pattern2)
bool	permissionsList (const char *pattern)
bool	listDefaultACLs (const char *pattern)
bool	objectDescription (const char *pattern, bool showSystem)
bool	describeTableDetails (const char *pattern, bool verbose, bool showSystem)
bool	listTSConfigs (const char *pattern, bool verbose)
bool	listTSParsers (const char *pattern, bool verbose)
bool	listTSDictionaries (const char *pattern, bool verbose)
bool	listTSTemplates (const char *pattern, bool verbose)
bool	listAllDbs (const char *pattern, bool verbose)
bool	listTables (const char *tabtypes, const char *pattern, bool verbose, bool showSystem)
bool	listPartitionedTables (const char *reltypes, const char *pattern, bool verbose)
bool	listDomains (const char *pattern, bool verbose, bool showSystem)
bool	listConversions (const char *pattern, bool verbose, bool showSystem)
bool	listCasts (const char *pattern, bool verbose)
bool	listCollations (const char *pattern, bool verbose, bool showSystem)
bool	listSchemas (const char *pattern, bool verbose, bool showSystem)
bool	listForeignDataWrappers (const char *pattern, bool verbose)
bool	listForeignServers (const char *pattern, bool verbose)
bool	listUserMappings (const char *pattern, bool verbose)
bool	listForeignTables (const char *pattern, bool verbose)
bool	listLanguages (const char *pattern, bool verbose, bool showSystem)
bool	listExtensions (const char *pattern)
bool	listExtensionContents (const char *pattern)
bool	listExtendedStats (const char *pattern)
bool	listEventTriggers (const char *pattern, bool verbose)
bool	listPublications (const char *pattern)
bool	describePublications (const char *pattern)
bool	describeSubscriptions (const char *pattern, bool verbose)
bool	listOperatorClasses (const char *access_method_pattern, const char *opclass_pattern, bool verbose)
bool	listOperatorFamilies (const char *access_method_pattern, const char *opclass_pattern, bool verbose)
bool	listOpFamilyOperators (const char *accessMethod_pattern, const char *family_pattern, bool verbose)
bool	listOpFamilyFunctions (const char *access_method_pattern, const char *family_pattern, bool verbose)

Function Documentation

describeAccessMethods()

bool describeAccessMethods	(	const char *	pattern,
		bool	verbose
	)

Definition at line 150 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] = {false, true, false, false};

    if (pset.sversion < 90600)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support access methods.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT amname AS \"%s\",\n"
                      "  CASE amtype"
                      " WHEN 'i' THEN '%s'"
                      " WHEN 't' THEN '%s'"
                      " END AS \"%s\"",
                      gettext_noop("Name"),
                      gettext_noop("Index"),
                      gettext_noop("Table"),
                      gettext_noop("Type"));

    if (verbose)
    {
        appendPQExpBuffer(&buf,
                          ",\n  amhandler AS \"%s\",\n"
                          "  pg_catalog.obj_description(oid, 'pg_am') AS \"%s\"",
                          gettext_noop("Handler"),
                          gettext_noop("Description"));
    }

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_am\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 = _("List of access methods");
    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;
}

describeAggregates()

bool describeAggregates	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 64 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname as \"%s\",\n"
                      "  p.proname AS \"%s\",\n"
                      "  pg_catalog.format_type(p.prorettype, NULL) AS \"%s\",\n",
                      gettext_noop("Schema"),
                      gettext_noop("Name"),
                      gettext_noop("Result data type"));

    if (pset.sversion >= 80400)
        appendPQExpBuffer(&buf,
                          "  CASE WHEN p.pronargs = 0\n"
                          "    THEN CAST('*' AS pg_catalog.text)\n"
                          "    ELSE pg_catalog.pg_get_function_arguments(p.oid)\n"
                          "  END AS \"%s\",\n",
                          gettext_noop("Argument data types"));
    else if (pset.sversion >= 80200)
        appendPQExpBuffer(&buf,
                          "  CASE WHEN p.pronargs = 0\n"
                          "    THEN CAST('*' AS pg_catalog.text)\n"
                          "    ELSE\n"
                          "    pg_catalog.array_to_string(ARRAY(\n"
                          "      SELECT\n"
                          "        pg_catalog.format_type(p.proargtypes[s.i], NULL)\n"
                          "      FROM\n"
                          "        pg_catalog.generate_series(0, pg_catalog.array_upper(p.proargtypes, 1)) AS s(i)\n"
                          "    ), ', ')\n"
                          "  END AS \"%s\",\n",
                          gettext_noop("Argument data types"));
    else
        appendPQExpBuffer(&buf,
                          "  pg_catalog.format_type(p.proargtypes[0], NULL) AS \"%s\",\n",
                          gettext_noop("Argument data types"));

    if (pset.sversion >= 110000)
        appendPQExpBuffer(&buf,
                          "  pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"\n"
                          "FROM pg_catalog.pg_proc p\n"
                          "     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n"
                          "WHERE p.prokind = 'a'\n",
                          gettext_noop("Description"));
    else
        appendPQExpBuffer(&buf,
                          "  pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"\n"
                          "FROM pg_catalog.pg_proc p\n"
                          "     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n"
                          "WHERE p.proisagg\n",
                          gettext_noop("Description"));

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf, "      AND n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          "n.nspname", "p.proname", NULL,
                          "pg_catalog.pg_function_is_visible(p.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 4;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of aggregate functions");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

describeFunctions()

bool describeFunctions	(	const char *	functypes,
		const char *	func_pattern,
		char **	arg_patterns,
		int	num_arg_patterns,
		bool	verbose,
		bool	showSystem
	)

Definition at line 316 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, i, initPQExpBuffer(), lengthof, _psqlSettings::logfile, map_typename_pattern(), printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, snprintf, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, printQueryOpt::translate_header, and typname.

Referenced by exec_command_dfo().

{
    bool        showAggregate = strchr(functypes, 'a') != NULL;
    bool        showNormal = strchr(functypes, 'n') != NULL;
    bool        showProcedure = strchr(functypes, 'p') != NULL;
    bool        showTrigger = strchr(functypes, 't') != NULL;
    bool        showWindow = strchr(functypes, 'w') != NULL;
    bool        have_where;
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] = {false, false, false, false, true, true, true, false, true, false, false, false, false};

    /* No "Parallel" column before 9.6 */
    static const bool translate_columns_pre_96[] = {false, false, false, false, true, true, false, true, false, false, false, false};

    if (strlen(functypes) != strspn(functypes, "anptwS+"))
    {
        pg_log_error("\\df only takes [anptwS+] as options");
        return true;
    }

    if (showProcedure && pset.sversion < 110000)
    {
        char        sverbuf[32];

        pg_log_error("\\df does not take a \"%c\" option with server version %s",
                     'p',
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    if (showWindow && pset.sversion < 80400)
    {
        char        sverbuf[32];

        pg_log_error("\\df does not take a \"%c\" option with server version %s",
                     'w',
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    if (!showAggregate && !showNormal && !showProcedure && !showTrigger && !showWindow)
    {
        showAggregate = showNormal = showTrigger = true;
        if (pset.sversion >= 110000)
            showProcedure = true;
        if (pset.sversion >= 80400)
            showWindow = true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname as \"%s\",\n"
                      "  p.proname as \"%s\",\n",
                      gettext_noop("Schema"),
                      gettext_noop("Name"));

    if (pset.sversion >= 110000)
        appendPQExpBuffer(&buf,
                          "  pg_catalog.pg_get_function_result(p.oid) as \"%s\",\n"
                          "  pg_catalog.pg_get_function_arguments(p.oid) as \"%s\",\n"
                          " CASE p.prokind\n"
                          "  WHEN 'a' THEN '%s'\n"
                          "  WHEN 'w' THEN '%s'\n"
                          "  WHEN 'p' THEN '%s'\n"
                          "  ELSE '%s'\n"
                          " END as \"%s\"",
                          gettext_noop("Result data type"),
                          gettext_noop("Argument data types"),
        /* translator: "agg" is short for "aggregate" */
                          gettext_noop("agg"),
                          gettext_noop("window"),
                          gettext_noop("proc"),
                          gettext_noop("func"),
                          gettext_noop("Type"));
    else if (pset.sversion >= 80400)
        appendPQExpBuffer(&buf,
                          "  pg_catalog.pg_get_function_result(p.oid) as \"%s\",\n"
                          "  pg_catalog.pg_get_function_arguments(p.oid) as \"%s\",\n"
                          " CASE\n"
                          "  WHEN p.proisagg THEN '%s'\n"
                          "  WHEN p.proiswindow THEN '%s'\n"
                          "  WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN '%s'\n"
                          "  ELSE '%s'\n"
                          " END as \"%s\"",
                          gettext_noop("Result data type"),
                          gettext_noop("Argument data types"),
        /* translator: "agg" is short for "aggregate" */
                          gettext_noop("agg"),
                          gettext_noop("window"),
                          gettext_noop("trigger"),
                          gettext_noop("func"),
                          gettext_noop("Type"));
    else if (pset.sversion >= 80100)
        appendPQExpBuffer(&buf,
                          "  CASE WHEN p.proretset THEN 'SETOF ' ELSE '' END ||\n"
                          "  pg_catalog.format_type(p.prorettype, NULL) as \"%s\",\n"
                          "  CASE WHEN proallargtypes IS NOT NULL THEN\n"
                          "    pg_catalog.array_to_string(ARRAY(\n"
                          "      SELECT\n"
                          "        CASE\n"
                          "          WHEN p.proargmodes[s.i] = 'i' THEN ''\n"
                          "          WHEN p.proargmodes[s.i] = 'o' THEN 'OUT '\n"
                          "          WHEN p.proargmodes[s.i] = 'b' THEN 'INOUT '\n"
                          "          WHEN p.proargmodes[s.i] = 'v' THEN 'VARIADIC '\n"
                          "        END ||\n"
                          "        CASE\n"
                          "          WHEN COALESCE(p.proargnames[s.i], '') = '' THEN ''\n"
                          "          ELSE p.proargnames[s.i] || ' '\n"
                          "        END ||\n"
                          "        pg_catalog.format_type(p.proallargtypes[s.i], NULL)\n"
                          "      FROM\n"
                          "        pg_catalog.generate_series(1, pg_catalog.array_upper(p.proallargtypes, 1)) AS s(i)\n"
                          "    ), ', ')\n"
                          "  ELSE\n"
                          "    pg_catalog.array_to_string(ARRAY(\n"
                          "      SELECT\n"
                          "        CASE\n"
                          "          WHEN COALESCE(p.proargnames[s.i+1], '') = '' THEN ''\n"
                          "          ELSE p.proargnames[s.i+1] || ' '\n"
                          "          END ||\n"
                          "        pg_catalog.format_type(p.proargtypes[s.i], NULL)\n"
                          "      FROM\n"
                          "        pg_catalog.generate_series(0, pg_catalog.array_upper(p.proargtypes, 1)) AS s(i)\n"
                          "    ), ', ')\n"
                          "  END AS \"%s\",\n"
                          "  CASE\n"
                          "    WHEN p.proisagg THEN '%s'\n"
                          "    WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN '%s'\n"
                          "    ELSE '%s'\n"
                          "  END AS \"%s\"",
                          gettext_noop("Result data type"),
                          gettext_noop("Argument data types"),
        /* translator: "agg" is short for "aggregate" */
                          gettext_noop("agg"),
                          gettext_noop("trigger"),
                          gettext_noop("func"),
                          gettext_noop("Type"));
    else
        appendPQExpBuffer(&buf,
                          "  CASE WHEN p.proretset THEN 'SETOF ' ELSE '' END ||\n"
                          "  pg_catalog.format_type(p.prorettype, NULL) as \"%s\",\n"
                          "  pg_catalog.oidvectortypes(p.proargtypes) as \"%s\",\n"
                          "  CASE\n"
                          "    WHEN p.proisagg THEN '%s'\n"
                          "    WHEN p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype THEN '%s'\n"
                          "    ELSE '%s'\n"
                          "  END AS \"%s\"",
                          gettext_noop("Result data type"),
                          gettext_noop("Argument data types"),
        /* translator: "agg" is short for "aggregate" */
                          gettext_noop("agg"),
                          gettext_noop("trigger"),
                          gettext_noop("func"),
                          gettext_noop("Type"));

    if (verbose)
    {
        appendPQExpBuffer(&buf,
                          ",\n CASE\n"
                          "  WHEN p.provolatile = 'i' THEN '%s'\n"
                          "  WHEN p.provolatile = 's' THEN '%s'\n"
                          "  WHEN p.provolatile = 'v' THEN '%s'\n"
                          " END as \"%s\"",
                          gettext_noop("immutable"),
                          gettext_noop("stable"),
                          gettext_noop("volatile"),
                          gettext_noop("Volatility"));
        if (pset.sversion >= 90600)
            appendPQExpBuffer(&buf,
                              ",\n CASE\n"
                              "  WHEN p.proparallel = 'r' THEN '%s'\n"
                              "  WHEN p.proparallel = 's' THEN '%s'\n"
                              "  WHEN p.proparallel = 'u' THEN '%s'\n"
                              " END as \"%s\"",
                              gettext_noop("restricted"),
                              gettext_noop("safe"),
                              gettext_noop("unsafe"),
                              gettext_noop("Parallel"));
        appendPQExpBuffer(&buf,
                          ",\n pg_catalog.pg_get_userbyid(p.proowner) as \"%s\""
                          ",\n CASE WHEN prosecdef THEN '%s' ELSE '%s' END AS \"%s\"",
                          gettext_noop("Owner"),
                          gettext_noop("definer"),
                          gettext_noop("invoker"),
                          gettext_noop("Security"));
        appendPQExpBufferStr(&buf, ",\n ");
        printACLColumn(&buf, "p.proacl");
        appendPQExpBuffer(&buf,
                          ",\n l.lanname as \"%s\"",
                          gettext_noop("Language"));
        if (pset.sversion >= 140000)
            appendPQExpBuffer(&buf,
                              ",\n COALESCE(pg_catalog.pg_get_function_sqlbody(p.oid), p.prosrc) as \"%s\"",
                              gettext_noop("Source code"));
        else
            appendPQExpBuffer(&buf,
                              ",\n p.prosrc as \"%s\"",
                              gettext_noop("Source code"));
        appendPQExpBuffer(&buf,
                          ",\n pg_catalog.obj_description(p.oid, 'pg_proc') as \"%s\"",
                          gettext_noop("Description"));
    }

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_proc p"
                         "\n     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n");

    for (int i = 0; i < num_arg_patterns; i++)
    {
        appendPQExpBuffer(&buf,
                          "     LEFT JOIN pg_catalog.pg_type t%d ON t%d.oid = p.proargtypes[%d]\n"
                          "     LEFT JOIN pg_catalog.pg_namespace nt%d ON nt%d.oid = t%d.typnamespace\n",
                          i, i, i, i, i, i);
    }

    if (verbose)
        appendPQExpBufferStr(&buf,
                             "     LEFT JOIN pg_catalog.pg_language l ON l.oid = p.prolang\n");

    have_where = false;

    /* filter by function type, if requested */
    if (showNormal && showAggregate && showProcedure && showTrigger && showWindow)
         /* Do nothing */ ;
    else if (showNormal)
    {
        if (!showAggregate)
        {
            if (have_where)
                appendPQExpBufferStr(&buf, "      AND ");
            else
            {
                appendPQExpBufferStr(&buf, "WHERE ");
                have_where = true;
            }
            if (pset.sversion >= 110000)
                appendPQExpBufferStr(&buf, "p.prokind <> 'a'\n");
            else
                appendPQExpBufferStr(&buf, "NOT p.proisagg\n");
        }
        if (!showProcedure && pset.sversion >= 110000)
        {
            if (have_where)
                appendPQExpBufferStr(&buf, "      AND ");
            else
            {
                appendPQExpBufferStr(&buf, "WHERE ");
                have_where = true;
            }
            appendPQExpBufferStr(&buf, "p.prokind <> 'p'\n");
        }
        if (!showTrigger)
        {
            if (have_where)
                appendPQExpBufferStr(&buf, "      AND ");
            else
            {
                appendPQExpBufferStr(&buf, "WHERE ");
                have_where = true;
            }
            appendPQExpBufferStr(&buf, "p.prorettype <> 'pg_catalog.trigger'::pg_catalog.regtype\n");
        }
        if (!showWindow && pset.sversion >= 80400)
        {
            if (have_where)
                appendPQExpBufferStr(&buf, "      AND ");
            else
            {
                appendPQExpBufferStr(&buf, "WHERE ");
                have_where = true;
            }
            if (pset.sversion >= 110000)
                appendPQExpBufferStr(&buf, "p.prokind <> 'w'\n");
            else
                appendPQExpBufferStr(&buf, "NOT p.proiswindow\n");
        }
    }
    else
    {
        bool        needs_or = false;

        appendPQExpBufferStr(&buf, "WHERE (\n       ");
        have_where = true;
        /* Note: at least one of these must be true ... */
        if (showAggregate)
        {
            if (pset.sversion >= 110000)
                appendPQExpBufferStr(&buf, "p.prokind = 'a'\n");
            else
                appendPQExpBufferStr(&buf, "p.proisagg\n");
            needs_or = true;
        }
        if (showTrigger)
        {
            if (needs_or)
                appendPQExpBufferStr(&buf, "       OR ");
            appendPQExpBufferStr(&buf,
                                 "p.prorettype = 'pg_catalog.trigger'::pg_catalog.regtype\n");
            needs_or = true;
        }
        if (showProcedure)
        {
            if (needs_or)
                appendPQExpBufferStr(&buf, "       OR ");
            appendPQExpBufferStr(&buf, "p.prokind = 'p'\n");
            needs_or = true;
        }
        if (showWindow)
        {
            if (needs_or)
                appendPQExpBufferStr(&buf, "       OR ");
            if (pset.sversion >= 110000)
                appendPQExpBufferStr(&buf, "p.prokind = 'w'\n");
            else
                appendPQExpBufferStr(&buf, "p.proiswindow\n");
        }
        appendPQExpBufferStr(&buf, "      )\n");
    }

    processSQLNamePattern(pset.db, &buf, func_pattern, have_where, false,
                          "n.nspname", "p.proname", NULL,
                          "pg_catalog.pg_function_is_visible(p.oid)");

    for (int i = 0; i < num_arg_patterns; i++)
    {
        if (strcmp(arg_patterns[i], "-") != 0)
        {
            /*
             * Match type-name patterns against either internal or external
             * name, like \dT.  Unlike \dT, there seems no reason to
             * discriminate against arrays or composite types.
             */
            char        nspname[64];
            char        typname[64];
            char        ft[64];
            char        tiv[64];

            snprintf(nspname, sizeof(nspname), "nt%d.nspname", i);
            snprintf(typname, sizeof(typname), "t%d.typname", i);
            snprintf(ft, sizeof(ft),
                     "pg_catalog.format_type(t%d.oid, NULL)", i);
            snprintf(tiv, sizeof(tiv),
                     "pg_catalog.pg_type_is_visible(t%d.oid)", i);
            processSQLNamePattern(pset.db, &buf,
                                  map_typename_pattern(arg_patterns[i]),
                                  true, false,
                                  nspname, typname, ft, tiv);
        }
        else
        {
            /* "-" pattern specifies no such parameter */
            appendPQExpBuffer(&buf, "  AND t%d.typname IS NULL\n", i);
        }
    }

    if (!showSystem && !func_pattern)
        appendPQExpBufferStr(&buf, "      AND n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 4;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of functions");
    myopt.translate_header = true;
    if (pset.sversion >= 90600)
    {
        myopt.translate_columns = translate_columns;
        myopt.n_translate_columns = lengthof(translate_columns);
    }
    else
    {
        myopt.translate_columns = translate_columns_pre_96;
        myopt.n_translate_columns = lengthof(translate_columns_pre_96);
    }

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

describeOperators()

bool describeOperators	(	const char *	oper_pattern,
		char **	arg_patterns,
		int	num_arg_patterns,
		bool	verbose,
		bool	showSystem
	)

Definition at line 890 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, i, initPQExpBuffer(), _psqlSettings::logfile, map_typename_pattern(), printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, snprintf, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_header, and typname.

Referenced by exec_command_dfo().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    initPQExpBuffer(&buf);

    /*
     * Note: before Postgres 9.1, we did not assign comments to any built-in
     * operators, preferring to let the comment on the underlying function
     * suffice.  The coalesce() on the obj_description() calls below supports
     * this convention by providing a fallback lookup of a comment on the
     * operator's function.  As of 9.1 there is a policy that every built-in
     * operator should have a comment; so the coalesce() is no longer
     * necessary so far as built-in operators are concerned.  We keep it
     * anyway, for now, because (1) third-party modules may still be following
     * the old convention, and (2) we'd need to do it anyway when talking to a
     * pre-9.1 server.
     *
     * The support for postfix operators in this query is dead code as of
     * Postgres 14, but we need to keep it for as long as we support talking
     * to pre-v14 servers.
     */

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname as \"%s\",\n"
                      "  o.oprname AS \"%s\",\n"
                      "  CASE WHEN o.oprkind='l' THEN NULL ELSE pg_catalog.format_type(o.oprleft, NULL) END AS \"%s\",\n"
                      "  CASE WHEN o.oprkind='r' THEN NULL ELSE pg_catalog.format_type(o.oprright, NULL) END AS \"%s\",\n"
                      "  pg_catalog.format_type(o.oprresult, NULL) AS \"%s\",\n",
                      gettext_noop("Schema"),
                      gettext_noop("Name"),
                      gettext_noop("Left arg type"),
                      gettext_noop("Right arg type"),
                      gettext_noop("Result type"));

    if (verbose)
        appendPQExpBuffer(&buf,
                          "  o.oprcode AS \"%s\",\n",
                          gettext_noop("Function"));

    appendPQExpBuffer(&buf,
                      "  coalesce(pg_catalog.obj_description(o.oid, 'pg_operator'),\n"
                      "           pg_catalog.obj_description(o.oprcode, 'pg_proc')) AS \"%s\"\n"
                      "FROM pg_catalog.pg_operator o\n"
                      "     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = o.oprnamespace\n",
                      gettext_noop("Description"));

    if (num_arg_patterns >= 2)
    {
        num_arg_patterns = 2;   /* ignore any additional arguments */
        appendPQExpBufferStr(&buf,
                             "     LEFT JOIN pg_catalog.pg_type t0 ON t0.oid = o.oprleft\n"
                             "     LEFT JOIN pg_catalog.pg_namespace nt0 ON nt0.oid = t0.typnamespace\n"
                             "     LEFT JOIN pg_catalog.pg_type t1 ON t1.oid = o.oprright\n"
                             "     LEFT JOIN pg_catalog.pg_namespace nt1 ON nt1.oid = t1.typnamespace\n");
    }
    else if (num_arg_patterns == 1)
    {
        appendPQExpBufferStr(&buf,
                             "     LEFT JOIN pg_catalog.pg_type t0 ON t0.oid = o.oprright\n"
                             "     LEFT JOIN pg_catalog.pg_namespace nt0 ON nt0.oid = t0.typnamespace\n");
    }

    if (!showSystem && !oper_pattern)
        appendPQExpBufferStr(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    processSQLNamePattern(pset.db, &buf, oper_pattern,
                          !showSystem && !oper_pattern, true,
                          "n.nspname", "o.oprname", NULL,
                          "pg_catalog.pg_operator_is_visible(o.oid)");

    if (num_arg_patterns == 1)
        appendPQExpBufferStr(&buf, "  AND o.oprleft = 0\n");

    for (int i = 0; i < num_arg_patterns; i++)
    {
        if (strcmp(arg_patterns[i], "-") != 0)
        {
            /*
             * Match type-name patterns against either internal or external
             * name, like \dT.  Unlike \dT, there seems no reason to
             * discriminate against arrays or composite types.
             */
            char        nspname[64];
            char        typname[64];
            char        ft[64];
            char        tiv[64];

            snprintf(nspname, sizeof(nspname), "nt%d.nspname", i);
            snprintf(typname, sizeof(typname), "t%d.typname", i);
            snprintf(ft, sizeof(ft),
                     "pg_catalog.format_type(t%d.oid, NULL)", i);
            snprintf(tiv, sizeof(tiv),
                     "pg_catalog.pg_type_is_visible(t%d.oid)", i);
            processSQLNamePattern(pset.db, &buf,
                                  map_typename_pattern(arg_patterns[i]),
                                  true, false,
                                  nspname, typname, ft, tiv);
        }
        else
        {
            /* "-" pattern specifies no such parameter */
            appendPQExpBuffer(&buf, "  AND t%d.typname IS NULL\n", i);
        }
    }

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 3, 4;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of operators");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

describePublications()

bool describePublications

(

const char *

pattern

)

Definition at line 6219 of file describe.c.

References _, appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, i, initPQExpBuffer(), _psqlSettings::logfile, pg_log_error, _psqlSettings::popt, PQclear(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), printTable(), printTableAddCell(), printTableAddFooter(), printTableAddHeader(), printTableCleanup(), printTableInit(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::quiet, _psqlSettings::sversion, termPQExpBuffer(), and printQueryOpt::topt.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    int         i;
    PGresult   *res;
    bool        has_pubtruncate;
    bool        has_pubviaroot;

    if (pset.sversion < 100000)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support publications.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    has_pubtruncate = (pset.sversion >= 110000);
    has_pubviaroot = (pset.sversion >= 130000);

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT oid, pubname,\n"
                      "  pg_catalog.pg_get_userbyid(pubowner) AS owner,\n"
                      "  puballtables, pubinsert, pubupdate, pubdelete");
    if (has_pubtruncate)
        appendPQExpBufferStr(&buf,
                             ", pubtruncate");
    if (has_pubviaroot)
        appendPQExpBufferStr(&buf,
                             ", pubviaroot");
    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_publication\n");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          NULL, "pubname", NULL,
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 2;");

    res = PSQLexec(buf.data);
    if (!res)
    {
        termPQExpBuffer(&buf);
        return false;
    }

    if (PQntuples(res) == 0)
    {
        if (!pset.quiet)
        {
            if (pattern)
                pg_log_error("Did not find any publication named \"%s\".",
                             pattern);
            else
                pg_log_error("Did not find any publications.");
        }

        termPQExpBuffer(&buf);
        PQclear(res);
        return false;
    }

    for (i = 0; i < PQntuples(res); i++)
    {
        const char  align = 'l';
        int         ncols = 5;
        int         nrows = 1;
        int         tables = 0;
        PGresult   *tabres;
        char       *pubid = PQgetvalue(res, i, 0);
        char       *pubname = PQgetvalue(res, i, 1);
        bool        puballtables = strcmp(PQgetvalue(res, i, 3), "t") == 0;
        int         j;
        PQExpBufferData title;
        printTableOpt myopt = pset.popt.topt;
        printTableContent cont;

        if (has_pubtruncate)
            ncols++;
        if (has_pubviaroot)
            ncols++;

        initPQExpBuffer(&title);
        printfPQExpBuffer(&title, _("Publication %s"), pubname);
        printTableInit(&cont, &myopt, title.data, ncols, nrows);

        printTableAddHeader(&cont, gettext_noop("Owner"), true, align);
        printTableAddHeader(&cont, gettext_noop("All tables"), true, align);
        printTableAddHeader(&cont, gettext_noop("Inserts"), true, align);
        printTableAddHeader(&cont, gettext_noop("Updates"), true, align);
        printTableAddHeader(&cont, gettext_noop("Deletes"), true, align);
        if (has_pubtruncate)
            printTableAddHeader(&cont, gettext_noop("Truncates"), true, align);
        if (has_pubviaroot)
            printTableAddHeader(&cont, gettext_noop("Via root"), true, align);

        printTableAddCell(&cont, PQgetvalue(res, i, 2), false, false);
        printTableAddCell(&cont, PQgetvalue(res, i, 3), false, false);
        printTableAddCell(&cont, PQgetvalue(res, i, 4), false, false);
        printTableAddCell(&cont, PQgetvalue(res, i, 5), false, false);
        printTableAddCell(&cont, PQgetvalue(res, i, 6), false, false);
        if (has_pubtruncate)
            printTableAddCell(&cont, PQgetvalue(res, i, 7), false, false);
        if (has_pubviaroot)
            printTableAddCell(&cont, PQgetvalue(res, i, 8), false, false);

        if (!puballtables)
        {
            printfPQExpBuffer(&buf,
                              "SELECT n.nspname, c.relname\n"
                              "FROM pg_catalog.pg_class c,\n"
                              "     pg_catalog.pg_namespace n,\n"
                              "     pg_catalog.pg_publication_rel pr\n"
                              "WHERE c.relnamespace = n.oid\n"
                              "  AND c.oid = pr.prrelid\n"
                              "  AND pr.prpubid = '%s'\n"
                              "ORDER BY 1,2", pubid);

            tabres = PSQLexec(buf.data);
            if (!tabres)
            {
                printTableCleanup(&cont);
                PQclear(res);
                termPQExpBuffer(&buf);
                termPQExpBuffer(&title);
                return false;
            }
            else
                tables = PQntuples(tabres);

            if (tables > 0)
                printTableAddFooter(&cont, _("Tables:"));

            for (j = 0; j < tables; j++)
            {
                printfPQExpBuffer(&buf, "    \"%s.%s\"",
                                  PQgetvalue(tabres, j, 0),
                                  PQgetvalue(tabres, j, 1));

                printTableAddFooter(&cont, buf.data);
            }
            PQclear(tabres);
        }

        printTable(&cont, pset.queryFout, false, pset.logfile);
        printTableCleanup(&cont);

        termPQExpBuffer(&title);
    }

    termPQExpBuffer(&buf);
    PQclear(res);

    return true;
}

describeRoles()

bool describeRoles	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 3738 of file describe.c.

References _, add_role_attribute(), appendPQExpBuffer(), appendPQExpBufferChar(), appendPQExpBufferStr(), buf, conns, PQExpBufferData::data, _psqlSettings::db, printTableOpt::default_footer, free, gettext_noop, i, initPQExpBuffer(), PQExpBufferData::len, _psqlSettings::logfile, ngettext, pg_malloc0(), pg_strdup(), _psqlSettings::popt, PQclear(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), printTable(), printTableAddCell(), printTableAddHeader(), printTableCleanup(), printTableInit(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, resetPQExpBuffer(), _psqlSettings::sversion, termPQExpBuffer(), and printQueryOpt::topt.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printTableContent cont;
    printTableOpt myopt = pset.popt.topt;
    int         ncols = 3;
    int         nrows = 0;
    int         i;
    int         conns;
    const char  align = 'l';
    char      **attr;

    myopt.default_footer = false;

    initPQExpBuffer(&buf);

    if (pset.sversion >= 80100)
    {
        printfPQExpBuffer(&buf,
                          "SELECT r.rolname, r.rolsuper, r.rolinherit,\n"
                          "  r.rolcreaterole, r.rolcreatedb, r.rolcanlogin,\n"
                          "  r.rolconnlimit, r.rolvaliduntil,\n"
                          "  ARRAY(SELECT b.rolname\n"
                          "        FROM pg_catalog.pg_auth_members m\n"
                          "        JOIN pg_catalog.pg_roles b ON (m.roleid = b.oid)\n"
                          "        WHERE m.member = r.oid) as memberof");

        if (verbose && pset.sversion >= 80200)
        {
            appendPQExpBufferStr(&buf, "\n, pg_catalog.shobj_description(r.oid, 'pg_authid') AS description");
            ncols++;
        }
        if (pset.sversion >= 90100)
        {
            appendPQExpBufferStr(&buf, "\n, r.rolreplication");
        }

        if (pset.sversion >= 90500)
        {
            appendPQExpBufferStr(&buf, "\n, r.rolbypassrls");
        }

        appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_roles r\n");

        if (!showSystem && !pattern)
            appendPQExpBufferStr(&buf, "WHERE r.rolname !~ '^pg_'\n");

        processSQLNamePattern(pset.db, &buf, pattern, false, false,
                              NULL, "r.rolname", NULL, NULL);
    }
    else
    {
        printfPQExpBuffer(&buf,
                          "SELECT u.usename AS rolname,\n"
                          "  u.usesuper AS rolsuper,\n"
                          "  true AS rolinherit, false AS rolcreaterole,\n"
                          "  u.usecreatedb AS rolcreatedb, true AS rolcanlogin,\n"
                          "  -1 AS rolconnlimit,"
                          "  u.valuntil as rolvaliduntil,\n"
                          "  ARRAY(SELECT g.groname FROM pg_catalog.pg_group g WHERE u.usesysid = ANY(g.grolist)) as memberof"
                          "\nFROM pg_catalog.pg_user u\n");

        processSQLNamePattern(pset.db, &buf, pattern, false, false,
                              NULL, "u.usename", NULL, NULL);
    }

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    if (!res)
        return false;

    nrows = PQntuples(res);
    attr = pg_malloc0((nrows + 1) * sizeof(*attr));

    printTableInit(&cont, &myopt, _("List of roles"), ncols, nrows);

    printTableAddHeader(&cont, gettext_noop("Role name"), true, align);
    printTableAddHeader(&cont, gettext_noop("Attributes"), true, align);
    /* ignores implicit memberships from superuser & pg_database_owner */
    printTableAddHeader(&cont, gettext_noop("Member of"), true, align);

    if (verbose && pset.sversion >= 80200)
        printTableAddHeader(&cont, gettext_noop("Description"), true, align);

    for (i = 0; i < nrows; i++)
    {
        printTableAddCell(&cont, PQgetvalue(res, i, 0), false, false);

        resetPQExpBuffer(&buf);
        if (strcmp(PQgetvalue(res, i, 1), "t") == 0)
            add_role_attribute(&buf, _("Superuser"));

        if (strcmp(PQgetvalue(res, i, 2), "t") != 0)
            add_role_attribute(&buf, _("No inheritance"));

        if (strcmp(PQgetvalue(res, i, 3), "t") == 0)
            add_role_attribute(&buf, _("Create role"));

        if (strcmp(PQgetvalue(res, i, 4), "t") == 0)
            add_role_attribute(&buf, _("Create DB"));

        if (strcmp(PQgetvalue(res, i, 5), "t") != 0)
            add_role_attribute(&buf, _("Cannot login"));

        if (pset.sversion >= 90100)
            if (strcmp(PQgetvalue(res, i, (verbose ? 10 : 9)), "t") == 0)
                add_role_attribute(&buf, _("Replication"));

        if (pset.sversion >= 90500)
            if (strcmp(PQgetvalue(res, i, (verbose ? 11 : 10)), "t") == 0)
                add_role_attribute(&buf, _("Bypass RLS"));

        conns = atoi(PQgetvalue(res, i, 6));
        if (conns >= 0)
        {
            if (buf.len > 0)
                appendPQExpBufferChar(&buf, '\n');

            if (conns == 0)
                appendPQExpBufferStr(&buf, _("No connections"));
            else
                appendPQExpBuffer(&buf, ngettext("%d connection",
                                                 "%d connections",
                                                 conns),
                                  conns);
        }

        if (strcmp(PQgetvalue(res, i, 7), "") != 0)
        {
            if (buf.len > 0)
                appendPQExpBufferChar(&buf, '\n');
            appendPQExpBufferStr(&buf, _("Password valid until "));
            appendPQExpBufferStr(&buf, PQgetvalue(res, i, 7));
        }

        attr[i] = pg_strdup(buf.data);

        printTableAddCell(&cont, attr[i], false, false);

        printTableAddCell(&cont, PQgetvalue(res, i, 8), false, false);

        if (verbose && pset.sversion >= 80200)
            printTableAddCell(&cont, PQgetvalue(res, i, 9), false, false);
    }
    termPQExpBuffer(&buf);

    printTable(&cont, pset.queryFout, false, pset.logfile);
    printTableCleanup(&cont);

    for (i = 0; i < nrows; i++)
        free(attr[i]);
    free(attr);

    PQclear(res);
    return true;
}

describeSubscriptions()

bool describeSubscriptions	(	const char *	pattern,
		bool	verbose
	)

Definition at line 6385 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] = {false, false, false, false,
    false, false, false, false, false};

    if (pset.sversion < 100000)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support subscriptions.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT subname AS \"%s\"\n"
                      ",  pg_catalog.pg_get_userbyid(subowner) AS \"%s\"\n"
                      ",  subenabled AS \"%s\"\n"
                      ",  subpublications AS \"%s\"\n",
                      gettext_noop("Name"),
                      gettext_noop("Owner"),
                      gettext_noop("Enabled"),
                      gettext_noop("Publication"));

    if (verbose)
    {
        /* Binary mode and streaming are only supported in v14 and higher */
        if (pset.sversion >= 140000)
            appendPQExpBuffer(&buf,
                              ", subbinary AS \"%s\"\n"
                              ", substream AS \"%s\"\n",
                              gettext_noop("Binary"),
                              gettext_noop("Streaming"));

        /* Two_phase is only supported in v15 and higher */
        if (pset.sversion >= 150000)
            appendPQExpBuffer(&buf,
                              ", subtwophasestate AS \"%s\"\n",
                              gettext_noop("Two phase commit"));

        appendPQExpBuffer(&buf,
                          ",  subsynccommit AS \"%s\"\n"
                          ",  subconninfo AS \"%s\"\n",
                          gettext_noop("Synchronous commit"),
                          gettext_noop("Conninfo"));
    }

    /* Only display subscriptions in current database. */
    appendPQExpBufferStr(&buf,
                         "FROM pg_catalog.pg_subscription\n"
                         "WHERE subdbid = (SELECT oid\n"
                         "                 FROM pg_catalog.pg_database\n"
                         "                 WHERE datname = pg_catalog.current_database())");

    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          NULL, "subname", NULL,
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of subscriptions");
    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;
}

describeTableDetails()

bool describeTableDetails	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 1532 of file describe.c.

References appendPQExpBufferStr(), buf, cancel_pressed, PQExpBufferData::data, _psqlSettings::db, describeOneTableDetails(), i, initPQExpBuffer(), pg_log_error, PQclear(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::quiet, relname, and termPQExpBuffer().

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    int         i;

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT c.oid,\n"
                      "  n.nspname,\n"
                      "  c.relname\n"
                      "FROM pg_catalog.pg_class c\n"
                      "     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n");

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf, "WHERE n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    processSQLNamePattern(pset.db, &buf, pattern, !showSystem && !pattern, false,
                          "n.nspname", "c.relname", NULL,
                          "pg_catalog.pg_table_is_visible(c.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 2, 3;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    if (PQntuples(res) == 0)
    {
        if (!pset.quiet)
        {
            if (pattern)
                pg_log_error("Did not find any relation named \"%s\".",
                             pattern);
            else
                pg_log_error("Did not find any relations.");
        }
        PQclear(res);
        return false;
    }

    for (i = 0; i < PQntuples(res); i++)
    {
        const char *oid;
        const char *nspname;
        const char *relname;

        oid = PQgetvalue(res, i, 0);
        nspname = PQgetvalue(res, i, 1);
        relname = PQgetvalue(res, i, 2);

        if (!describeOneTableDetails(nspname, relname, oid, verbose))
        {
            PQclear(res);
            return false;
        }
        if (cancel_pressed)
        {
            PQclear(res);
            return false;
        }
    }

    PQclear(res);
    return true;
}

describeTablespaces()

bool describeTablespaces	(	const char *	pattern,
		bool	verbose
	)

Definition at line 220 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, pg_log_info, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    if (pset.sversion < 80000)
    {
        char        sverbuf[32];

        pg_log_info("The server (version %s) does not support tablespaces.",
                    formatPGVersionNumber(pset.sversion, false,
                                          sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);

    if (pset.sversion >= 90200)
        printfPQExpBuffer(&buf,
                          "SELECT spcname AS \"%s\",\n"
                          "  pg_catalog.pg_get_userbyid(spcowner) AS \"%s\",\n"
                          "  pg_catalog.pg_tablespace_location(oid) AS \"%s\"",
                          gettext_noop("Name"),
                          gettext_noop("Owner"),
                          gettext_noop("Location"));
    else
        printfPQExpBuffer(&buf,
                          "SELECT spcname AS \"%s\",\n"
                          "  pg_catalog.pg_get_userbyid(spcowner) AS \"%s\",\n"
                          "  spclocation AS \"%s\"",
                          gettext_noop("Name"),
                          gettext_noop("Owner"),
                          gettext_noop("Location"));

    if (verbose)
    {
        appendPQExpBufferStr(&buf, ",\n  ");
        printACLColumn(&buf, "spcacl");
    }

    if (verbose && pset.sversion >= 90000)
        appendPQExpBuffer(&buf,
                          ",\n  spcoptions AS \"%s\"",
                          gettext_noop("Options"));

    if (verbose && pset.sversion >= 90200)
        appendPQExpBuffer(&buf,
                          ",\n  pg_catalog.pg_size_pretty(pg_catalog.pg_tablespace_size(oid)) AS \"%s\"",
                          gettext_noop("Size"));

    if (verbose && pset.sversion >= 80200)
        appendPQExpBuffer(&buf,
                          ",\n  pg_catalog.shobj_description(oid, 'pg_tablespace') AS \"%s\"",
                          gettext_noop("Description"));

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_tablespace\n");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          NULL, "spcname", NULL,
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of tablespaces");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

describeTypes()

bool describeTypes	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 716 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, CppAsString2, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, map_typename_pattern(), printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname as \"%s\",\n"
                      "  pg_catalog.format_type(t.oid, NULL) AS \"%s\",\n",
                      gettext_noop("Schema"),
                      gettext_noop("Name"));
    if (verbose)
        appendPQExpBuffer(&buf,
                          "  t.typname AS \"%s\",\n"
                          "  CASE WHEN t.typrelid != 0\n"
                          "      THEN CAST('tuple' AS pg_catalog.text)\n"
                          "    WHEN t.typlen < 0\n"
                          "      THEN CAST('var' AS pg_catalog.text)\n"
                          "    ELSE CAST(t.typlen AS pg_catalog.text)\n"
                          "  END AS \"%s\",\n",
                          gettext_noop("Internal name"),
                          gettext_noop("Size"));
    if (verbose && pset.sversion >= 80300)
    {
        appendPQExpBufferStr(&buf,
                             "  pg_catalog.array_to_string(\n"
                             "      ARRAY(\n"
                             "          SELECT e.enumlabel\n"
                             "          FROM pg_catalog.pg_enum e\n"
                             "          WHERE e.enumtypid = t.oid\n");

        if (pset.sversion >= 90100)
            appendPQExpBufferStr(&buf,
                                 "          ORDER BY e.enumsortorder\n");
        else
            appendPQExpBufferStr(&buf,
                                 "          ORDER BY e.oid\n");

        appendPQExpBuffer(&buf,
                          "      ),\n"
                          "      E'\\n'\n"
                          "  ) AS \"%s\",\n",
                          gettext_noop("Elements"));
    }
    if (verbose)
    {
        appendPQExpBuffer(&buf,
                          "  pg_catalog.pg_get_userbyid(t.typowner) AS \"%s\",\n",
                          gettext_noop("Owner"));
    }
    if (verbose && pset.sversion >= 90200)
    {
        printACLColumn(&buf, "t.typacl");
        appendPQExpBufferStr(&buf, ",\n  ");
    }

    appendPQExpBuffer(&buf,
                      "  pg_catalog.obj_description(t.oid, 'pg_type') as \"%s\"\n",
                      gettext_noop("Description"));

    appendPQExpBufferStr(&buf, "FROM pg_catalog.pg_type t\n"
                         "     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n");

    /*
     * do not include complex types (typrelid!=0) unless they are standalone
     * composite types
     */
    appendPQExpBufferStr(&buf, "WHERE (t.typrelid = 0 ");
    appendPQExpBufferStr(&buf, "OR (SELECT c.relkind = " CppAsString2(RELKIND_COMPOSITE_TYPE)
                         " FROM pg_catalog.pg_class c "
                         "WHERE c.oid = t.typrelid))\n");

    /*
     * do not include array types unless the pattern contains [] (before 8.3
     * we have to use the assumption that their names start with underscore)
     */
    if (pattern == NULL || strstr(pattern, "[]") == NULL)
    {
        if (pset.sversion >= 80300)
            appendPQExpBufferStr(&buf, "  AND NOT EXISTS(SELECT 1 FROM pg_catalog.pg_type el WHERE el.oid = t.typelem AND el.typarray = t.oid)\n");
        else
            appendPQExpBufferStr(&buf, "  AND t.typname !~ '^_'\n");
    }

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf, "      AND n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    /* Match name pattern against either internal or external name */
    processSQLNamePattern(pset.db, &buf, map_typename_pattern(pattern),
                          true, false,
                          "n.nspname", "t.typname",
                          "pg_catalog.format_type(t.oid, NULL)",
                          "pg_catalog.pg_type_is_visible(t.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of data types");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listAllDbs()

bool listAllDbs	(	const char *	pattern,
		bool	verbose
	)

Definition at line 1025 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_list(), and main().

{
    PGresult   *res;
    PQExpBufferData buf;
    printQueryOpt myopt = pset.popt;

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT d.datname as \"%s\",\n"
                      "       pg_catalog.pg_get_userbyid(d.datdba) as \"%s\",\n"
                      "       pg_catalog.pg_encoding_to_char(d.encoding) as \"%s\",\n",
                      gettext_noop("Name"),
                      gettext_noop("Owner"),
                      gettext_noop("Encoding"));
    if (pset.sversion >= 80400)
        appendPQExpBuffer(&buf,
                          "       d.datcollate as \"%s\",\n"
                          "       d.datctype as \"%s\",\n",
                          gettext_noop("Collate"),
                          gettext_noop("Ctype"));
    appendPQExpBufferStr(&buf, "       ");
    printACLColumn(&buf, "d.datacl");
    if (verbose && pset.sversion >= 80200)
        appendPQExpBuffer(&buf,
                          ",\n       CASE WHEN pg_catalog.has_database_privilege(d.datname, 'CONNECT')\n"
                          "            THEN pg_catalog.pg_size_pretty(pg_catalog.pg_database_size(d.datname))\n"
                          "            ELSE 'No Access'\n"
                          "       END as \"%s\"",
                          gettext_noop("Size"));
    if (verbose && pset.sversion >= 80000)
        appendPQExpBuffer(&buf,
                          ",\n       t.spcname as \"%s\"",
                          gettext_noop("Tablespace"));
    if (verbose && pset.sversion >= 80200)
        appendPQExpBuffer(&buf,
                          ",\n       pg_catalog.shobj_description(d.oid, 'pg_database') as \"%s\"",
                          gettext_noop("Description"));
    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_database d\n");
    if (verbose && pset.sversion >= 80000)
        appendPQExpBufferStr(&buf,
                             "  JOIN pg_catalog.pg_tablespace t on d.dattablespace = t.oid\n");

    if (pattern)
        processSQLNamePattern(pset.db, &buf, pattern, false, false,
                              NULL, "d.datname", NULL, NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");
    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of databases");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listCasts()

bool listCasts	(	const char *	pattern,
		bool	verbose
	)

Definition at line 4801 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] = {false, false, false, true, false};

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT pg_catalog.format_type(castsource, NULL) AS \"%s\",\n"
                      "       pg_catalog.format_type(casttarget, NULL) AS \"%s\",\n",
                      gettext_noop("Source type"),
                      gettext_noop("Target type"));

    /*
     * We don't attempt to localize '(binary coercible)' or '(with inout)',
     * because there's too much risk of gettext translating a function name
     * that happens to match some string in the PO database.
     */
    if (pset.sversion >= 80400)
        appendPQExpBuffer(&buf,
                          "       CASE WHEN c.castmethod = '%c' THEN '(binary coercible)'\n"
                          "            WHEN c.castmethod = '%c' THEN '(with inout)'\n"
                          "            ELSE p.proname\n"
                          "       END AS \"%s\",\n",
                          COERCION_METHOD_BINARY,
                          COERCION_METHOD_INOUT,
                          gettext_noop("Function"));
    else
        appendPQExpBuffer(&buf,
                          "       CASE WHEN c.castfunc = 0 THEN '(binary coercible)'\n"
                          "            ELSE p.proname\n"
                          "       END AS \"%s\",\n",
                          gettext_noop("Function"));

    appendPQExpBuffer(&buf,
                      "       CASE WHEN c.castcontext = '%c' THEN '%s'\n"
                      "            WHEN c.castcontext = '%c' THEN '%s'\n"
                      "            ELSE '%s'\n"
                      "       END AS \"%s\"",
                      COERCION_CODE_EXPLICIT,
                      gettext_noop("no"),
                      COERCION_CODE_ASSIGNMENT,
                      gettext_noop("in assignment"),
                      gettext_noop("yes"),
                      gettext_noop("Implicit?"));

    if (verbose)
        appendPQExpBuffer(&buf,
                          ",\n       d.description AS \"%s\"",
                          gettext_noop("Description"));

    /*
     * We need a left join to pg_proc for binary casts; the others are just
     * paranoia.
     */
    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_cast c LEFT JOIN pg_catalog.pg_proc p\n"
                         "     ON c.castfunc = p.oid\n"
                         "     LEFT JOIN pg_catalog.pg_type ts\n"
                         "     ON c.castsource = ts.oid\n"
                         "     LEFT JOIN pg_catalog.pg_namespace ns\n"
                         "     ON ns.oid = ts.typnamespace\n"
                         "     LEFT JOIN pg_catalog.pg_type tt\n"
                         "     ON c.casttarget = tt.oid\n"
                         "     LEFT JOIN pg_catalog.pg_namespace nt\n"
                         "     ON nt.oid = tt.typnamespace\n");

    if (verbose)
        appendPQExpBufferStr(&buf,
                             "     LEFT JOIN pg_catalog.pg_description d\n"
                             "     ON d.classoid = c.tableoid AND d.objoid = "
                             "c.oid AND d.objsubid = 0\n");

    appendPQExpBufferStr(&buf, "WHERE ( (true");

    /*
     * Match name pattern against either internal or external name of either
     * castsource or casttarget
     */
    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          "ns.nspname", "ts.typname",
                          "pg_catalog.format_type(ts.oid, NULL)",
                          "pg_catalog.pg_type_is_visible(ts.oid)");

    appendPQExpBufferStr(&buf, ") OR (true");

    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          "nt.nspname", "tt.typname",
                          "pg_catalog.format_type(tt.oid, NULL)",
                          "pg_catalog.pg_type_is_visible(tt.oid)");

    appendPQExpBufferStr(&buf, ") )\nORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of casts");
    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;
}

listCollations()

bool listCollations	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 4919 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] = {false, false, false, false, false, true, false};

    if (pset.sversion < 90100)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support collations.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname AS \"%s\",\n"
                      "       c.collname AS \"%s\",\n"
                      "       c.collcollate AS \"%s\",\n"
                      "       c.collctype AS \"%s\"",
                      gettext_noop("Schema"),
                      gettext_noop("Name"),
                      gettext_noop("Collate"),
                      gettext_noop("Ctype"));

    if (pset.sversion >= 100000)
        appendPQExpBuffer(&buf,
                          ",\n       CASE c.collprovider WHEN 'd' THEN 'default' WHEN 'c' THEN 'libc' WHEN 'i' THEN 'icu' END AS \"%s\"",
                          gettext_noop("Provider"));
    else
        appendPQExpBuffer(&buf,
                          ",\n       'libc' AS \"%s\"",
                          gettext_noop("Provider"));

    if (pset.sversion >= 120000)
        appendPQExpBuffer(&buf,
                          ",\n       CASE WHEN c.collisdeterministic THEN '%s' ELSE '%s' END AS \"%s\"",
                          gettext_noop("yes"), gettext_noop("no"),
                          gettext_noop("Deterministic?"));
    else
        appendPQExpBuffer(&buf,
                          ",\n       '%s' AS \"%s\"",
                          gettext_noop("yes"),
                          gettext_noop("Deterministic?"));

    if (verbose)
        appendPQExpBuffer(&buf,
                          ",\n       pg_catalog.obj_description(c.oid, 'pg_collation') AS \"%s\"",
                          gettext_noop("Description"));

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_collation c, pg_catalog.pg_namespace n\n"
                         "WHERE n.oid = c.collnamespace\n");

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf, "      AND n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    /*
     * Hide collations that aren't usable in the current database's encoding.
     * If you think to change this, note that pg_collation_is_visible rejects
     * unusable collations, so you will need to hack name pattern processing
     * somehow to avoid inconsistent behavior.
     */
    appendPQExpBufferStr(&buf, "      AND c.collencoding IN (-1, pg_catalog.pg_char_to_encoding(pg_catalog.getdatabaseencoding()))\n");

    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          "n.nspname", "c.collname", NULL,
                          "pg_catalog.pg_collation_is_visible(c.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of collations");
    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;
}

listConversions()

bool listConversions	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 4567 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] =
    {false, false, false, false, true, false};

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname AS \"%s\",\n"
                      "       c.conname AS \"%s\",\n"
                      "       pg_catalog.pg_encoding_to_char(c.conforencoding) AS \"%s\",\n"
                      "       pg_catalog.pg_encoding_to_char(c.contoencoding) AS \"%s\",\n"
                      "       CASE WHEN c.condefault THEN '%s'\n"
                      "       ELSE '%s' END AS \"%s\"",
                      gettext_noop("Schema"),
                      gettext_noop("Name"),
                      gettext_noop("Source"),
                      gettext_noop("Destination"),
                      gettext_noop("yes"), gettext_noop("no"),
                      gettext_noop("Default?"));

    if (verbose)
        appendPQExpBuffer(&buf,
                          ",\n       d.description AS \"%s\"",
                          gettext_noop("Description"));

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_conversion c\n"
                         "     JOIN pg_catalog.pg_namespace n "
                         "ON n.oid = c.connamespace\n");

    if (verbose)
        appendPQExpBufferStr(&buf,
                             "LEFT JOIN pg_catalog.pg_description d "
                             "ON d.classoid = c.tableoid\n"
                             "          AND d.objoid = c.oid "
                             "AND d.objsubid = 0\n");

    appendPQExpBufferStr(&buf, "WHERE true\n");

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf, "  AND n.nspname <> 'pg_catalog'\n"
                             "  AND n.nspname <> 'information_schema'\n");

    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          "n.nspname", "c.conname", NULL,
                          "pg_catalog.pg_conversion_is_visible(c.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of conversions");
    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;
}

listDbRoleSettings()

bool listDbRoleSettings	(	const char *	pattern,
		const char *	pattern2
	)

Definition at line 3910 of file describe.c.

References _, appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), PQntuples(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::quiet, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    bool        havewhere;

    if (pset.sversion < 90000)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support per-database role settings.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf, "SELECT rolname AS \"%s\", datname AS \"%s\",\n"
                      "pg_catalog.array_to_string(setconfig, E'\\n') AS \"%s\"\n"
                      "FROM pg_catalog.pg_db_role_setting s\n"
                      "LEFT JOIN pg_catalog.pg_database d ON d.oid = setdatabase\n"
                      "LEFT JOIN pg_catalog.pg_roles r ON r.oid = setrole\n",
                      gettext_noop("Role"),
                      gettext_noop("Database"),
                      gettext_noop("Settings"));
    havewhere = processSQLNamePattern(pset.db, &buf, pattern, false, false,
                                      NULL, "r.rolname", NULL, NULL);
    processSQLNamePattern(pset.db, &buf, pattern2, havewhere, false,
                          NULL, "d.datname", NULL, NULL);
    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    /*
     * Most functions in this file are content to print an empty table when
     * there are no matching objects.  We intentionally deviate from that
     * here, but only in !quiet mode, because of the possibility that the user
     * is confused about what the two pattern arguments mean.
     */
    if (PQntuples(res) == 0 && !pset.quiet)
    {
        if (pattern && pattern2)
            pg_log_error("Did not find any settings for role \"%s\" and database \"%s\".",
                         pattern, pattern2);
        else if (pattern)
            pg_log_error("Did not find any settings for role \"%s\".",
                         pattern);
        else
            pg_log_error("Did not find any settings.");
    }
    else
    {
        myopt.nullPrint = NULL;
        myopt.title = _("List of settings");
        myopt.translate_header = true;

        printQuery(res, &myopt, pset.queryFout, false, pset.logfile);
    }

    PQclear(res);
    return true;
}

listDefaultACLs()

bool listDefaultACLs

(

const char *

pattern

)

Definition at line 1255 of file describe.c.

References _, appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] = {false, false, true, false};

    if (pset.sversion < 90000)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support altering default privileges.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT pg_catalog.pg_get_userbyid(d.defaclrole) AS \"%s\",\n"
                      "  n.nspname AS \"%s\",\n"
                      "  CASE d.defaclobjtype WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' WHEN '%c' THEN '%s' END AS \"%s\",\n"
                      "  ",
                      gettext_noop("Owner"),
                      gettext_noop("Schema"),
                      DEFACLOBJ_RELATION,
                      gettext_noop("table"),
                      DEFACLOBJ_SEQUENCE,
                      gettext_noop("sequence"),
                      DEFACLOBJ_FUNCTION,
                      gettext_noop("function"),
                      DEFACLOBJ_TYPE,
                      gettext_noop("type"),
                      DEFACLOBJ_NAMESPACE,
                      gettext_noop("schema"),
                      gettext_noop("Type"));

    printACLColumn(&buf, "d.defaclacl");

    appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_default_acl d\n"
                         "     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = d.defaclnamespace\n");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          NULL,
                          "n.nspname",
                          "pg_catalog.pg_get_userbyid(d.defaclrole)",
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 3;");

    res = PSQLexec(buf.data);
    if (!res)
    {
        termPQExpBuffer(&buf);
        return false;
    }

    myopt.nullPrint = NULL;
    printfPQExpBuffer(&buf, _("Default access privileges"));
    myopt.title = buf.data;
    myopt.translate_header = true;
    myopt.translate_columns = translate_columns;
    myopt.n_translate_columns = lengthof(translate_columns);

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    termPQExpBuffer(&buf);
    PQclear(res);
    return true;
}

listDomains()

bool listDomains	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 4481 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname as \"%s\",\n"
                      "       t.typname as \"%s\",\n"
                      "       pg_catalog.format_type(t.typbasetype, t.typtypmod) as \"%s\",\n",
                      gettext_noop("Schema"),
                      gettext_noop("Name"),
                      gettext_noop("Type"));

    if (pset.sversion >= 90100)
        appendPQExpBuffer(&buf,
                          "       (SELECT c.collname FROM pg_catalog.pg_collation c, pg_catalog.pg_type bt\n"
                          "        WHERE c.oid = t.typcollation AND bt.oid = t.typbasetype AND t.typcollation <> bt.typcollation) as \"%s\",\n",
                          gettext_noop("Collation"));
    appendPQExpBuffer(&buf,
                      "       CASE WHEN t.typnotnull THEN 'not null' END as \"%s\",\n"
                      "       t.typdefault as \"%s\",\n"
                      "       pg_catalog.array_to_string(ARRAY(\n"
                      "         SELECT pg_catalog.pg_get_constraintdef(r.oid, true) FROM pg_catalog.pg_constraint r WHERE t.oid = r.contypid\n"
                      "       ), ' ') as \"%s\"",
                      gettext_noop("Nullable"),
                      gettext_noop("Default"),
                      gettext_noop("Check"));

    if (verbose)
    {
        if (pset.sversion >= 90200)
        {
            appendPQExpBufferStr(&buf, ",\n  ");
            printACLColumn(&buf, "t.typacl");
        }
        appendPQExpBuffer(&buf,
                          ",\n       d.description as \"%s\"",
                          gettext_noop("Description"));
    }

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_type t\n"
                         "     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n");

    if (verbose)
        appendPQExpBufferStr(&buf,
                             "     LEFT JOIN pg_catalog.pg_description d "
                             "ON d.classoid = t.tableoid AND d.objoid = t.oid "
                             "AND d.objsubid = 0\n");

    appendPQExpBufferStr(&buf, "WHERE t.typtype = 'd'\n");

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf, "      AND n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          "n.nspname", "t.typname", NULL,
                          "pg_catalog.pg_type_is_visible(t.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of domains");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listEventTriggers()

bool listEventTriggers	(	const char *	pattern,
		bool	verbose
	)

Definition at line 4643 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] =
    {false, false, false, true, false, false, false};

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT evtname as \"%s\", "
                      "evtevent as \"%s\", "
                      "pg_catalog.pg_get_userbyid(e.evtowner) as \"%s\",\n"
                      " case evtenabled when 'O' then '%s'"
                      "  when 'R' then '%s'"
                      "  when 'A' then '%s'"
                      "  when 'D' then '%s' end as \"%s\",\n"
                      " e.evtfoid::pg_catalog.regproc as \"%s\", "
                      "pg_catalog.array_to_string(array(select x"
                      " from pg_catalog.unnest(evttags) as t(x)), ', ') as \"%s\"",
                      gettext_noop("Name"),
                      gettext_noop("Event"),
                      gettext_noop("Owner"),
                      gettext_noop("enabled"),
                      gettext_noop("replica"),
                      gettext_noop("always"),
                      gettext_noop("disabled"),
                      gettext_noop("Enabled"),
                      gettext_noop("Function"),
                      gettext_noop("Tags"));
    if (verbose)
        appendPQExpBuffer(&buf,
                          ",\npg_catalog.obj_description(e.oid, 'pg_event_trigger') as \"%s\"",
                          gettext_noop("Description"));
    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_event_trigger e ");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          NULL, "evtname", NULL, NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of event triggers");
    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;
}

listExtendedStats()

bool listExtendedStats

(

const char *

pattern

)

Definition at line 4709 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    if (pset.sversion < 100000)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support extended statistics.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);
    printfPQExpBuffer(&buf,
                      "SELECT \n"
                      "es.stxnamespace::pg_catalog.regnamespace::text AS \"%s\", \n"
                      "es.stxname AS \"%s\", \n",
                      gettext_noop("Schema"),
                      gettext_noop("Name"));

    if (pset.sversion >= 140000)
        appendPQExpBuffer(&buf,
                          "pg_catalog.format('%%s FROM %%s', \n"
                          "  pg_catalog.pg_get_statisticsobjdef_columns(es.oid), \n"
                          "  es.stxrelid::pg_catalog.regclass) AS \"%s\"",
                          gettext_noop("Definition"));
    else
        appendPQExpBuffer(&buf,
                          "pg_catalog.format('%%s FROM %%s', \n"
                          "  (SELECT pg_catalog.string_agg(pg_catalog.quote_ident(a.attname),', ') \n"
                          "   FROM pg_catalog.unnest(es.stxkeys) s(attnum) \n"
                          "   JOIN pg_catalog.pg_attribute a \n"
                          "   ON (es.stxrelid = a.attrelid \n"
                          "   AND a.attnum = s.attnum \n"
                          "   AND NOT a.attisdropped)), \n"
                          "es.stxrelid::pg_catalog.regclass) AS \"%s\"",
                          gettext_noop("Definition"));

    appendPQExpBuffer(&buf,
                      ",\nCASE WHEN 'd' = any(es.stxkind) THEN 'defined' \n"
                      "END AS \"%s\", \n"
                      "CASE WHEN 'f' = any(es.stxkind) THEN 'defined' \n"
                      "END AS \"%s\"",
                      gettext_noop("Ndistinct"),
                      gettext_noop("Dependencies"));

    /*
     * Include the MCV statistics kind.
     */
    if (pset.sversion >= 120000)
    {
        appendPQExpBuffer(&buf,
                          ",\nCASE WHEN 'm' = any(es.stxkind) THEN 'defined' \n"
                          "END AS \"%s\" ",
                          gettext_noop("MCV"));
    }

    appendPQExpBufferStr(&buf,
                         " \nFROM pg_catalog.pg_statistic_ext es \n");

    processSQLNamePattern(pset.db, &buf, pattern,
                          false, false,
                          "es.stxnamespace::pg_catalog.regnamespace::text", "es.stxname",
                          NULL, "pg_catalog.pg_statistics_obj_is_visible(es.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of extended statistics");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listExtensionContents()

bool listExtensionContents

(

const char *

pattern

)

Definition at line 6031 of file describe.c.

References appendPQExpBufferStr(), buf, cancel_pressed, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), i, initPQExpBuffer(), listOneExtensionContents(), pg_log_error, PQclear(), PQgetvalue(), PQntuples(), printfPQExpBuffer(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::quiet, _psqlSettings::sversion, and termPQExpBuffer().

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    int         i;

    if (pset.sversion < 90100)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support extensions.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);
    printfPQExpBuffer(&buf,
                      "SELECT e.extname, e.oid\n"
                      "FROM pg_catalog.pg_extension e\n");

    processSQLNamePattern(pset.db, &buf, pattern,
                          false, false,
                          NULL, "e.extname", NULL,
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    if (PQntuples(res) == 0)
    {
        if (!pset.quiet)
        {
            if (pattern)
                pg_log_error("Did not find any extension named \"%s\".",
                             pattern);
            else
                pg_log_error("Did not find any extensions.");
        }
        PQclear(res);
        return false;
    }

    for (i = 0; i < PQntuples(res); i++)
    {
        const char *extname;
        const char *oid;

        extname = PQgetvalue(res, i, 0);
        oid = PQgetvalue(res, i, 1);

        if (!listOneExtensionContents(extname, oid))
        {
            PQclear(res);
            return false;
        }
        if (cancel_pressed)
        {
            PQclear(res);
            return false;
        }
    }

    PQclear(res);
    return true;
}

listExtensions()

bool listExtensions

(

const char *

pattern

)

Definition at line 5974 of file describe.c.

References _, appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    if (pset.sversion < 90100)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support extensions.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);
    printfPQExpBuffer(&buf,
                      "SELECT e.extname AS \"%s\", "
                      "e.extversion AS \"%s\", n.nspname AS \"%s\", c.description AS \"%s\"\n"
                      "FROM pg_catalog.pg_extension e "
                      "LEFT JOIN pg_catalog.pg_namespace n ON n.oid = e.extnamespace "
                      "LEFT JOIN pg_catalog.pg_description c ON c.objoid = e.oid "
                      "AND c.classoid = 'pg_catalog.pg_extension'::pg_catalog.regclass\n",
                      gettext_noop("Name"),
                      gettext_noop("Version"),
                      gettext_noop("Schema"),
                      gettext_noop("Description"));

    processSQLNamePattern(pset.db, &buf, pattern,
                          false, false,
                          NULL, "e.extname", NULL,
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of installed extensions");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listForeignDataWrappers()

bool listForeignDataWrappers	(	const char *	pattern,
		bool	verbose
	)

Definition at line 5670 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    if (pset.sversion < 80400)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support foreign-data wrappers.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);
    printfPQExpBuffer(&buf,
                      "SELECT fdw.fdwname AS \"%s\",\n"
                      "  pg_catalog.pg_get_userbyid(fdw.fdwowner) AS \"%s\",\n",
                      gettext_noop("Name"),
                      gettext_noop("Owner"));
    if (pset.sversion >= 90100)
        appendPQExpBuffer(&buf,
                          "  fdw.fdwhandler::pg_catalog.regproc AS \"%s\",\n",
                          gettext_noop("Handler"));
    appendPQExpBuffer(&buf,
                      "  fdw.fdwvalidator::pg_catalog.regproc AS \"%s\"",
                      gettext_noop("Validator"));

    if (verbose)
    {
        appendPQExpBufferStr(&buf, ",\n  ");
        printACLColumn(&buf, "fdwacl");
        appendPQExpBuffer(&buf,
                          ",\n CASE WHEN fdwoptions IS NULL THEN '' ELSE "
                          "  '(' || pg_catalog.array_to_string(ARRAY(SELECT "
                          "  pg_catalog.quote_ident(option_name) ||  ' ' || "
                          "  pg_catalog.quote_literal(option_value)  FROM "
                          "  pg_catalog.pg_options_to_table(fdwoptions)),  ', ') || ')' "
                          "  END AS \"%s\"",
                          gettext_noop("FDW options"));

        if (pset.sversion >= 90100)
            appendPQExpBuffer(&buf,
                              ",\n  d.description AS \"%s\" ",
                              gettext_noop("Description"));
    }

    appendPQExpBufferStr(&buf, "\nFROM pg_catalog.pg_foreign_data_wrapper fdw\n");

    if (verbose && pset.sversion >= 90100)
        appendPQExpBufferStr(&buf,
                             "LEFT JOIN pg_catalog.pg_description d\n"
                             "       ON d.classoid = fdw.tableoid "
                             "AND d.objoid = fdw.oid AND d.objsubid = 0\n");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          NULL, "fdwname", NULL, NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of foreign-data wrappers");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listForeignServers()

bool listForeignServers	(	const char *	pattern,
		bool	verbose
	)

Definition at line 5753 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    if (pset.sversion < 80400)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support foreign servers.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);
    printfPQExpBuffer(&buf,
                      "SELECT s.srvname AS \"%s\",\n"
                      "  pg_catalog.pg_get_userbyid(s.srvowner) AS \"%s\",\n"
                      "  f.fdwname AS \"%s\"",
                      gettext_noop("Name"),
                      gettext_noop("Owner"),
                      gettext_noop("Foreign-data wrapper"));

    if (verbose)
    {
        appendPQExpBufferStr(&buf, ",\n  ");
        printACLColumn(&buf, "s.srvacl");
        appendPQExpBuffer(&buf,
                          ",\n"
                          "  s.srvtype AS \"%s\",\n"
                          "  s.srvversion AS \"%s\",\n"
                          "  CASE WHEN srvoptions IS NULL THEN '' ELSE "
                          "  '(' || pg_catalog.array_to_string(ARRAY(SELECT "
                          "  pg_catalog.quote_ident(option_name) ||  ' ' || "
                          "  pg_catalog.quote_literal(option_value)  FROM "
                          "  pg_catalog.pg_options_to_table(srvoptions)),  ', ') || ')' "
                          "  END AS \"%s\",\n"
                          "  d.description AS \"%s\"",
                          gettext_noop("Type"),
                          gettext_noop("Version"),
                          gettext_noop("FDW options"),
                          gettext_noop("Description"));
    }

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_foreign_server s\n"
                         "     JOIN pg_catalog.pg_foreign_data_wrapper f ON f.oid=s.srvfdw\n");

    if (verbose)
        appendPQExpBufferStr(&buf,
                             "LEFT JOIN pg_catalog.pg_description d\n       "
                             "ON d.classoid = s.tableoid AND d.objoid = s.oid "
                             "AND d.objsubid = 0\n");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          NULL, "s.srvname", NULL, NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of foreign servers");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listForeignTables()

bool listForeignTables	(	const char *	pattern,
		bool	verbose
	)

Definition at line 5896 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    if (pset.sversion < 90100)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support foreign tables.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);
    printfPQExpBuffer(&buf,
                      "SELECT n.nspname AS \"%s\",\n"
                      "  c.relname AS \"%s\",\n"
                      "  s.srvname AS \"%s\"",
                      gettext_noop("Schema"),
                      gettext_noop("Table"),
                      gettext_noop("Server"));

    if (verbose)
        appendPQExpBuffer(&buf,
                          ",\n CASE WHEN ftoptions IS NULL THEN '' ELSE "
                          "  '(' || pg_catalog.array_to_string(ARRAY(SELECT "
                          "  pg_catalog.quote_ident(option_name) ||  ' ' || "
                          "  pg_catalog.quote_literal(option_value)  FROM "
                          "  pg_catalog.pg_options_to_table(ftoptions)),  ', ') || ')' "
                          "  END AS \"%s\",\n"
                          "  d.description AS \"%s\"",
                          gettext_noop("FDW options"),
                          gettext_noop("Description"));

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_foreign_table ft\n"
                         "  INNER JOIN pg_catalog.pg_class c"
                         " ON c.oid = ft.ftrelid\n"
                         "  INNER JOIN pg_catalog.pg_namespace n"
                         " ON n.oid = c.relnamespace\n"
                         "  INNER JOIN pg_catalog.pg_foreign_server s"
                         " ON s.oid = ft.ftserver\n");
    if (verbose)
        appendPQExpBufferStr(&buf,
                             "   LEFT JOIN pg_catalog.pg_description d\n"
                             "          ON d.classoid = c.tableoid AND "
                             "d.objoid = c.oid AND d.objsubid = 0\n");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          "n.nspname", "c.relname", NULL,
                          "pg_catalog.pg_table_is_visible(c.oid)");

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of foreign tables");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listLanguages()

bool listLanguages	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 4406 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT l.lanname AS \"%s\",\n",
                      gettext_noop("Name"));
    if (pset.sversion >= 80300)
        appendPQExpBuffer(&buf,
                          "       pg_catalog.pg_get_userbyid(l.lanowner) as \"%s\",\n",
                          gettext_noop("Owner"));

    appendPQExpBuffer(&buf,
                      "       l.lanpltrusted AS \"%s\"",
                      gettext_noop("Trusted"));

    if (verbose)
    {
        appendPQExpBuffer(&buf,
                          ",\n       NOT l.lanispl AS \"%s\",\n"
                          "       l.lanplcallfoid::pg_catalog.regprocedure AS \"%s\",\n"
                          "       l.lanvalidator::pg_catalog.regprocedure AS \"%s\",\n       ",
                          gettext_noop("Internal language"),
                          gettext_noop("Call handler"),
                          gettext_noop("Validator"));
        if (pset.sversion >= 90000)
            appendPQExpBuffer(&buf, "l.laninline::pg_catalog.regprocedure AS \"%s\",\n       ",
                              gettext_noop("Inline handler"));
        printACLColumn(&buf, "l.lanacl");
    }

    appendPQExpBuffer(&buf,
                      ",\n       d.description AS \"%s\""
                      "\nFROM pg_catalog.pg_language l\n"
                      "LEFT JOIN pg_catalog.pg_description d\n"
                      "  ON d.classoid = l.tableoid AND d.objoid = l.oid\n"
                      "  AND d.objsubid = 0\n",
                      gettext_noop("Description"));

    if (pattern)
        processSQLNamePattern(pset.db, &buf, pattern, false, false,
                              NULL, "l.lanname", NULL, NULL);

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf, "WHERE l.lanplcallfoid != 0\n");


    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of languages");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}

listOperatorClasses()

bool listOperatorClasses	(	const char *	access_method_pattern,
		const char *	opclass_pattern,
		bool	verbose
	)

Definition at line 6495 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    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\n"
                      "  am.amname AS \"%s\",\n"
                      "  pg_catalog.format_type(c.opcintype, NULL) AS \"%s\",\n"
                      "  CASE\n"
                      "    WHEN c.opckeytype <> 0 AND c.opckeytype <> c.opcintype\n"
                      "    THEN pg_catalog.format_type(c.opckeytype, NULL)\n"
                      "    ELSE NULL\n"
                      "  END AS \"%s\",\n"
                      "  CASE\n"
                      "    WHEN pg_catalog.pg_opclass_is_visible(c.oid)\n"
                      "    THEN pg_catalog.format('%%I', c.opcname)\n"
                      "    ELSE pg_catalog.format('%%I.%%I', n.nspname, c.opcname)\n"
                      "  END AS \"%s\",\n"
                      "  (CASE WHEN c.opcdefault\n"
                      "    THEN '%s'\n"
                      "    ELSE '%s'\n"
                      "  END) AS \"%s\"",
                      gettext_noop("AM"),
                      gettext_noop("Input type"),
                      gettext_noop("Storage type"),
                      gettext_noop("Operator class"),
                      gettext_noop("yes"),
                      gettext_noop("no"),
                      gettext_noop("Default?"));
    if (verbose)
        appendPQExpBuffer(&buf,
                          ",\n  CASE\n"
                          "    WHEN pg_catalog.pg_opfamily_is_visible(of.oid)\n"
                          "    THEN pg_catalog.format('%%I', of.opfname)\n"
                          "    ELSE pg_catalog.format('%%I.%%I', ofn.nspname, of.opfname)\n"
                          "  END AS \"%s\",\n"
                          " pg_catalog.pg_get_userbyid(c.opcowner) AS \"%s\"\n",
                          gettext_noop("Operator family"),
                          gettext_noop("Owner"));
    appendPQExpBufferStr(&buf,
                         "\nFROM 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_type t ON t.oid = c.opcintype\n"
                         "  LEFT JOIN pg_catalog.pg_namespace tn ON tn.oid = t.typnamespace\n");
    if (verbose)
        appendPQExpBufferStr(&buf,
                             "  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 (type_pattern)
    {
        /* Match type name pattern against either internal or external name */
        processSQLNamePattern(pset.db, &buf, type_pattern, have_where, false,
                              "tn.nspname", "t.typname",
                              "pg_catalog.format_type(t.oid, NULL)",
                              "pg_catalog.pg_type_is_visible(t.oid)");
    }

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2, 4;");
    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of 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;
}

listOperatorFamilies()

bool listOperatorFamilies	(	const char *	access_method_pattern,
		const char *	opclass_pattern,
		bool	verbose
	)

Definition at line 6589 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    bool        have_where = false;
    static const bool translate_columns[] = {false, false, false, false};

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT\n"
                      "  am.amname AS \"%s\",\n"
                      "  CASE\n"
                      "    WHEN pg_catalog.pg_opfamily_is_visible(f.oid)\n"
                      "    THEN pg_catalog.format('%%I', f.opfname)\n"
                      "    ELSE pg_catalog.format('%%I.%%I', n.nspname, f.opfname)\n"
                      "  END AS \"%s\",\n"
                      "  (SELECT\n"
                      "     pg_catalog.string_agg(pg_catalog.format_type(oc.opcintype, NULL), ', ')\n"
                      "   FROM pg_catalog.pg_opclass oc\n"
                      "   WHERE oc.opcfamily = f.oid) \"%s\"",
                      gettext_noop("AM"),
                      gettext_noop("Operator family"),
                      gettext_noop("Applicable types"));
    if (verbose)
        appendPQExpBuffer(&buf,
                          ",\n  pg_catalog.pg_get_userbyid(f.opfowner) AS \"%s\"\n",
                          gettext_noop("Owner"));
    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_opfamily f\n"
                         "  LEFT JOIN pg_catalog.pg_am am on am.oid = f.opfmethod\n"
                         "  LEFT JOIN pg_catalog.pg_namespace n ON n.oid = f.opfnamespace\n");

    if (access_method_pattern)
        have_where = processSQLNamePattern(pset.db, &buf, access_method_pattern,
                                           false, false, NULL, "am.amname", NULL, NULL);
    if (type_pattern)
    {
        appendPQExpBuffer(&buf,
                          "  %s EXISTS (\n"
                          "    SELECT 1\n"
                          "    FROM pg_catalog.pg_type t\n"
                          "    JOIN pg_catalog.pg_opclass oc ON oc.opcintype = t.oid\n"
                          "    LEFT JOIN pg_catalog.pg_namespace tn ON tn.oid = t.typnamespace\n"
                          "    WHERE oc.opcfamily = f.oid\n",
                          have_where ? "AND" : "WHERE");
        /* Match type name pattern against either internal or external name */
        processSQLNamePattern(pset.db, &buf, type_pattern, true, false,
                              "tn.nspname", "t.typname",
                              "pg_catalog.format_type(t.oid, NULL)",
                              "pg_catalog.pg_type_is_visible(t.oid)");
        appendPQExpBufferStr(&buf, "  )\n");
    }

    appendPQExpBufferStr(&buf, "ORDER BY 1, 2;");
    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of operator families");
    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;
}

listOpFamilyFunctions()

bool listOpFamilyFunctions	(	const char *	access_method_pattern,
		const char *	family_pattern,
		bool	verbose
	)

Definition at line 6758 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    bool        have_where = false;
    static const bool translate_columns[] = {false, false, false, false, false, false};

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT\n"
                      "  am.amname AS \"%s\",\n"
                      "  CASE\n"
                      "    WHEN pg_catalog.pg_opfamily_is_visible(of.oid)\n"
                      "    THEN pg_catalog.format('%%I', of.opfname)\n"
                      "    ELSE pg_catalog.format('%%I.%%I', ns.nspname, of.opfname)\n"
                      "  END 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("Operator family"),
                      gettext_noop("Registered left type"),
                      gettext_noop("Registered right type"),
                      gettext_noop("Number"));

    if (!verbose)
        appendPQExpBuffer(&buf,
                          ", p.proname AS \"%s\"\n",
                          gettext_noop("Function"));
    else
        appendPQExpBuffer(&buf,
                          ", ap.amproc::pg_catalog.regprocedure AS \"%s\"\n",
                          gettext_noop("Function"));

    appendPQExpBufferStr(&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"
                         "  LEFT JOIN pg_catalog.pg_proc p ON ap.amproc = p.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,\n"
                         "  ap.amproclefttype = ap.amprocrighttype DESC,\n"
                         "  3, 4, 5;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of support functions of operator families");
    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;
}

listOpFamilyOperators()

bool listOpFamilyOperators	(	const char *	accessMethod_pattern,
		const char *	family_pattern,
		bool	verbose
	)

Definition at line 6671 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    bool        have_where = false;

    static const bool translate_columns[] = {false, false, false, false, false, false};

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT\n"
                      "  am.amname AS \"%s\",\n"
                      "  CASE\n"
                      "    WHEN pg_catalog.pg_opfamily_is_visible(of.oid)\n"
                      "    THEN pg_catalog.format('%%I', of.opfname)\n"
                      "    ELSE pg_catalog.format('%%I.%%I', nsf.nspname, of.opfname)\n"
                      "  END AS \"%s\",\n"
                      "  o.amopopr::pg_catalog.regoperator AS \"%s\"\n,"
                      "  o.amopstrategy AS \"%s\",\n"
                      "  CASE o.amoppurpose\n"
                      "    WHEN 'o' THEN '%s'\n"
                      "    WHEN 's' THEN '%s'\n"
                      "  END AS \"%s\"\n",
                      gettext_noop("AM"),
                      gettext_noop("Operator family"),
                      gettext_noop("Operator"),
                      gettext_noop("Strategy"),
                      gettext_noop("ordering"),
                      gettext_noop("search"),
                      gettext_noop("Purpose"));

    if (verbose)
        appendPQExpBuffer(&buf,
                          ", ofs.opfname AS \"%s\"\n",
                          gettext_noop("Sort opfamily"));
    appendPQExpBufferStr(&buf,
                         "FROM pg_catalog.pg_amop o\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)
        appendPQExpBufferStr(&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,\n"
                         "  o.amoplefttype = o.amoprighttype DESC,\n"
                         "  pg_catalog.format_type(o.amoplefttype, NULL),\n"
                         "  pg_catalog.format_type(o.amoprighttype, NULL),\n"
                         "  o.amopstrategy;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of operators of operator families");
    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;
}

listPartitionedTables()

bool listPartitionedTables	(	const char *	reltypes,
		const char *	pattern,
		bool	verbose
	)

Definition at line 4210 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, CppAsString2, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    bool        showTables = strchr(reltypes, 't') != NULL;
    bool        showIndexes = strchr(reltypes, 'i') != NULL;
    bool        showNested = strchr(reltypes, 'n') != NULL;
    PQExpBufferData buf;
    PQExpBufferData title;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    bool        translate_columns[] = {false, false, false, false, false, false, false, false, false};
    const char *tabletitle;
    bool        mixed_output = false;

    /*
     * Note: Declarative table partitioning is only supported as of Pg 10.0.
     */
    if (pset.sversion < 100000)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support declarative table partitioning.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    /* If no relation kind was selected, show them all */
    if (!showTables && !showIndexes)
        showTables = showIndexes = true;

    if (showIndexes && !showTables)
        tabletitle = _("List of partitioned indexes");  /* \dPi */
    else if (showTables && !showIndexes)
        tabletitle = _("List of partitioned tables");   /* \dPt */
    else
    {
        /* show all kinds */
        tabletitle = _("List of partitioned relations");
        mixed_output = true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT n.nspname as \"%s\",\n"
                      "  c.relname as \"%s\",\n"
                      "  pg_catalog.pg_get_userbyid(c.relowner) as \"%s\"",
                      gettext_noop("Schema"),
                      gettext_noop("Name"),
                      gettext_noop("Owner"));

    if (mixed_output)
    {
        appendPQExpBuffer(&buf,
                          ",\n  CASE c.relkind"
                          " WHEN " CppAsString2(RELKIND_PARTITIONED_TABLE) " THEN '%s'"
                          " WHEN " CppAsString2(RELKIND_PARTITIONED_INDEX) " THEN '%s'"
                          " END as \"%s\"",
                          gettext_noop("partitioned table"),
                          gettext_noop("partitioned index"),
                          gettext_noop("Type"));

        translate_columns[3] = true;
    }

    if (showNested || pattern)
        appendPQExpBuffer(&buf,
                          ",\n  inh.inhparent::pg_catalog.regclass as \"%s\"",
                          gettext_noop("Parent name"));

    if (showIndexes)
        appendPQExpBuffer(&buf,
                          ",\n c2.oid::pg_catalog.regclass as \"%s\"",
                          gettext_noop("Table"));

    if (verbose)
    {
        if (showNested)
        {
            appendPQExpBuffer(&buf,
                              ",\n  s.dps as \"%s\"",
                              gettext_noop("Leaf partition size"));
            appendPQExpBuffer(&buf,
                              ",\n  s.tps as \"%s\"",
                              gettext_noop("Total size"));
        }
        else
            /* Sizes of all partitions are considered in this case. */
            appendPQExpBuffer(&buf,
                              ",\n  s.tps as \"%s\"",
                              gettext_noop("Total size"));

        appendPQExpBuffer(&buf,
                          ",\n  pg_catalog.obj_description(c.oid, 'pg_class') as \"%s\"",
                          gettext_noop("Description"));
    }

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_class c"
                         "\n     LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace");

    if (showIndexes)
        appendPQExpBufferStr(&buf,
                             "\n     LEFT JOIN pg_catalog.pg_index i ON i.indexrelid = c.oid"
                             "\n     LEFT JOIN pg_catalog.pg_class c2 ON i.indrelid = c2.oid");

    if (showNested || pattern)
        appendPQExpBufferStr(&buf,
                             "\n     LEFT JOIN pg_catalog.pg_inherits inh ON c.oid = inh.inhrelid");

    if (verbose)
    {
        if (pset.sversion < 120000)
        {
            appendPQExpBufferStr(&buf,
                                 ",\n     LATERAL (WITH RECURSIVE d\n"
                                 "                AS (SELECT inhrelid AS oid, 1 AS level\n"
                                 "                      FROM pg_catalog.pg_inherits\n"
                                 "                     WHERE inhparent = c.oid\n"
                                 "                    UNION ALL\n"
                                 "                    SELECT inhrelid, level + 1\n"
                                 "                      FROM pg_catalog.pg_inherits i\n"
                                 "                           JOIN d ON i.inhparent = d.oid)\n"
                                 "                SELECT pg_catalog.pg_size_pretty(sum(pg_catalog.pg_table_size("
                                 "d.oid))) AS tps,\n"
                                 "                       pg_catalog.pg_size_pretty(sum("
                                 "\n             CASE WHEN d.level = 1"
                                 " THEN pg_catalog.pg_table_size(d.oid) ELSE 0 END)) AS dps\n"
                                 "               FROM d) s");
        }
        else
        {
            /* PostgreSQL 12 has pg_partition_tree function */
            appendPQExpBufferStr(&buf,
                                 ",\n     LATERAL (SELECT pg_catalog.pg_size_pretty(sum("
                                 "\n                 CASE WHEN ppt.isleaf AND ppt.level = 1"
                                 "\n                      THEN pg_catalog.pg_table_size(ppt.relid)"
                                 " ELSE 0 END)) AS dps"
                                 ",\n                     pg_catalog.pg_size_pretty(sum("
                                 "pg_catalog.pg_table_size(ppt.relid))) AS tps"
                                 "\n              FROM pg_catalog.pg_partition_tree(c.oid) ppt) s");
        }
    }

    appendPQExpBufferStr(&buf, "\nWHERE c.relkind IN (");
    if (showTables)
        appendPQExpBufferStr(&buf, CppAsString2(RELKIND_PARTITIONED_TABLE) ",");
    if (showIndexes)
        appendPQExpBufferStr(&buf, CppAsString2(RELKIND_PARTITIONED_INDEX) ",");
    appendPQExpBufferStr(&buf, "''");   /* dummy */
    appendPQExpBufferStr(&buf, ")\n");

    appendPQExpBufferStr(&buf, !showNested && !pattern ?
                         " AND NOT c.relispartition\n" : "");

    if (!pattern)
        appendPQExpBufferStr(&buf, "      AND n.nspname <> 'pg_catalog'\n"
                             "      AND n.nspname !~ '^pg_toast'\n"
                             "      AND n.nspname <> 'information_schema'\n");

    processSQLNamePattern(pset.db, &buf, pattern, true, false,
                          "n.nspname", "c.relname", NULL,
                          "pg_catalog.pg_table_is_visible(c.oid)");

    appendPQExpBuffer(&buf, "ORDER BY \"Schema\", %s%s\"Name\";",
                      mixed_output ? "\"Type\" DESC, " : "",
                      showNested || pattern ? "\"Parent name\" NULLS FIRST, " : "");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    initPQExpBuffer(&title);
    appendPQExpBufferStr(&title, tabletitle);

    myopt.nullPrint = NULL;
    myopt.title = title.data;
    myopt.translate_header = true;
    myopt.translate_columns = translate_columns;
    myopt.n_translate_columns = lengthof(translate_columns);

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    termPQExpBuffer(&title);

    PQclear(res);
    return true;
}

listPublications()

bool listPublications

(

const char *

pattern

)

Definition at line 6144 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, formatPGVersionNumber(), gettext_noop, initPQExpBuffer(), lengthof, _psqlSettings::logfile, printQueryOpt::n_translate_columns, printQueryOpt::nullPrint, pg_log_error, _psqlSettings::popt, PQclear(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, _psqlSettings::sversion, termPQExpBuffer(), printQueryOpt::title, printQueryOpt::translate_columns, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;
    static const bool translate_columns[] = {false, false, false, false, false, false, false, false};

    if (pset.sversion < 100000)
    {
        char        sverbuf[32];

        pg_log_error("The server (version %s) does not support publications.",
                     formatPGVersionNumber(pset.sversion, false,
                                           sverbuf, sizeof(sverbuf)));
        return true;
    }

    initPQExpBuffer(&buf);

    printfPQExpBuffer(&buf,
                      "SELECT pubname AS \"%s\",\n"
                      "  pg_catalog.pg_get_userbyid(pubowner) AS \"%s\",\n"
                      "  puballtables AS \"%s\",\n"
                      "  pubinsert AS \"%s\",\n"
                      "  pubupdate AS \"%s\",\n"
                      "  pubdelete AS \"%s\"",
                      gettext_noop("Name"),
                      gettext_noop("Owner"),
                      gettext_noop("All tables"),
                      gettext_noop("Inserts"),
                      gettext_noop("Updates"),
                      gettext_noop("Deletes"));
    if (pset.sversion >= 110000)
        appendPQExpBuffer(&buf,
                          ",\n  pubtruncate AS \"%s\"",
                          gettext_noop("Truncates"));
    if (pset.sversion >= 130000)
        appendPQExpBuffer(&buf,
                          ",\n  pubviaroot AS \"%s\"",
                          gettext_noop("Via root"));

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_publication\n");

    processSQLNamePattern(pset.db, &buf, pattern, false, false,
                          NULL, "pubname", NULL,
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of publications");
    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;
}

listSchemas()

bool listSchemas	(	const char *	pattern,
		bool	verbose,
		bool	showSystem
	)

Definition at line 5018 of file describe.c.

References _, appendPQExpBuffer(), appendPQExpBufferStr(), buf, PQExpBufferData::data, _psqlSettings::db, gettext_noop, initPQExpBuffer(), _psqlSettings::logfile, printQueryOpt::nullPrint, _psqlSettings::popt, PQclear(), printACLColumn(), printfPQExpBuffer(), printQuery(), processSQLNamePattern(), pset, PSQLexec(), _psqlSettings::queryFout, termPQExpBuffer(), printQueryOpt::title, and printQueryOpt::translate_header.

Referenced by exec_command_d().

{
    PQExpBufferData buf;
    PGresult   *res;
    printQueryOpt myopt = pset.popt;

    initPQExpBuffer(&buf);
    printfPQExpBuffer(&buf,
                      "SELECT n.nspname AS \"%s\",\n"
                      "  pg_catalog.pg_get_userbyid(n.nspowner) AS \"%s\"",
                      gettext_noop("Name"),
                      gettext_noop("Owner"));

    if (verbose)
    {
        appendPQExpBufferStr(&buf, ",\n  ");
        printACLColumn(&buf, "n.nspacl");
        appendPQExpBuffer(&buf,
                          ",\n  pg_catalog.obj_description(n.oid, 'pg_namespace') AS \"%s\"",
                          gettext_noop("Description"));
    }

    appendPQExpBufferStr(&buf,
                         "\nFROM pg_catalog.pg_namespace n\n");

    if (!showSystem && !pattern)
        appendPQExpBufferStr(&buf,
                             "WHERE n.nspname !~ '^pg_' AND n.nspname <> 'information_schema'\n");

    processSQLNamePattern(pset.db, &buf, pattern,
                          !showSystem && !pattern, false,
                          NULL, "n.nspname", NULL,
                          NULL);

    appendPQExpBufferStr(&buf, "ORDER BY 1;");

    res = PSQLexec(buf.data);
    termPQExpBuffer(&buf);
    if (!res)
        return false;

    myopt.nullPrint = NULL;
    myopt.title = _("List of schemas");
    myopt.translate_header = true;

    printQuery(res, &myopt, pset.queryFout, false, pset.logfile);

    PQclear(res);
    return true;
}