postgres/src/bin/psql/describe.h
Bruce Momjian f9a726aa88 I've created a new shared catalog table pg_shdescription to store
comments on cluster global objects like databases, tablespaces, and
roles.

It touches a lot of places, but not much in the way of big changes.  The
only design decision I made was to duplicate the query and manipulation
functions rather than to try and have them handle both shared and local
comments.  I believe this is simpler for the code and not an issue for
callers because they know what type of object they are dealing with.
This has resulted in a shobj_description function analagous to
obj_description and backend functions [Create/Delete]SharedComments
mirroring the existing [Create/Delete]Comments functions.

pg_shdescription.h goes into src/include/catalog/

Kris Jurka
2006-02-12 03:22:21 +00:00

60 lines
1.3 KiB
C

/*
* psql - the PostgreSQL interactive terminal
*
* Copyright (c) 2000-2005, PostgreSQL Global Development Group
*
* $PostgreSQL: pgsql/src/bin/psql/describe.h,v 1.30 2006/02/12 03:22:19 momjian Exp $
*/
#ifndef DESCRIBE_H
#define DESCRIBE_H
#include "settings.h"
/* \da */
extern bool describeAggregates(const char *pattern, bool verbose);
/* \db */
extern bool describeTablespaces(const char *pattern, bool verbose);
/* \df */
extern bool describeFunctions(const char *pattern, bool verbose);
/* \dT */
extern bool describeTypes(const char *pattern, bool verbose);
/* \do */
extern bool describeOperators(const char *pattern);
/* \du, \dg */
extern bool describeRoles(const char *pattern, bool verbose);
/* \z (or \dp) */
extern bool permissionsList(const char *pattern);
/* \dd */
extern bool objectDescription(const char *pattern);
/* \d foo */
extern bool describeTableDetails(const char *pattern, bool verbose);
/* \l */
extern bool listAllDbs(bool verbose);
/* \dt, \di, \ds, \dS, etc. */
extern bool listTables(const char *tabtypes, const char *pattern, bool verbose);
/* \dD */
extern bool listDomains(const char *pattern);
/* \dc */
extern bool listConversions(const char *pattern);
/* \dC */
extern bool listCasts(const char *pattern);
/* \dn */
extern bool listSchemas(const char *pattern, bool verbose);
#endif /* DESCRIBE_H */