If you are using PostgreSQL, have you ever loaded an SQL script file or dump file through psql? Well, duh.
-f vs. <
If you are just starting out, you will probably try this:
psql mydb < dump.sql
and that's quite OK.
Once you hit your first error message such as
ERROR: syntax error at or near "VEIW"
you might figure out that for some reason
psql mydb -f dump.sql
is better, because it produces
psql:dump.sql:56: ERROR: syntax error at or near "VEIW"
instead, allowing you to actually find the error in your file.
Now I admit that it is almost entirely me who is to blame for this bizarre difference, because at some point in the distant past, the GNU Coding Standards recommended that programs should behave the same independent of whether the standard input or output is a terminal or a file. The current version of said standard actually explicitly creates an exception saying that error messages should be changed to the noninteractive style when the standard input is not from a terminal. So this should probably be fixed.
Note that the
-f form above is not portable. It depends on the GNU getopt extension that permits options after nonoption arguments. To be portable, you need to write either
psql -d mydb -f dump.sql
or
psql -f dump.sql mydb
Frankly, I hardly ever do this because I rarely use a non-GNU system, but keep it in mind when writing scripts or documentation intended to be portable.
psqlrc
The next thing you should always do when running psql scripts is using the option
-X, which prevents the reading of the
.psqlrc file. Because that file could contain anything, and you have no idea how it will interact with your script.
In my mind, this is a design mistake in psql. Unix shells have different startup files for interactive and noninteractive usage, so they don't have this problem.
Quiet or Loud
Anyway, if you are restoring a dump, these commands will produce output that does something like this:
CREATE TABLE
CREATE TABLE
CREATE TABLE
CREATE FUNCTION
CREATE TYPE
CREATE FUNCTION
ALTER TABLE
ALTER TABLE
CREATE INDEX
CREATE INDEX
These are the responses from the DDL commands that are in your SQL script file. I personally like to not see these, because they don't tell me anything useful and they cause the important information such as error messages to fly rapidly off the screen.
Some people might like these responses because they serve as a kind of progress indicator. Which is true, but there is a flaw. Creating tables and functions is pretty fast. Chances are that that part of the dump file will fly way off your screen in two seconds. The slow part of a database restore are the
COPY commands that restore the data. And those do not produce any response at all! So as a progress report, this output is not all that useful. OK, the
ALTER TABLE parts at the end that create the foreign keys can be slow, and of course the
CREATE INDEX commands, but in the above example, the longest wait would be after the last
CREATE FUNCTION.
There are two ways to make this behavior more sane: If you don't want the "progress" output, only the errors and other important messages, use the option
-q (or
--quiet). This is probably more useful for restoring a dump on the console. If you want a full progress report, use the option
-a (or
--all), which will in addition to the default behavior print each statement from the file before executing it. This is probably fairly useful in batch jobs where you are logging the output to a file or somewhere. But most likely you will want to use one of these two options for almost any noninteractive invocation of psql. You can also somewhat usefully use both options at the same
time; think about it.
Notices
On the matter of controlling the output, you might want to hide the
NOTICE messages such as
NOTICE: CREATE TABLE / PRIMARY KEY will create implicit index "test1_pkey" for table "test1"
These get pretty boring quickly, especially when you create a lot of tables with a lot of primary keys.
psql doesn't provide a direct command-line option for turning this off, but there is an obscure method: See the environment variable
PGOPTIONS to
'--client-min-messages=warning', which will pass that option to the server process. So all together, your call might look like
PGOPTIONS='--client-min-messages=warning' psql -d mydb -q -f dump.sql
For some tastes, it might actually make sense to change the
client_min_messages option permanently in postgresql.conf on the server.
Also note that analogous to the case of
.psqlrc described above,
PGOPTIONS could contain all kinds of settings that you don't want. So even if you don't want to disable notices as shown here, it would be most prudent to unset the environment variable in other cases.
Transactions
The next thing you might want to consider is using transactions, or rather a single transaction. Otherwise, if the execution of the script or restoration of the backup fails somewhere along the way, you have a half-loaded database and no easy restart point. Sometimes this doesn't matter that much; if you are restoring into a new database, you can just drop it and start over. If you are deploying updates into an existing system, much more care is required. The option to execute a file in a single transaction is
-1 or
--single-transaction.
Now depending on what exactly is in the file you want to load, using a single transaction may or may not work very well. For dump files created with pg_dump, it usually works, unless you used the
-c/
--clean option, in which case the
DROP commands that appear at the beginning of the file might not have anything to drop and will fail, failing the entire transaction. That problem could be addressed if pg_dump used
DROP IF EXISTS, but it doesn't.
When deploying schema changes into an existing database, this can get very tricky. For functions, you can usually use
CREATE OR REPLACE FUNCTION to have an idempotent function creation command. Except that it will fail when the return type was changed. And there is no
CREATE OR REPLACE AGGREGATE or
CREATE OR REPLACE OPERATOR (yet?). With other object classes such as types or casts it can be easier to just unconditionally drop and recreate the objects. If you drop a type, however, everything that uses that type is also dropped, so be sure to recreate everything (such as functions) afterwards in the same transaction. This won't help when the type is used in tables, though; don't blow away your tables. Exactly how to manage this type of situation is a science of its own and would go beyond the scope of this post.
Side note: An alternative for some situations is using the psql option
ON_ERROR_ROLLBACK, which allows you to ignore errors but still make use the atomicity property of transactions, useful when doing schema upgrades.
If you are convinced that running SQL scripts in transactions is the right thing, and you have adjusted your scripts to behave properly in that context, then you may also wish to consider the option
-v ON_ERROR_STOP=1
This causes psql to stop execution when a transaction fails. Otherwise it would continue to execute the rest of the script and issuing the error message
ERROR: current transaction is aborted, commands ignored until end of transaction block
for every command, which makes no sense. There was a discussion a while ago about making
ON_ERROR_STOP default to on when the single-transaction option is used, but it was not clear how this should interact with savepoints. If you are making use of savepoints, you may want to stay away from this option or evaluate yourself whether it makes sense for you.
Pager
If you run a psql script with the output on a terminal (which is normal when installing databases, restoring backups, etc.), the script executes a
SELECT command, and the output doesn't fit on the screen, the output is run through the pager, which will normally wait for some key to be pressed to continue. This is obviously an extremely useful feature in psql in interactive mode, but it also happens when you run a script, which is dubious.
Often, this won't be a problem, because backup files for instance don't contain
SELECT commands with large outputs. But you can simulate this by taking any dump file that restores a sequence, which will contain
SELECT setval(...) calls. If you make your terminal window 4 lines or less, you can see the effect of this. Again, this is contrived, but every so often someone puts a
SELECT command in a file to create some kind of visual verification that the tables or the functions or the data that the script was supposed to load is now really there. There is nothing wrong with that, except when you run the script from the terminal and forget to check back with extreme frequency. The old joke that someone left a transaction open before going to lunch has never been more real.
Add the option
--pset pager=off
to the psql invocation to disable this behavior.
Summary
OK, got all that? Write this down, here is how you
really should execute an SQL script file in psql:
PGOPTIONS='--client-min-messages=warning' psql -X -q -a -1 -v ON_ERROR_STOP=1 --pset pager=off -d mydb -f dump.sql
Should be easier? I think so. Discuss.
Posts
