1berry/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
postgres/src/bin/psql/describe.h

60 lines
1.3 KiB
C
Raw Normal View History

another set of cleanups
2000-01-18 23:30:24 +00:00
/*
* psql - the PostgreSQL interactive terminal
*
Update copyrights that were missed.
2005-01-01 05:43:09 +00:00
* Copyright (c) 2000-2005, PostgreSQL Global Development Group
another set of cleanups
2000-01-18 23:30:24 +00:00
*
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
* $PostgreSQL: pgsql/src/bin/psql/describe.h,v 1.30 2006/02/12 03:22:19 momjian Exp $
another set of cleanups
2000-01-18 23:30:24 +00:00
*/
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
#ifndef DESCRIBE_H
#define DESCRIBE_H
#include "settings.h"
/* \da */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool describeAggregates(const char *pattern, bool verbose);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 06:14:31 +00:00
/* \db */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool describeTablespaces(const char *pattern, bool verbose);
Tablespaces. Alternate database locations are dead, long live tablespaces. There are various things left to do: contrib dbsize and oid2name modules need work, and so does the documentation. Also someone should think about COMMENT ON TABLESPACE and maybe RENAME TABLESPACE. Also initlocation is dead, it just doesn't know it yet. Gavin Sherry and Tom Lane.
2004-06-18 06:14:31 +00:00
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
/* \df */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool describeFunctions(const char *pattern, bool verbose);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
/* \dT */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool describeTypes(const char *pattern, bool verbose);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
/* \do */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool describeOperators(const char *pattern);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
/* \du, \dg */
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
extern bool describeRoles(const char *pattern, bool verbose);
attached is a patch that adds display of the groups a user belongs to to \du and a \dg command to psql. It's against 7.4beta5. Markus Bertheau <twanger@bluetwanger.de>
2003-12-01 22:21:54 +00:00
* Includes tab completion. It's not magic, but it's very cool. At any rate it's better than what used to be there. * Does proper SQL "host variable" substitution as pointed out by Andreas Zeugwetter (thanks): select * from :foo; Also some changes in how ':' and ';' are treated (escape with \ to send to backend). This does _not_ affect the '::' cast operator, but perhaps others that contain : or ; (but there are none right now). * To show description with a <something> listing, append '?' to command name, e.g., \df?. This seemed to be the convenient and logical solution. Or append a '+' to see more useless information, e.g., \df+. * Fixed fflush()'ing bug pointed out by Jan during the regression test discussion. * Added LastOid variable. This ought to take care of TODO item "Add a function to return the last inserted oid, for use in psql scripts" (under CLIENTS) E.g., insert into foo values(...); insert into bar values(..., :LastOid); \echo $LastOid * \d command shows constraints, rules, and triggers defined on the table (in addition to indices) * Various fixes, optimizations, corrections * Documentation update as well Note: This now requires snprintf(), which, if necessary, is taken from src/backend/port. This is certainly a little weird, but it should suffice until a source tree cleanup is done. Enjoy. -- Peter Eisentraut Sernanders väg 10:115
1999-11-26 04:24:17 +00:00
/* \z (or \dp) */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool permissionsList(const char *pattern);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
/* \dd */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool objectDescription(const char *pattern);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
/* \d foo */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool describeTableDetails(const char *pattern, bool verbose);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
/* \l */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool listAllDbs(bool verbose);
Major psql overhaul by Peter Eisentraut.
1999-11-04 21:56:02 +00:00
* Includes tab completion. It's not magic, but it's very cool. At any rate it's better than what used to be there. * Does proper SQL "host variable" substitution as pointed out by Andreas Zeugwetter (thanks): select * from :foo; Also some changes in how ':' and ';' are treated (escape with \ to send to backend). This does _not_ affect the '::' cast operator, but perhaps others that contain : or ; (but there are none right now). * To show description with a <something> listing, append '?' to command name, e.g., \df?. This seemed to be the convenient and logical solution. Or append a '+' to see more useless information, e.g., \df+. * Fixed fflush()'ing bug pointed out by Jan during the regression test discussion. * Added LastOid variable. This ought to take care of TODO item "Add a function to return the last inserted oid, for use in psql scripts" (under CLIENTS) E.g., insert into foo values(...); insert into bar values(..., :LastOid); \echo $LastOid * \d command shows constraints, rules, and triggers defined on the table (in addition to indices) * Various fixes, optimizations, corrections * Documentation update as well Note: This now requires snprintf(), which, if necessary, is taken from src/backend/port. This is certainly a little weird, but it should suffice until a source tree cleanup is done. Enjoy. -- Peter Eisentraut Sernanders väg 10:115
1999-11-26 04:24:17 +00:00
/* \dt, \di, \ds, \dS, etc. */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool listTables(const char *tabtypes, const char *pattern, bool verbose);
Another pgindent run. Fixes enum indenting, and improves #endif spacing. Also adds space for one-line comments.
2001-10-28 06:26:15 +00:00
Add psql \dD listing of domains, from Jonathan Eisler.
2002-03-19 02:32:21 +00:00
/* \dD */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool listDomains(const char *pattern);
Add psql \dD listing of domains, from Jonathan Eisler.
2002-03-19 02:32:21 +00:00
TODO marked as done: * Add schema, cast, and conversion backslash commands to psql I had to create a new publically available function, pg_conversion_is_visible, as it seemed to be missing from the catalogs. This required me to do no small amount of hacking around in namespace.c I have updated the \? help and sgml docs. \dc - list conversions [PATTERN] \dC - list casts \dn list schemas I didn't support patterns with casts as there's nothing obvious to match against. Catalog version incremented --- initdb required. Christopher Kings-Lynne
2002-12-12 21:02:25 +00:00
/* \dc */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool listConversions(const char *pattern);
TODO marked as done: * Add schema, cast, and conversion backslash commands to psql I had to create a new publically available function, pg_conversion_is_visible, as it seemed to be missing from the catalogs. This required me to do no small amount of hacking around in namespace.c I have updated the \? help and sgml docs. \dc - list conversions [PATTERN] \dC - list casts \dn list schemas I didn't support patterns with casts as there's nothing obvious to match against. Catalog version incremented --- initdb required. Christopher Kings-Lynne
2002-12-12 21:02:25 +00:00
/* \dC */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool listCasts(const char *pattern);
TODO marked as done: * Add schema, cast, and conversion backslash commands to psql I had to create a new publically available function, pg_conversion_is_visible, as it seemed to be missing from the catalogs. This required me to do no small amount of hacking around in namespace.c I have updated the \? help and sgml docs. \dc - list conversions [PATTERN] \dC - list casts \dn list schemas I didn't support patterns with casts as there's nothing obvious to match against. Catalog version incremented --- initdb required. Christopher Kings-Lynne
2002-12-12 21:02:25 +00:00
Apply the proper version of Christopher Kings-Lynne's describe patch (ie, the one with describe-schema support). Minor code review. Adjust display of casts to use standard type names.
2003-01-07 20:56:07 +00:00
/* \dn */
Fix up tab completion for ROLEs and add some more completion logic for other stuff; change \du and \dg to be role-aware (Stefan Kaltenbrunner). Also make tab completion fetch the list of GUC variables from pg_settings instead of having a hard-wired copy of the list (Tom Lane).
2005-08-14 18:49:30 +00:00
extern bool listSchemas(const char *pattern, bool verbose);
Apply the proper version of Christopher Kings-Lynne's describe patch (ie, the one with describe-schema support). Minor code review. Adjust display of casts to use standard type names.
2003-01-07 20:56:07 +00:00
TODO marked as done: * Add schema, cast, and conversion backslash commands to psql I had to create a new publically available function, pg_conversion_is_visible, as it seemed to be missing from the catalogs. This required me to do no small amount of hacking around in namespace.c I have updated the \? help and sgml docs. \dc - list conversions [PATTERN] \dC - list casts \dn list schemas I didn't support patterns with casts as there's nothing obvious to match against. Catalog version incremented --- initdb required. Christopher Kings-Lynne
2002-12-12 21:02:25 +00:00
New pgindent run with fixes suggested by Tom. Patch manually reviewed, initdb/regression tests pass.
2001-11-05 17:46:40 +00:00
#endif /* DESCRIBE_H */
Reference in New Issue Copy Permalink