VII. Reference

The entries in this Reference are meant to provide in reasonable length an authoritative, complete, and formal summary about their respective subjects. More information about the use of EnterpriseDB, in narrative, tutorial, or example form, may be found in other parts of this book. See the cross-references listed on each reference page.

The reference entries are also available as traditional "man" pages.

Table of Contents

I. SQL Commands

ALTER DATABASE -- change a database
ALTER FUNCTION -- change the definition of a function
ALTER GROUP -- change a user group
ALTER INDEX -- change the definition of an index
ALTER OPERATOR -- change the definition of an operator
ALTER ROLE -- change a database role
ALTER SCHEMA -- change the definition of a schema
ALTER SEQUENCE -- change the definition of a sequence generator
ALTER TABLE -- change the definition of a table
ALTER TABLESPACE -- change the definition of a tablespace
ALTER TRIGGER -- change the definition of a trigger
ALTER TYPE -- change the definition of a type
ALTER USER -- change a database user account
ANALYZE -- collect statistics about a database
BEGIN -- start a transaction block
CHECKPOINT -- force a transaction log checkpoint
CLOSE -- close a cursor
CLUSTER -- cluster a table according to an index
COMMENT -- define or change the comment of an object
COMMIT -- commit the current transaction
COMMIT PREPARED -- commit a transaction that was earlier prepared for two-phase commit
COPY -- copy data between a file and a table
CREATE DATABASE -- create a new database
CREATE FUNCTION -- define a new function
CREATE FUNCTION (SPL) -- define a new function in SPL
CREATE GROUP -- define a new user group
CREATE INDEX -- define a new index
CREATE OPERATOR -- define a new operator
CREATE PROCEDURE -- create a new procedure
CREATE PUBLIC SYNONYM -- define a new public synonym
CREATE ROLE -- define a new database role
CREATE RULE -- define a new rewrite rule
CREATE SCHEMA -- define a new schema
CREATE SEQUENCE -- define a new sequence generator
CREATE TABLE -- define a new table
CREATE TABLE AS -- define a new table from the results of a query
CREATE TABLESPACE -- define a new tablespace
CREATE TRIGGER -- define a new trigger
CREATE TYPE -- define a new data type
CREATE USER -- define a new database user account
CREATE VIEW -- define a new view
DEALLOCATE -- deallocate a prepared statement
DECLARE -- define a cursor
DELETE -- delete rows of a table
DROP DATABASE -- remove a database
DROP FUNCTION -- remove a function
DROP GROUP -- remove a user group
DROP INDEX -- remove an index
DROP OPERATOR -- remove an operator
DROP PROCEDURE -- drop a stored procedure
DROP PUBLIC SYNONYM -- remove a public synonym
DROP ROLE -- remove a database role
DROP RULE -- remove a rewrite rule
DROP SCHEMA -- remove a schema
DROP SEQUENCE -- remove a sequence
DROP TABLE -- remove a table
DROP TABLESPACE -- remove a tablespace
DROP TRIGGER -- remove a trigger
DROP TYPE -- remove a data type
DROP USER -- remove a database user account
DROP VIEW -- remove a view
END -- commit the current transaction
EXECUTE -- execute a prepared statement
EXPLAIN -- show the execution plan of a statement
FETCH -- retrieve rows from a query using a cursor
GRANT -- define access privileges
INSERT -- create new rows in a table
LOCK -- lock a table
PREPARE -- prepare a statement for execution
PREPARE TRANSACTION -- prepare the current transaction for two-phase commit
REINDEX -- rebuild indexes
RELEASE SAVEPOINT -- destroy a previously defined savepoint
RESET -- restore the value of a run-time parameter to the default value
REVOKE -- remove access privileges
ROLLBACK -- abort the current transaction
ROLLBACK PREPARED -- cancel a transaction that was earlier prepared for two-phase commit
ROLLBACK TO SAVEPOINT -- roll back to a savepoint
SAVEPOINT -- define a new savepoint within the current transaction
SELECT -- retrieve rows from a table or view
SELECT INTO -- define a new table from the results of a query
SET -- change a run-time parameter
SET CONSTRAINTS -- set constraint checking modes for the current transaction
SET ROLE -- set the current user identifier of the current session
SET SESSION AUTHORIZATION -- set the session user identifier and the current user identifier of the current session
SET TRANSACTION -- set the characteristics of the current transaction
SHOW -- show the value of a run-time parameter
START TRANSACTION -- start a transaction block
TRUNCATE -- empty a table
UPDATE -- update rows of a table
VACUUM -- garbage-collect and optionally analyze a database

II. Database Utilities

clusterdb -- cluster an EnterpriseDB database
createdb -- create a new EnterpriseDB database
createuser -- define a new EnterpriseDB user account
dropdb -- remove an EnterpriseDB database
dropuser -- remove an EnterpriseDB user account
pg_config -- retrieve information about the installed version of EnterpriseDB
pg_dump -- extract an EnterpriseDB database into a script file or other archive file
pg_dumpall -- extract an EnterpriseDB database cluster into a script file
pg_restore -- restore an EnterpriseDB database from an archive file created by pg_dump
edb-psql -- EnterpriseDB interactive terminal
reindexdb -- reindex a EnterpriseDB database
vacuumdb -- garbage-collect and analyze a EnterpriseDB database

III. Server Utilities

initdb -- create a new EnterpriseDB database cluster
pg_controldata -- display control information of an EnterpriseDB database cluster
pg_ctl -- start, stop, or restart a EnterpriseDB server
pg_resetxlog -- reset the write-ahead log and other control information of an EnterpriseDB database cluster
edb-postgres -- run an EnterpriseDB server in single-user mode
edb-postmaster -- EnterpriseDB multiuser database server

IV. EDB-Postgres System Catalogs

System Catalogs -- The System catalogs are where a relational database management system stores schema metadata, such as information about tables and columns, and internal bookkeeping information.

V. EnterpriseDB Error Codes

Index