raw/man1/dropdb.1

   1 .\\" auto-generated by docbook2man-spec $Revision: 1.1 $
   2 .TH "DROPDB" "1" "2003-11-02" "Application" "PostgreSQL Client Applications"
   3 .SH NAME
   4 dropdb \- remove a PostgreSQL database
   5
   6 .SH SYNOPSIS
   7 .sp
   8 \fBdropdb\fR\fR [ \fR\fB\fIoption\fB\fR...\fB \fR\fR]\fR \fB\fIdbname\fB\fR
   9 .SH "DESCRIPTION"
  10 .PP
  11 \fBdropdb\fR destroys an existing
  12 PostgreSQL database.
  13 The user who executes this command must be a database
  14 superuser or the owner of the database.
  15 .PP
  16 \fBdropdb\fR is a wrapper around the
  17 SQL command DROP DATABASE [\fBdrop_database\fR(7)].
  18 There is no effective difference between dropping databases via
  19 this utility and via other methods for accessing the server.
  20 .SH "OPTIONS"
  21 .PP
  22 \fBdropdb\fR accepts the following command-line arguments:
  23 .TP
  24 \fB\fIdbname\fB\fR
  25 Specifies the name of the database to be removed.
  26 .TP
  27 \fB-e\fR
  28 .TP
  29 \fB--echo\fR
  30 Echo the commands that \fBdropdb\fR generates
  31 and sends to the server.
  32 .TP
  33 \fB-i\fR
  34 .TP
  35 \fB--interactive\fR
  36 Issues a verification prompt before doing anything destructive.
  37 .TP
  38 \fB-q\fR
  39 .TP
  40 \fB--quiet\fR
  41 Do not display a response.
  42 .PP
  43 .PP
  44 \fBdropdb\fR also accepts the following
  45 command-line arguments for connection parameters:
  46 .TP
  47 \fB-h \fIhost\fB\fR
  48 .TP
  49 \fB--host \fIhost\fB\fR
  50 Specifies the host name of the machine on which the
  51 server
  52 is running. If the value begins with a slash, it is used
  53 as the directory for the Unix domain socket.
  54 .TP
  55 \fB-p \fIport\fB\fR
  56 .TP
  57 \fB--port \fIport\fB\fR
  58 Specifies the TCP port or local Unix domain socket file
  59 extension on which the server
  60 is listening for connections.
  61 .TP
  62 \fB-U \fIusername\fB\fR
  63 .TP
  64 \fB--username \fIusername\fB\fR
  65 User name to connect as
  66 .TP
  67 \fB-W\fR
  68 .TP
  69 \fB--password\fR
  70 Force password prompt.
  71 .PP
  72 .SH "ENVIRONMENT"
  73 .TP
  74 \fBPGHOST\fR
  75 .TP
  76 \fBPGPORT\fR
  77 .TP
  78 \fBPGUSER\fR
  79 Default connection parameters
  80 .SH "DIAGNOSTICS"
  81 .PP
  82 In case of difficulty, see DROP DATABASE [\fBdrop_database\fR(7)] and \fBpsql\fR(1) for
  83 discussions of potential problems and error messages.
  84 The database server must be running at the
  85 targeted host. Also, any default connection settings and environment
  86 variables used by the \fBlibpq\fR front-end
  87 library will apply.
  88 .SH "EXAMPLES"
  89 .PP
  90 To destroy the database demo on the default
  91 database server:
  92 .sp
  93 .nf
  94 $ \fBdropdb demo\fR
  95 DROP DATABASE
  96 .sp
  97 .fi
  98 .PP
  99 To destroy the database demo using the
 100 server on host eden, port 5000, with verification and a peek
 101 at the underlying command:
 102 .sp
 103 .nf
 104 $ \fBdropdb -p 5000 -h eden -i -e demo\fR
 105 Database "demo" will be permanently deleted.
 106 Are you sure? (y/n) \fBy\fR
 107 DROP DATABASE "demo"
 108 DROP DATABASE
 109 .sp
 110 .fi
 111 .SH "SEE ALSO"
 112 \fBcreatedb\fR(1), DROP DATABASE [\fBdrop_database\fR(7)]
 113