PostgreSQL Source Code  git master
copy.h File Reference
#include "nodes/execnodes.h"
#include "nodes/parsenodes.h"
#include "parser/parse_node.h"
#include "tcop/dest.h"
Include dependency graph for copy.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  CopyFormatOptions
 

Typedefs

typedef enum CopyHeaderChoice CopyHeaderChoice
 
typedef struct CopyFormatOptions CopyFormatOptions
 
typedef struct CopyFromStateDataCopyFromState
 
typedef struct CopyToStateDataCopyToState
 
typedef int(* copy_data_source_cb) (void *outbuf, int minread, int maxread)
 
typedef void(* copy_data_dest_cb) (void *data, int len)
 

Enumerations

enum  CopyHeaderChoice { COPY_HEADER_FALSE = 0 , COPY_HEADER_TRUE , COPY_HEADER_MATCH }
 

Functions

void DoCopy (ParseState *pstate, const CopyStmt *stmt, int stmt_location, int stmt_len, uint64 *processed)
 
void ProcessCopyOptions (ParseState *pstate, CopyFormatOptions *opts_out, bool is_from, List *options)
 
CopyFromState BeginCopyFrom (ParseState *pstate, Relation rel, Node *whereClause, const char *filename, bool is_program, copy_data_source_cb data_source_cb, List *attnamelist, List *options)
 
void EndCopyFrom (CopyFromState cstate)
 
bool NextCopyFrom (CopyFromState cstate, ExprContext *econtext, Datum *values, bool *nulls)
 
bool NextCopyFromRawFields (CopyFromState cstate, char ***fields, int *nfields)
 
void CopyFromErrorCallback (void *arg)
 
uint64 CopyFrom (CopyFromState cstate)
 
DestReceiverCreateCopyDestReceiver (void)
 
CopyToState BeginCopyTo (ParseState *pstate, Relation rel, RawStmt *raw_query, Oid queryRelId, const char *filename, bool is_program, copy_data_dest_cb data_dest_cb, List *attnamelist, List *options)
 
void EndCopyTo (CopyToState cstate)
 
uint64 DoCopyTo (CopyToState cstate)
 
ListCopyGetAttnums (TupleDesc tupDesc, Relation rel, List *attnamelist)
 

Typedef Documentation

◆ copy_data_dest_cb

typedef void(* copy_data_dest_cb) (void *data, int len)

Definition at line 71 of file copy.h.

◆ copy_data_source_cb

typedef int(* copy_data_source_cb) (void *outbuf, int minread, int maxread)

Definition at line 70 of file copy.h.

◆ CopyFormatOptions

◆ CopyFromState

Definition at line 67 of file copy.h.

◆ CopyHeaderChoice

◆ CopyToState

typedef struct CopyToStateData* CopyToState

Definition at line 68 of file copy.h.

Enumeration Type Documentation

◆ CopyHeaderChoice

Enumerator
COPY_HEADER_FALSE 
COPY_HEADER_TRUE 
COPY_HEADER_MATCH 

Definition at line 26 of file copy.h.

27 {
CopyHeaderChoice
Definition: copy.h:27
@ COPY_HEADER_TRUE
Definition: copy.h:29
@ COPY_HEADER_FALSE
Definition: copy.h:28
@ COPY_HEADER_MATCH
Definition: copy.h:30

Function Documentation

◆ BeginCopyFrom()

CopyFromState BeginCopyFrom ( ParseState pstate,
Relation  rel,
Node whereClause,
const char *  filename,
bool  is_program,
copy_data_source_cb  data_source_cb,
List attnamelist,
List options 
)

Definition at line 1334 of file copyfrom.c.

1342 {
1343  CopyFromState cstate;
1344  bool pipe = (filename == NULL);
1345  TupleDesc tupDesc;
1346  AttrNumber num_phys_attrs,
1347  num_defaults;
1348  FmgrInfo *in_functions;
1349  Oid *typioparams;
1350  Oid in_func_oid;
1351  int *defmap;
1352  ExprState **defexprs;
1353  MemoryContext oldcontext;
1354  bool volatile_defexprs;
1355  const int progress_cols[] = {
1359  };
1360  int64 progress_vals[] = {
1362  0,
1363  0
1364  };
1365 
1366  /* Allocate workspace and zero all fields */
1367  cstate = (CopyFromStateData *) palloc0(sizeof(CopyFromStateData));
1368 
1369  /*
1370  * We allocate everything used by a cstate in a new memory context. This
1371  * avoids memory leaks during repeated use of COPY in a query.
1372  */
1374  "COPY",
1376 
1377  oldcontext = MemoryContextSwitchTo(cstate->copycontext);
1378 
1379  /* Extract options from the statement node tree */
1380  ProcessCopyOptions(pstate, &cstate->opts, true /* is_from */ , options);
1381 
1382  /* Process the target relation */
1383  cstate->rel = rel;
1384 
1385  tupDesc = RelationGetDescr(cstate->rel);
1386 
1387  /* process common options or initialization */
1388 
1389  /* Generate or convert list of attributes to process */
1390  cstate->attnumlist = CopyGetAttnums(tupDesc, cstate->rel, attnamelist);
1391 
1392  num_phys_attrs = tupDesc->natts;
1393 
1394  /* Convert FORCE_NOT_NULL name list to per-column flags, check validity */
1395  cstate->opts.force_notnull_flags = (bool *) palloc0(num_phys_attrs * sizeof(bool));
1396  if (cstate->opts.force_notnull)
1397  {
1398  List *attnums;
1399  ListCell *cur;
1400 
1401  attnums = CopyGetAttnums(tupDesc, cstate->rel, cstate->opts.force_notnull);
1402 
1403  foreach(cur, attnums)
1404  {
1405  int attnum = lfirst_int(cur);
1406  Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
1407 
1408  if (!list_member_int(cstate->attnumlist, attnum))
1409  ereport(ERROR,
1410  (errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
1411  errmsg("FORCE_NOT_NULL column \"%s\" not referenced by COPY",
1412  NameStr(attr->attname))));
1413  cstate->opts.force_notnull_flags[attnum - 1] = true;
1414  }
1415  }
1416 
1417  /* Convert FORCE_NULL name list to per-column flags, check validity */
1418  cstate->opts.force_null_flags = (bool *) palloc0(num_phys_attrs * sizeof(bool));
1419  if (cstate->opts.force_null)
1420  {
1421  List *attnums;
1422  ListCell *cur;
1423 
1424  attnums = CopyGetAttnums(tupDesc, cstate->rel, cstate->opts.force_null);
1425 
1426  foreach(cur, attnums)
1427  {
1428  int attnum = lfirst_int(cur);
1429  Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
1430 
1431  if (!list_member_int(cstate->attnumlist, attnum))
1432  ereport(ERROR,
1433  (errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
1434  errmsg("FORCE_NULL column \"%s\" not referenced by COPY",
1435  NameStr(attr->attname))));
1436  cstate->opts.force_null_flags[attnum - 1] = true;
1437  }
1438  }
1439 
1440  /* Convert convert_selectively name list to per-column flags */
1441  if (cstate->opts.convert_selectively)
1442  {
1443  List *attnums;
1444  ListCell *cur;
1445 
1446  cstate->convert_select_flags = (bool *) palloc0(num_phys_attrs * sizeof(bool));
1447 
1448  attnums = CopyGetAttnums(tupDesc, cstate->rel, cstate->opts.convert_select);
1449 
1450  foreach(cur, attnums)
1451  {
1452  int attnum = lfirst_int(cur);
1453  Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
1454 
1455  if (!list_member_int(cstate->attnumlist, attnum))
1456  ereport(ERROR,
1457  (errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
1458  errmsg_internal("selected column \"%s\" not referenced by COPY",
1459  NameStr(attr->attname))));
1460  cstate->convert_select_flags[attnum - 1] = true;
1461  }
1462  }
1463 
1464  /* Use client encoding when ENCODING option is not specified. */
1465  if (cstate->opts.file_encoding < 0)
1467  else
1468  cstate->file_encoding = cstate->opts.file_encoding;
1469 
1470  /*
1471  * Look up encoding conversion function.
1472  */
1473  if (cstate->file_encoding == GetDatabaseEncoding() ||
1474  cstate->file_encoding == PG_SQL_ASCII ||
1476  {
1477  cstate->need_transcoding = false;
1478  }
1479  else
1480  {
1481  cstate->need_transcoding = true;
1484  }
1485 
1486  cstate->copy_src = COPY_FILE; /* default */
1487 
1488  cstate->whereClause = whereClause;
1489 
1490  /* Initialize state variables */
1491  cstate->eol_type = EOL_UNKNOWN;
1492  cstate->cur_relname = RelationGetRelationName(cstate->rel);
1493  cstate->cur_lineno = 0;
1494  cstate->cur_attname = NULL;
1495  cstate->cur_attval = NULL;
1496  cstate->relname_only = false;
1497 
1498  /*
1499  * Allocate buffers for the input pipeline.
1500  *
1501  * attribute_buf and raw_buf are used in both text and binary modes, but
1502  * input_buf and line_buf only in text mode.
1503  */
1504  cstate->raw_buf = palloc(RAW_BUF_SIZE + 1);
1505  cstate->raw_buf_index = cstate->raw_buf_len = 0;
1506  cstate->raw_reached_eof = false;
1507 
1508  if (!cstate->opts.binary)
1509  {
1510  /*
1511  * If encoding conversion is needed, we need another buffer to hold
1512  * the converted input data. Otherwise, we can just point input_buf
1513  * to the same buffer as raw_buf.
1514  */
1515  if (cstate->need_transcoding)
1516  {
1517  cstate->input_buf = (char *) palloc(INPUT_BUF_SIZE + 1);
1518  cstate->input_buf_index = cstate->input_buf_len = 0;
1519  }
1520  else
1521  cstate->input_buf = cstate->raw_buf;
1522  cstate->input_reached_eof = false;
1523 
1524  initStringInfo(&cstate->line_buf);
1525  }
1526 
1527  initStringInfo(&cstate->attribute_buf);
1528 
1529  /* Assign range table and rteperminfos, we'll need them in CopyFrom. */
1530  if (pstate)
1531  {
1532  cstate->range_table = pstate->p_rtable;
1533  cstate->rteperminfos = pstate->p_rteperminfos;
1534  }
1535 
1536  tupDesc = RelationGetDescr(cstate->rel);
1537  num_phys_attrs = tupDesc->natts;
1538  num_defaults = 0;
1539  volatile_defexprs = false;
1540 
1541  /*
1542  * Pick up the required catalog information for each attribute in the
1543  * relation, including the input function, the element type (to pass to
1544  * the input function), and info about defaults and constraints. (Which
1545  * input function we use depends on text/binary format choice.)
1546  */
1547  in_functions = (FmgrInfo *) palloc(num_phys_attrs * sizeof(FmgrInfo));
1548  typioparams = (Oid *) palloc(num_phys_attrs * sizeof(Oid));
1549  defmap = (int *) palloc(num_phys_attrs * sizeof(int));
1550  defexprs = (ExprState **) palloc(num_phys_attrs * sizeof(ExprState *));
1551 
1552  for (int attnum = 1; attnum <= num_phys_attrs; attnum++)
1553  {
1554  Form_pg_attribute att = TupleDescAttr(tupDesc, attnum - 1);
1555 
1556  /* We don't need info for dropped attributes */
1557  if (att->attisdropped)
1558  continue;
1559 
1560  /* Fetch the input function and typioparam info */
1561  if (cstate->opts.binary)
1562  getTypeBinaryInputInfo(att->atttypid,
1563  &in_func_oid, &typioparams[attnum - 1]);
1564  else
1565  getTypeInputInfo(att->atttypid,
1566  &in_func_oid, &typioparams[attnum - 1]);
1567  fmgr_info(in_func_oid, &in_functions[attnum - 1]);
1568 
1569  /* Get default info if available */
1570  defexprs[attnum - 1] = NULL;
1571 
1572  if (!att->attgenerated)
1573  {
1574  Expr *defexpr = (Expr *) build_column_default(cstate->rel,
1575  attnum);
1576 
1577  if (defexpr != NULL)
1578  {
1579  /* Run the expression through planner */
1580  defexpr = expression_planner(defexpr);
1581 
1582  /* Initialize executable expression in copycontext */
1583  defexprs[attnum - 1] = ExecInitExpr(defexpr, NULL);
1584 
1585  /* if NOT copied from input */
1586  /* use default value if one exists */
1587  if (!list_member_int(cstate->attnumlist, attnum))
1588  {
1589  defmap[num_defaults] = attnum - 1;
1590  num_defaults++;
1591  }
1592 
1593  /*
1594  * If a default expression looks at the table being loaded,
1595  * then it could give the wrong answer when using
1596  * multi-insert. Since database access can be dynamic this is
1597  * hard to test for exactly, so we use the much wider test of
1598  * whether the default expression is volatile. We allow for
1599  * the special case of when the default expression is the
1600  * nextval() of a sequence which in this specific case is
1601  * known to be safe for use with the multi-insert
1602  * optimization. Hence we use this special case function
1603  * checker rather than the standard check for
1604  * contain_volatile_functions().
1605  */
1606  if (!volatile_defexprs)
1607  volatile_defexprs = contain_volatile_functions_not_nextval((Node *) defexpr);
1608  }
1609  }
1610  }
1611 
1612 
1613  /* initialize progress */
1615  cstate->rel ? RelationGetRelid(cstate->rel) : InvalidOid);
1616  cstate->bytes_processed = 0;
1617 
1618  /* We keep those variables in cstate. */
1619  cstate->in_functions = in_functions;
1620  cstate->typioparams = typioparams;
1621  cstate->defmap = defmap;
1622  cstate->defexprs = defexprs;
1623  cstate->volatile_defexprs = volatile_defexprs;
1624  cstate->num_defaults = num_defaults;
1625  cstate->is_program = is_program;
1626 
1627  if (data_source_cb)
1628  {
1629  progress_vals[1] = PROGRESS_COPY_TYPE_CALLBACK;
1630  cstate->copy_src = COPY_CALLBACK;
1631  cstate->data_source_cb = data_source_cb;
1632  }
1633  else if (pipe)
1634  {
1635  progress_vals[1] = PROGRESS_COPY_TYPE_PIPE;
1636  Assert(!is_program); /* the grammar does not allow this */
1638  ReceiveCopyBegin(cstate);
1639  else
1640  cstate->copy_file = stdin;
1641  }
1642  else
1643  {
1644  cstate->filename = pstrdup(filename);
1645 
1646  if (cstate->is_program)
1647  {
1648  progress_vals[1] = PROGRESS_COPY_TYPE_PROGRAM;
1649  cstate->copy_file = OpenPipeStream(cstate->filename, PG_BINARY_R);
1650  if (cstate->copy_file == NULL)
1651  ereport(ERROR,
1653  errmsg("could not execute command \"%s\": %m",
1654  cstate->filename)));
1655  }
1656  else
1657  {
1658  struct stat st;
1659 
1660  progress_vals[1] = PROGRESS_COPY_TYPE_FILE;
1661  cstate->copy_file = AllocateFile(cstate->filename, PG_BINARY_R);
1662  if (cstate->copy_file == NULL)
1663  {
1664  /* copy errno because ereport subfunctions might change it */
1665  int save_errno = errno;
1666 
1667  ereport(ERROR,
1669  errmsg("could not open file \"%s\" for reading: %m",
1670  cstate->filename),
1671  (save_errno == ENOENT || save_errno == EACCES) ?
1672  errhint("COPY FROM instructs the PostgreSQL server process to read a file. "
1673  "You may want a client-side facility such as psql's \\copy.") : 0));
1674  }
1675 
1676  if (fstat(fileno(cstate->copy_file), &st))
1677  ereport(ERROR,
1679  errmsg("could not stat file \"%s\": %m",
1680  cstate->filename)));
1681 
1682  if (S_ISDIR(st.st_mode))
1683  ereport(ERROR,
1684  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
1685  errmsg("\"%s\" is a directory", cstate->filename)));
1686 
1687  progress_vals[2] = st.st_size;
1688  }
1689  }
1690 
1691  pgstat_progress_update_multi_param(3, progress_cols, progress_vals);
1692 
1693  if (cstate->opts.binary)
1694  {
1695  /* Read and verify binary header */
1696  ReceiveCopyBinaryHeader(cstate);
1697  }
1698 
1699  /* create workspace for CopyReadAttributes results */
1700  if (!cstate->opts.binary)
1701  {
1702  AttrNumber attr_count = list_length(cstate->attnumlist);
1703 
1704  cstate->max_fields = attr_count;
1705  cstate->raw_fields = (char **) palloc(attr_count * sizeof(char *));
1706  }
1707 
1708  MemoryContextSwitchTo(oldcontext);
1709 
1710  return cstate;
1711 }
int16 AttrNumber
Definition: attnum.h:21
List * CopyGetAttnums(TupleDesc tupDesc, Relation rel, List *attnamelist)
Definition: copy.c:782
void ProcessCopyOptions(ParseState *pstate, CopyFormatOptions *opts_out, bool is_from, List *options)
Definition: copy.c:414
void pgstat_progress_start_command(ProgressCommandType cmdtype, Oid relid)
void pgstat_progress_update_multi_param(int nparam, const int *index, const int64 *val)
@ PROGRESS_COMMAND_COPY
#define NameStr(name)
Definition: c.h:730
#define PG_BINARY_R
Definition: c.h:1280
bool contain_volatile_functions_not_nextval(Node *clause)
Definition: clauses.c:590
#define INPUT_BUF_SIZE
@ EOL_UNKNOWN
#define RAW_BUF_SIZE
void ReceiveCopyBinaryHeader(CopyFromState cstate)
void ReceiveCopyBegin(CopyFromState cstate)
@ COPY_FILE
Definition: copyto.c:52
@ COPY_CALLBACK
Definition: copyto.c:54
@ DestRemote
Definition: dest.h:89
struct cursor * cur
Definition: ecpg.c:28
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1156
int errcode_for_file_access(void)
Definition: elog.c:881
int errhint(const char *fmt,...)
Definition: elog.c:1316
int errcode(int sqlerrcode)
Definition: elog.c:858
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
ExprState * ExecInitExpr(Expr *node, PlanState *parent)
Definition: execExpr.c:127
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2480
FILE * OpenPipeStream(const char *command, const char *mode)
Definition: fd.c:2583
void fmgr_info(Oid functionId, FmgrInfo *finfo)
Definition: fmgr.c:127
Assert(fmt[strlen(fmt) - 1] !='\n')
bool list_member_int(const List *list, int datum)
Definition: list.c:701
void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam)
Definition: lsyscache.c:2832
void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam)
Definition: lsyscache.c:2898
int GetDatabaseEncoding(void)
Definition: mbutils.c:1268
int pg_get_client_encoding(void)
Definition: mbutils.c:337
char * pstrdup(const char *in)
Definition: mcxt.c:1644
void * palloc0(Size size)
Definition: mcxt.c:1257
MemoryContext CurrentMemoryContext
Definition: mcxt.c:135
void * palloc(Size size)
Definition: mcxt.c:1226
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:153
Oid FindDefaultConversionProc(int32 for_encoding, int32 to_encoding)
Definition: namespace.c:3757
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:138
int16 attnum
Definition: pg_attribute.h:74
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:209
static char * filename
Definition: pg_dumpall.c:119
static int list_length(const List *l)
Definition: pg_list.h:152
#define lfirst_int(lc)
Definition: pg_list.h:173
@ PG_SQL_ASCII
Definition: pg_wchar.h:226
Expr * expression_planner(Expr *expr)
Definition: planner.c:6431
CommandDest whereToSendOutput
Definition: postgres.c:88
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
#define PROGRESS_COPY_COMMAND
Definition: progress.h:141
#define PROGRESS_COPY_TYPE_FILE
Definition: progress.h:149
#define PROGRESS_COPY_COMMAND_FROM
Definition: progress.h:145
#define PROGRESS_COPY_TYPE
Definition: progress.h:142
#define PROGRESS_COPY_TYPE_PROGRAM
Definition: progress.h:150
#define PROGRESS_COPY_BYTES_TOTAL
Definition: progress.h:138
#define PROGRESS_COPY_TYPE_CALLBACK
Definition: progress.h:152
#define PROGRESS_COPY_TYPE_PIPE
Definition: progress.h:151
#define RelationGetRelid(relation)
Definition: rel.h:504
#define RelationGetDescr(relation)
Definition: rel.h:530
#define RelationGetRelationName(relation)
Definition: rel.h:538
Node * build_column_default(Relation rel, int attrno)
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
bool binary
Definition: copy.h:43
bool convert_selectively
Definition: copy.h:62
List * force_null
Definition: copy.h:60
List * convert_select
Definition: copy.h:63
bool * force_notnull_flags
Definition: copy.h:59
int file_encoding
Definition: copy.h:41
bool * force_null_flags
Definition: copy.h:61
List * force_notnull
Definition: copy.h:58
ExprState ** defexprs
copy_data_source_cb data_source_cb
StringInfoData line_buf
CopyFormatOptions opts
StringInfoData attribute_buf
MemoryContext copycontext
const char * cur_attval
const char * cur_attname
const char * cur_relname
Definition: fmgr.h:57
Definition: pg_list.h:54
Definition: nodes.h:129
List * p_rteperminfos
Definition: parse_node.h:194
List * p_rtable
Definition: parse_node.h:193
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
#define S_ISDIR(m)
Definition: win32_port.h:333
#define fstat
Definition: win32_port.h:291

References AllocateFile(), ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert(), attnum, CopyFromStateData::attnumlist, CopyFromStateData::attribute_buf, CopyFormatOptions::binary, build_column_default(), CopyFromStateData::bytes_processed, contain_volatile_functions_not_nextval(), CopyFromStateData::conversion_proc, CopyFormatOptions::convert_select, CopyFromStateData::convert_select_flags, CopyFormatOptions::convert_selectively, COPY_CALLBACK, COPY_FILE, CopyFromStateData::copy_file, CopyFromStateData::copy_src, CopyFromStateData::copycontext, CopyGetAttnums(), cur, CopyFromStateData::cur_attname, CopyFromStateData::cur_attval, CopyFromStateData::cur_lineno, CopyFromStateData::cur_relname, CurrentMemoryContext, CopyFromStateData::data_source_cb, CopyFromStateData::defexprs, CopyFromStateData::defmap, DestRemote, CopyFromStateData::eol_type, EOL_UNKNOWN, ereport, errcode(), errcode_for_file_access(), errhint(), errmsg(), errmsg_internal(), ERROR, ExecInitExpr(), expression_planner(), CopyFormatOptions::file_encoding, CopyFromStateData::file_encoding, filename, CopyFromStateData::filename, FindDefaultConversionProc(), fmgr_info(), CopyFormatOptions::force_notnull, CopyFormatOptions::force_notnull_flags, CopyFormatOptions::force_null, CopyFormatOptions::force_null_flags, fstat, GetDatabaseEncoding(), getTypeBinaryInputInfo(), getTypeInputInfo(), CopyFromStateData::in_functions, initStringInfo(), CopyFromStateData::input_buf, CopyFromStateData::input_buf_index, CopyFromStateData::input_buf_len, INPUT_BUF_SIZE, CopyFromStateData::input_reached_eof, InvalidOid, CopyFromStateData::is_program, lfirst_int, CopyFromStateData::line_buf, list_length(), list_member_int(), CopyFromStateData::max_fields, MemoryContextSwitchTo(), NameStr, TupleDescData::natts, CopyFromStateData::need_transcoding, CopyFromStateData::num_defaults, OpenPipeStream(), CopyFromStateData::opts, ParseState::p_rtable, ParseState::p_rteperminfos, palloc(), palloc0(), PG_BINARY_R, pg_get_client_encoding(), PG_SQL_ASCII, pgstat_progress_start_command(), pgstat_progress_update_multi_param(), ProcessCopyOptions(), PROGRESS_COMMAND_COPY, PROGRESS_COPY_BYTES_TOTAL, PROGRESS_COPY_COMMAND, PROGRESS_COPY_COMMAND_FROM, PROGRESS_COPY_TYPE, PROGRESS_COPY_TYPE_CALLBACK, PROGRESS_COPY_TYPE_FILE, PROGRESS_COPY_TYPE_PIPE, PROGRESS_COPY_TYPE_PROGRAM, pstrdup(), CopyFromStateData::range_table, CopyFromStateData::raw_buf, CopyFromStateData::raw_buf_index, CopyFromStateData::raw_buf_len, RAW_BUF_SIZE, CopyFromStateData::raw_fields, CopyFromStateData::raw_reached_eof, ReceiveCopyBegin(), ReceiveCopyBinaryHeader(), CopyFromStateData::rel, RelationGetDescr, RelationGetRelationName, RelationGetRelid, CopyFromStateData::relname_only, CopyFromStateData::rteperminfos, S_ISDIR, stat::st_mode, stat::st_size, TupleDescAttr, CopyFromStateData::typioparams, CopyFromStateData::volatile_defexprs, CopyFromStateData::whereClause, and whereToSendOutput.

Referenced by copy_table(), DoCopy(), file_acquire_sample_rows(), fileBeginForeignScan(), and fileReScanForeignScan().

◆ BeginCopyTo()

CopyToState BeginCopyTo ( ParseState pstate,
Relation  rel,
RawStmt raw_query,
Oid  queryRelId,
const char *  filename,
bool  is_program,
copy_data_dest_cb  data_dest_cb,
List attnamelist,
List options 
)

Definition at line 357 of file copyto.c.

366 {
367  CopyToState cstate;
368  bool pipe = (filename == NULL && data_dest_cb == NULL);
369  TupleDesc tupDesc;
370  int num_phys_attrs;
371  MemoryContext oldcontext;
372  const int progress_cols[] = {
375  };
376  int64 progress_vals[] = {
378  0
379  };
380 
381  if (rel != NULL && rel->rd_rel->relkind != RELKIND_RELATION)
382  {
383  if (rel->rd_rel->relkind == RELKIND_VIEW)
384  ereport(ERROR,
385  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
386  errmsg("cannot copy from view \"%s\"",
388  errhint("Try the COPY (SELECT ...) TO variant.")));
389  else if (rel->rd_rel->relkind == RELKIND_MATVIEW)
390  ereport(ERROR,
391  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
392  errmsg("cannot copy from materialized view \"%s\"",
394  errhint("Try the COPY (SELECT ...) TO variant.")));
395  else if (rel->rd_rel->relkind == RELKIND_FOREIGN_TABLE)
396  ereport(ERROR,
397  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
398  errmsg("cannot copy from foreign table \"%s\"",
400  errhint("Try the COPY (SELECT ...) TO variant.")));
401  else if (rel->rd_rel->relkind == RELKIND_SEQUENCE)
402  ereport(ERROR,
403  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
404  errmsg("cannot copy from sequence \"%s\"",
405  RelationGetRelationName(rel))));
406  else if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
407  ereport(ERROR,
408  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
409  errmsg("cannot copy from partitioned table \"%s\"",
411  errhint("Try the COPY (SELECT ...) TO variant.")));
412  else
413  ereport(ERROR,
414  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
415  errmsg("cannot copy from non-table relation \"%s\"",
416  RelationGetRelationName(rel))));
417  }
418 
419 
420  /* Allocate workspace and zero all fields */
421  cstate = (CopyToStateData *) palloc0(sizeof(CopyToStateData));
422 
423  /*
424  * We allocate everything used by a cstate in a new memory context. This
425  * avoids memory leaks during repeated use of COPY in a query.
426  */
428  "COPY",
430 
431  oldcontext = MemoryContextSwitchTo(cstate->copycontext);
432 
433  /* Extract options from the statement node tree */
434  ProcessCopyOptions(pstate, &cstate->opts, false /* is_from */ , options);
435 
436  /* Process the source/target relation or query */
437  if (rel)
438  {
439  Assert(!raw_query);
440 
441  cstate->rel = rel;
442 
443  tupDesc = RelationGetDescr(cstate->rel);
444  }
445  else
446  {
447  List *rewritten;
448  Query *query;
449  PlannedStmt *plan;
451 
452  cstate->rel = NULL;
453 
454  /*
455  * Run parse analysis and rewrite. Note this also acquires sufficient
456  * locks on the source table(s).
457  */
458  rewritten = pg_analyze_and_rewrite_fixedparams(raw_query,
459  pstate->p_sourcetext, NULL, 0,
460  NULL);
461 
462  /* check that we got back something we can work with */
463  if (rewritten == NIL)
464  {
465  ereport(ERROR,
466  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
467  errmsg("DO INSTEAD NOTHING rules are not supported for COPY")));
468  }
469  else if (list_length(rewritten) > 1)
470  {
471  ListCell *lc;
472 
473  /* examine queries to determine which error message to issue */
474  foreach(lc, rewritten)
475  {
476  Query *q = lfirst_node(Query, lc);
477 
478  if (q->querySource == QSRC_QUAL_INSTEAD_RULE)
479  ereport(ERROR,
480  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
481  errmsg("conditional DO INSTEAD rules are not supported for COPY")));
482  if (q->querySource == QSRC_NON_INSTEAD_RULE)
483  ereport(ERROR,
484  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
485  errmsg("DO ALSO rules are not supported for the COPY")));
486  }
487 
488  ereport(ERROR,
489  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
490  errmsg("multi-statement DO INSTEAD rules are not supported for COPY")));
491  }
492 
493  query = linitial_node(Query, rewritten);
494 
495  /* The grammar allows SELECT INTO, but we don't support that */
496  if (query->utilityStmt != NULL &&
498  ereport(ERROR,
499  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
500  errmsg("COPY (SELECT INTO) is not supported")));
501 
502  Assert(query->utilityStmt == NULL);
503 
504  /*
505  * Similarly the grammar doesn't enforce the presence of a RETURNING
506  * clause, but this is required here.
507  */
508  if (query->commandType != CMD_SELECT &&
509  query->returningList == NIL)
510  {
511  Assert(query->commandType == CMD_INSERT ||
512  query->commandType == CMD_UPDATE ||
513  query->commandType == CMD_DELETE);
514 
515  ereport(ERROR,
516  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
517  errmsg("COPY query must have a RETURNING clause")));
518  }
519 
520  /* plan the query */
521  plan = pg_plan_query(query, pstate->p_sourcetext,
522  CURSOR_OPT_PARALLEL_OK, NULL);
523 
524  /*
525  * With row-level security and a user using "COPY relation TO", we
526  * have to convert the "COPY relation TO" to a query-based COPY (eg:
527  * "COPY (SELECT * FROM ONLY relation) TO"), to allow the rewriter to
528  * add in any RLS clauses.
529  *
530  * When this happens, we are passed in the relid of the originally
531  * found relation (which we have locked). As the planner will look up
532  * the relation again, we double-check here to make sure it found the
533  * same one that we have locked.
534  */
535  if (queryRelId != InvalidOid)
536  {
537  /*
538  * Note that with RLS involved there may be multiple relations,
539  * and while the one we need is almost certainly first, we don't
540  * make any guarantees of that in the planner, so check the whole
541  * list and make sure we find the original relation.
542  */
543  if (!list_member_oid(plan->relationOids, queryRelId))
544  ereport(ERROR,
545  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
546  errmsg("relation referenced by COPY statement has changed")));
547  }
548 
549  /*
550  * Use a snapshot with an updated command ID to ensure this query sees
551  * results of any previously executed queries.
552  */
555 
556  /* Create dest receiver for COPY OUT */
558  ((DR_copy *) dest)->cstate = cstate;
559 
560  /* Create a QueryDesc requesting no output */
561  cstate->queryDesc = CreateQueryDesc(plan, pstate->p_sourcetext,
564  dest, NULL, NULL, 0);
565 
566  /*
567  * Call ExecutorStart to prepare the plan for execution.
568  *
569  * ExecutorStart computes a result tupdesc for us
570  */
571  ExecutorStart(cstate->queryDesc, 0);
572 
573  tupDesc = cstate->queryDesc->tupDesc;
574  }
575 
576  /* Generate or convert list of attributes to process */
577  cstate->attnumlist = CopyGetAttnums(tupDesc, cstate->rel, attnamelist);
578 
579  num_phys_attrs = tupDesc->natts;
580 
581  /* Convert FORCE_QUOTE name list to per-column flags, check validity */
582  cstate->opts.force_quote_flags = (bool *) palloc0(num_phys_attrs * sizeof(bool));
583  if (cstate->opts.force_quote_all)
584  {
585  int i;
586 
587  for (i = 0; i < num_phys_attrs; i++)
588  cstate->opts.force_quote_flags[i] = true;
589  }
590  else if (cstate->opts.force_quote)
591  {
592  List *attnums;
593  ListCell *cur;
594 
595  attnums = CopyGetAttnums(tupDesc, cstate->rel, cstate->opts.force_quote);
596 
597  foreach(cur, attnums)
598  {
599  int attnum = lfirst_int(cur);
600  Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
601 
602  if (!list_member_int(cstate->attnumlist, attnum))
603  ereport(ERROR,
604  (errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
605  errmsg("FORCE_QUOTE column \"%s\" not referenced by COPY",
606  NameStr(attr->attname))));
607  cstate->opts.force_quote_flags[attnum - 1] = true;
608  }
609  }
610 
611  /* Use client encoding when ENCODING option is not specified. */
612  if (cstate->opts.file_encoding < 0)
614  else
615  cstate->file_encoding = cstate->opts.file_encoding;
616 
617  /*
618  * Set up encoding conversion info. Even if the file and server encodings
619  * are the same, we must apply pg_any_to_server() to validate data in
620  * multibyte encodings.
621  */
622  cstate->need_transcoding =
623  (cstate->file_encoding != GetDatabaseEncoding() ||
625  /* See Multibyte encoding comment above */
627 
628  cstate->copy_dest = COPY_FILE; /* default */
629 
630  if (data_dest_cb)
631  {
632  progress_vals[1] = PROGRESS_COPY_TYPE_CALLBACK;
633  cstate->copy_dest = COPY_CALLBACK;
634  cstate->data_dest_cb = data_dest_cb;
635  }
636  else if (pipe)
637  {
638  progress_vals[1] = PROGRESS_COPY_TYPE_PIPE;
639 
640  Assert(!is_program); /* the grammar does not allow this */
642  cstate->copy_file = stdout;
643  }
644  else
645  {
646  cstate->filename = pstrdup(filename);
647  cstate->is_program = is_program;
648 
649  if (is_program)
650  {
651  progress_vals[1] = PROGRESS_COPY_TYPE_PROGRAM;
652  cstate->copy_file = OpenPipeStream(cstate->filename, PG_BINARY_W);
653  if (cstate->copy_file == NULL)
654  ereport(ERROR,
656  errmsg("could not execute command \"%s\": %m",
657  cstate->filename)));
658  }
659  else
660  {
661  mode_t oumask; /* Pre-existing umask value */
662  struct stat st;
663 
664  progress_vals[1] = PROGRESS_COPY_TYPE_FILE;
665 
666  /*
667  * Prevent write to relative path ... too easy to shoot oneself in
668  * the foot by overwriting a database file ...
669  */
671  ereport(ERROR,
672  (errcode(ERRCODE_INVALID_NAME),
673  errmsg("relative path not allowed for COPY to file")));
674 
675  oumask = umask(S_IWGRP | S_IWOTH);
676  PG_TRY();
677  {
678  cstate->copy_file = AllocateFile(cstate->filename, PG_BINARY_W);
679  }
680  PG_FINALLY();
681  {
682  umask(oumask);
683  }
684  PG_END_TRY();
685  if (cstate->copy_file == NULL)
686  {
687  /* copy errno because ereport subfunctions might change it */
688  int save_errno = errno;
689 
690  ereport(ERROR,
692  errmsg("could not open file \"%s\" for writing: %m",
693  cstate->filename),
694  (save_errno == ENOENT || save_errno == EACCES) ?
695  errhint("COPY TO instructs the PostgreSQL server process to write a file. "
696  "You may want a client-side facility such as psql's \\copy.") : 0));
697  }
698 
699  if (fstat(fileno(cstate->copy_file), &st))
700  ereport(ERROR,
702  errmsg("could not stat file \"%s\": %m",
703  cstate->filename)));
704 
705  if (S_ISDIR(st.st_mode))
706  ereport(ERROR,
707  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
708  errmsg("\"%s\" is a directory", cstate->filename)));
709  }
710  }
711 
712  /* initialize progress */
714  cstate->rel ? RelationGetRelid(cstate->rel) : InvalidOid);
715  pgstat_progress_update_multi_param(2, progress_cols, progress_vals);
716 
717  cstate->bytes_processed = 0;
718 
719  MemoryContextSwitchTo(oldcontext);
720 
721  return cstate;
722 }
#define PG_BINARY_W
Definition: c.h:1281
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:113
@ DestCopyOut
Definition: dest.h:95
#define PG_TRY(...)
Definition: elog.h:370
#define PG_END_TRY(...)
Definition: elog.h:395
#define PG_FINALLY(...)
Definition: elog.h:387
void ExecutorStart(QueryDesc *queryDesc, int eflags)
Definition: execMain.c:132
int i
Definition: isn.c:73
bool list_member_oid(const List *list, Oid datum)
Definition: list.c:721
int pg_database_encoding_max_length(void)
Definition: mbutils.c:1553
#define IsA(nodeptr, _type_)
Definition: nodes.h:179
@ CMD_INSERT
Definition: nodes.h:278
@ CMD_DELETE
Definition: nodes.h:279
@ CMD_UPDATE
Definition: nodes.h:277
@ CMD_SELECT
Definition: nodes.h:276
@ QSRC_NON_INSTEAD_RULE
Definition: parsenodes.h:47
@ QSRC_QUAL_INSTEAD_RULE
Definition: parsenodes.h:46
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:3123
#define lfirst_node(type, lc)
Definition: pg_list.h:176
#define linitial_node(type, l)
Definition: pg_list.h:181
#define NIL
Definition: pg_list.h:68
#define plan(x)
Definition: pg_regress.c:154
#define PG_ENCODING_IS_CLIENT_ONLY(_enc)
Definition: pg_wchar.h:284
#define is_absolute_path(filename)
Definition: port.h:103
List * pg_analyze_and_rewrite_fixedparams(RawStmt *parsetree, const char *query_string, const Oid *paramTypes, int numParams, QueryEnvironment *queryEnv)
Definition: postgres.c:671
PlannedStmt * pg_plan_query(Query *querytree, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: postgres.c:886
QueryDesc * CreateQueryDesc(PlannedStmt *plannedstmt, const char *sourceText, Snapshot snapshot, Snapshot crosscheck_snapshot, DestReceiver *dest, ParamListInfo params, QueryEnvironment *queryEnv, int instrument_options)
Definition: pquery.c:67
#define PROGRESS_COPY_COMMAND_TO
Definition: progress.h:146
void UpdateActiveSnapshotCommandId(void)
Definition: snapmgr.c:747
void PushCopiedSnapshot(Snapshot snapshot)
Definition: snapmgr.c:735
Snapshot GetActiveSnapshot(void)
Definition: snapmgr.c:805
#define InvalidSnapshot
Definition: snapshot.h:123
bool force_quote_all
Definition: copy.h:56
List * force_quote
Definition: copy.h:55
bool * force_quote_flags
Definition: copy.h:57
MemoryContext copycontext
Definition: copyto.c:97
Relation rel
Definition: copyto.c:84
copy_data_dest_cb data_dest_cb
Definition: copyto.c:89
bool encoding_embeds_ascii
Definition: copyto.c:81
CopyDest copy_dest
Definition: copyto.c:75
bool need_transcoding
Definition: copyto.c:80
bool is_program
Definition: copyto.c:88
FILE * copy_file
Definition: copyto.c:76
int file_encoding
Definition: copyto.c:79
CopyFormatOptions opts
Definition: copyto.c:91
uint64 bytes_processed
Definition: copyto.c:101
char * filename
Definition: copyto.c:87
List * attnumlist
Definition: copyto.c:86
QueryDesc * queryDesc
Definition: copyto.c:85
const char * p_sourcetext
Definition: parse_node.h:192
TupleDesc tupDesc
Definition: execdesc.h:47
List * returningList
Definition: parsenodes.h:196
CmdType commandType
Definition: parsenodes.h:128
Node * utilityStmt
Definition: parsenodes.h:143
Form_pg_class rd_rel
Definition: rel.h:111
#define S_IWOTH
Definition: win32_port.h:324
#define S_IWGRP
Definition: win32_port.h:312

References AllocateFile(), ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert(), attnum, CopyToStateData::attnumlist, CopyToStateData::bytes_processed, CMD_DELETE, CMD_INSERT, CMD_SELECT, CMD_UPDATE, Query::commandType, COPY_CALLBACK, CopyToStateData::copy_dest, COPY_FILE, CopyToStateData::copy_file, CopyToStateData::copycontext, CopyGetAttnums(), CreateDestReceiver(), CreateQueryDesc(), cur, CurrentMemoryContext, CURSOR_OPT_PARALLEL_OK, CopyToStateData::data_dest_cb, generate_unaccent_rules::dest, DestCopyOut, DestRemote, CopyToStateData::encoding_embeds_ascii, ereport, errcode(), errcode_for_file_access(), errhint(), errmsg(), ERROR, ExecutorStart(), CopyToStateData::file_encoding, CopyFormatOptions::file_encoding, CopyToStateData::filename, filename, CopyFormatOptions::force_quote, CopyFormatOptions::force_quote_all, CopyFormatOptions::force_quote_flags, fstat, GetActiveSnapshot(), GetDatabaseEncoding(), i, InvalidOid, InvalidSnapshot, is_absolute_path, CopyToStateData::is_program, IsA, lfirst_int, lfirst_node, linitial_node, list_length(), list_member_int(), list_member_oid(), MemoryContextSwitchTo(), NameStr, TupleDescData::natts, CopyToStateData::need_transcoding, NIL, OpenPipeStream(), CopyToStateData::opts, ParseState::p_sourcetext, palloc0(), pg_analyze_and_rewrite_fixedparams(), PG_BINARY_W, pg_database_encoding_max_length(), PG_ENCODING_IS_CLIENT_ONLY, PG_END_TRY, PG_FINALLY, pg_get_client_encoding(), pg_plan_query(), PG_TRY, pgstat_progress_start_command(), pgstat_progress_update_multi_param(), plan, ProcessCopyOptions(), PROGRESS_COMMAND_COPY, PROGRESS_COPY_COMMAND, PROGRESS_COPY_COMMAND_TO, PROGRESS_COPY_TYPE, PROGRESS_COPY_TYPE_CALLBACK, PROGRESS_COPY_TYPE_FILE, PROGRESS_COPY_TYPE_PIPE, PROGRESS_COPY_TYPE_PROGRAM, pstrdup(), PushCopiedSnapshot(), QSRC_NON_INSTEAD_RULE, QSRC_QUAL_INSTEAD_RULE, CopyToStateData::queryDesc, RelationData::rd_rel, CopyToStateData::rel, RelationGetDescr, RelationGetRelationName, RelationGetRelid, Query::returningList, S_ISDIR, S_IWGRP, S_IWOTH, stat::st_mode, generate_unaccent_rules::stdout, QueryDesc::tupDesc, TupleDescAttr, UpdateActiveSnapshotCommandId(), Query::utilityStmt, and whereToSendOutput.

Referenced by DoCopy(), and test_copy_to_callback().

◆ CopyFrom()

uint64 CopyFrom ( CopyFromState  cstate)

Definition at line 632 of file copyfrom.c.

633 {
634  ResultRelInfo *resultRelInfo;
635  ResultRelInfo *target_resultRelInfo;
636  ResultRelInfo *prevResultRelInfo = NULL;
637  EState *estate = CreateExecutorState(); /* for ExecConstraints() */
638  ModifyTableState *mtstate;
639  ExprContext *econtext;
640  TupleTableSlot *singleslot = NULL;
641  MemoryContext oldcontext = CurrentMemoryContext;
642 
643  PartitionTupleRouting *proute = NULL;
644  ErrorContextCallback errcallback;
645  CommandId mycid = GetCurrentCommandId(true);
646  int ti_options = 0; /* start with default options for insert */
647  BulkInsertState bistate = NULL;
648  CopyInsertMethod insertMethod;
649  CopyMultiInsertInfo multiInsertInfo = {0}; /* pacify compiler */
650  int64 processed = 0;
651  int64 excluded = 0;
652  bool has_before_insert_row_trig;
653  bool has_instead_insert_row_trig;
654  bool leafpart_use_multi_insert = false;
655 
656  Assert(cstate->rel);
657  Assert(list_length(cstate->range_table) == 1);
658 
659  /*
660  * The target must be a plain, foreign, or partitioned relation, or have
661  * an INSTEAD OF INSERT row trigger. (Currently, such triggers are only
662  * allowed on views, so we only hint about them in the view case.)
663  */
664  if (cstate->rel->rd_rel->relkind != RELKIND_RELATION &&
665  cstate->rel->rd_rel->relkind != RELKIND_FOREIGN_TABLE &&
666  cstate->rel->rd_rel->relkind != RELKIND_PARTITIONED_TABLE &&
667  !(cstate->rel->trigdesc &&
669  {
670  if (cstate->rel->rd_rel->relkind == RELKIND_VIEW)
671  ereport(ERROR,
672  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
673  errmsg("cannot copy to view \"%s\"",
674  RelationGetRelationName(cstate->rel)),
675  errhint("To enable copying to a view, provide an INSTEAD OF INSERT trigger.")));
676  else if (cstate->rel->rd_rel->relkind == RELKIND_MATVIEW)
677  ereport(ERROR,
678  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
679  errmsg("cannot copy to materialized view \"%s\"",
680  RelationGetRelationName(cstate->rel))));
681  else if (cstate->rel->rd_rel->relkind == RELKIND_SEQUENCE)
682  ereport(ERROR,
683  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
684  errmsg("cannot copy to sequence \"%s\"",
685  RelationGetRelationName(cstate->rel))));
686  else
687  ereport(ERROR,
688  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
689  errmsg("cannot copy to non-table relation \"%s\"",
690  RelationGetRelationName(cstate->rel))));
691  }
692 
693  /*
694  * If the target file is new-in-transaction, we assume that checking FSM
695  * for free space is a waste of time. This could possibly be wrong, but
696  * it's unlikely.
697  */
698  if (RELKIND_HAS_STORAGE(cstate->rel->rd_rel->relkind) &&
701  ti_options |= TABLE_INSERT_SKIP_FSM;
702 
703  /*
704  * Optimize if new relation storage was created in this subxact or one of
705  * its committed children and we won't see those rows later as part of an
706  * earlier scan or command. The subxact test ensures that if this subxact
707  * aborts then the frozen rows won't be visible after xact cleanup. Note
708  * that the stronger test of exactly which subtransaction created it is
709  * crucial for correctness of this optimization. The test for an earlier
710  * scan or command tolerates false negatives. FREEZE causes other sessions
711  * to see rows they would not see under MVCC, and a false negative merely
712  * spreads that anomaly to the current session.
713  */
714  if (cstate->opts.freeze)
715  {
716  /*
717  * We currently disallow COPY FREEZE on partitioned tables. The
718  * reason for this is that we've simply not yet opened the partitions
719  * to determine if the optimization can be applied to them. We could
720  * go and open them all here, but doing so may be quite a costly
721  * overhead for small copies. In any case, we may just end up routing
722  * tuples to a small number of partitions. It seems better just to
723  * raise an ERROR for partitioned tables.
724  */
725  if (cstate->rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
726  {
727  ereport(ERROR,
728  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
729  errmsg("cannot perform COPY FREEZE on a partitioned table")));
730  }
731 
732  /*
733  * Tolerate one registration for the benefit of FirstXactSnapshot.
734  * Scan-bearing queries generally create at least two registrations,
735  * though relying on that is fragile, as is ignoring ActiveSnapshot.
736  * Clear CatalogSnapshot to avoid counting its registration. We'll
737  * still detect ongoing catalog scans, each of which separately
738  * registers the snapshot it uses.
739  */
742  ereport(ERROR,
743  (errcode(ERRCODE_INVALID_TRANSACTION_STATE),
744  errmsg("cannot perform COPY FREEZE because of prior transaction activity")));
745 
746  if (cstate->rel->rd_createSubid != GetCurrentSubTransactionId() &&
748  ereport(ERROR,
749  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
750  errmsg("cannot perform COPY FREEZE because the table was not created or truncated in the current subtransaction")));
751 
752  ti_options |= TABLE_INSERT_FROZEN;
753  }
754 
755  /*
756  * We need a ResultRelInfo so we can use the regular executor's
757  * index-entry-making machinery. (There used to be a huge amount of code
758  * here that basically duplicated execUtils.c ...)
759  */
760  ExecInitRangeTable(estate, cstate->range_table, cstate->rteperminfos);
761  resultRelInfo = target_resultRelInfo = makeNode(ResultRelInfo);
762  ExecInitResultRelation(estate, resultRelInfo, 1);
763 
764  /* Verify the named relation is a valid target for INSERT */
765  CheckValidResultRel(resultRelInfo, CMD_INSERT);
766 
767  ExecOpenIndices(resultRelInfo, false);
768 
769  /*
770  * Set up a ModifyTableState so we can let FDW(s) init themselves for
771  * foreign-table result relation(s).
772  */
773  mtstate = makeNode(ModifyTableState);
774  mtstate->ps.plan = NULL;
775  mtstate->ps.state = estate;
776  mtstate->operation = CMD_INSERT;
777  mtstate->mt_nrels = 1;
778  mtstate->resultRelInfo = resultRelInfo;
779  mtstate->rootResultRelInfo = resultRelInfo;
780 
781  if (resultRelInfo->ri_FdwRoutine != NULL &&
782  resultRelInfo->ri_FdwRoutine->BeginForeignInsert != NULL)
783  resultRelInfo->ri_FdwRoutine->BeginForeignInsert(mtstate,
784  resultRelInfo);
785 
786  /*
787  * Also, if the named relation is a foreign table, determine if the FDW
788  * supports batch insert and determine the batch size (a FDW may support
789  * batching, but it may be disabled for the server/table).
790  *
791  * If the FDW does not support batching, we set the batch size to 1.
792  */
793  if (resultRelInfo->ri_FdwRoutine != NULL &&
794  resultRelInfo->ri_FdwRoutine->GetForeignModifyBatchSize &&
795  resultRelInfo->ri_FdwRoutine->ExecForeignBatchInsert)
796  resultRelInfo->ri_BatchSize =
797  resultRelInfo->ri_FdwRoutine->GetForeignModifyBatchSize(resultRelInfo);
798  else
799  resultRelInfo->ri_BatchSize = 1;
800 
801  Assert(resultRelInfo->ri_BatchSize >= 1);
802 
803  /* Prepare to catch AFTER triggers. */
805 
806  /*
807  * If there are any triggers with transition tables on the named relation,
808  * we need to be prepared to capture transition tuples.
809  *
810  * Because partition tuple routing would like to know about whether
811  * transition capture is active, we also set it in mtstate, which is
812  * passed to ExecFindPartition() below.
813  */
814  cstate->transition_capture = mtstate->mt_transition_capture =
816  RelationGetRelid(cstate->rel),
817  CMD_INSERT);
818 
819  /*
820  * If the named relation is a partitioned table, initialize state for
821  * CopyFrom tuple routing.
822  */
823  if (cstate->rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
824  proute = ExecSetupPartitionTupleRouting(estate, cstate->rel);
825 
826  if (cstate->whereClause)
827  cstate->qualexpr = ExecInitQual(castNode(List, cstate->whereClause),
828  &mtstate->ps);
829 
830  /*
831  * It's generally more efficient to prepare a bunch of tuples for
832  * insertion, and insert them in one
833  * table_multi_insert()/ExecForeignBatchInsert() call, than call
834  * table_tuple_insert()/ExecForeignInsert() separately for every tuple.
835  * However, there are a number of reasons why we might not be able to do
836  * this. These are explained below.
837  */
838  if (resultRelInfo->ri_TrigDesc != NULL &&
839  (resultRelInfo->ri_TrigDesc->trig_insert_before_row ||
840  resultRelInfo->ri_TrigDesc->trig_insert_instead_row))
841  {
842  /*
843  * Can't support multi-inserts when there are any BEFORE/INSTEAD OF
844  * triggers on the table. Such triggers might query the table we're
845  * inserting into and act differently if the tuples that have already
846  * been processed and prepared for insertion are not there.
847  */
848  insertMethod = CIM_SINGLE;
849  }
850  else if (resultRelInfo->ri_FdwRoutine != NULL &&
851  resultRelInfo->ri_BatchSize == 1)
852  {
853  /*
854  * Can't support multi-inserts to a foreign table if the FDW does not
855  * support batching, or it's disabled for the server or foreign table.
856  */
857  insertMethod = CIM_SINGLE;
858  }
859  else if (proute != NULL && resultRelInfo->ri_TrigDesc != NULL &&
860  resultRelInfo->ri_TrigDesc->trig_insert_new_table)
861  {
862  /*
863  * For partitioned tables we can't support multi-inserts when there
864  * are any statement level insert triggers. It might be possible to
865  * allow partitioned tables with such triggers in the future, but for
866  * now, CopyMultiInsertInfoFlush expects that any after row insert and
867  * statement level insert triggers are on the same relation.
868  */
869  insertMethod = CIM_SINGLE;
870  }
871  else if (cstate->volatile_defexprs)
872  {
873  /*
874  * Can't support multi-inserts if there are any volatile default
875  * expressions in the table. Similarly to the trigger case above,
876  * such expressions may query the table we're inserting into.
877  *
878  * Note: It does not matter if any partitions have any volatile
879  * default expressions as we use the defaults from the target of the
880  * COPY command.
881  */
882  insertMethod = CIM_SINGLE;
883  }
884  else if (contain_volatile_functions(cstate->whereClause))
885  {
886  /*
887  * Can't support multi-inserts if there are any volatile function
888  * expressions in WHERE clause. Similarly to the trigger case above,
889  * such expressions may query the table we're inserting into.
890  */
891  insertMethod = CIM_SINGLE;
892  }
893  else
894  {
895  /*
896  * For partitioned tables, we may still be able to perform bulk
897  * inserts. However, the possibility of this depends on which types
898  * of triggers exist on the partition. We must disable bulk inserts
899  * if the partition is a foreign table that can't use batching or it
900  * has any before row insert or insert instead triggers (same as we
901  * checked above for the parent table). Since the partition's
902  * resultRelInfos are initialized only when we actually need to insert
903  * the first tuple into them, we must have the intermediate insert
904  * method of CIM_MULTI_CONDITIONAL to flag that we must later
905  * determine if we can use bulk-inserts for the partition being
906  * inserted into.
907  */
908  if (proute)
909  insertMethod = CIM_MULTI_CONDITIONAL;
910  else
911  insertMethod = CIM_MULTI;
912 
913  CopyMultiInsertInfoInit(&multiInsertInfo, resultRelInfo, cstate,
914  estate, mycid, ti_options);
915  }
916 
917  /*
918  * If not using batch mode (which allocates slots as needed) set up a
919  * tuple slot too. When inserting into a partitioned table, we also need
920  * one, even if we might batch insert, to read the tuple in the root
921  * partition's form.
922  */
923  if (insertMethod == CIM_SINGLE || insertMethod == CIM_MULTI_CONDITIONAL)
924  {
925  singleslot = table_slot_create(resultRelInfo->ri_RelationDesc,
926  &estate->es_tupleTable);
927  bistate = GetBulkInsertState();
928  }
929 
930  has_before_insert_row_trig = (resultRelInfo->ri_TrigDesc &&
931  resultRelInfo->ri_TrigDesc->trig_insert_before_row);
932 
933  has_instead_insert_row_trig = (resultRelInfo->ri_TrigDesc &&
934  resultRelInfo->ri_TrigDesc->trig_insert_instead_row);
935 
936  /*
937  * Check BEFORE STATEMENT insertion triggers. It's debatable whether we
938  * should do this for COPY, since it's not really an "INSERT" statement as
939  * such. However, executing these triggers maintains consistency with the
940  * EACH ROW triggers that we already fire on COPY.
941  */
942  ExecBSInsertTriggers(estate, resultRelInfo);
943 
944  econtext = GetPerTupleExprContext(estate);
945 
946  /* Set up callback to identify error line number */
947  errcallback.callback = CopyFromErrorCallback;
948  errcallback.arg = (void *) cstate;
949  errcallback.previous = error_context_stack;
950  error_context_stack = &errcallback;
951 
952  for (;;)
953  {
954  TupleTableSlot *myslot;
955  bool skip_tuple;
956 
958 
959  /*
960  * Reset the per-tuple exprcontext. We do this after every tuple, to
961  * clean-up after expression evaluations etc.
962  */
963  ResetPerTupleExprContext(estate);
964 
965  /* select slot to (initially) load row into */
966  if (insertMethod == CIM_SINGLE || proute)
967  {
968  myslot = singleslot;
969  Assert(myslot != NULL);
970  }
971  else
972  {
973  Assert(resultRelInfo == target_resultRelInfo);
974  Assert(insertMethod == CIM_MULTI);
975 
976  myslot = CopyMultiInsertInfoNextFreeSlot(&multiInsertInfo,
977  resultRelInfo);
978  }
979 
980  /*
981  * Switch to per-tuple context before calling NextCopyFrom, which does
982  * evaluate default expressions etc. and requires per-tuple context.
983  */
985 
986  ExecClearTuple(myslot);
987 
988  /* Directly store the values/nulls array in the slot */
989  if (!NextCopyFrom(cstate, econtext, myslot->tts_values, myslot->tts_isnull))
990  break;
991 
992  ExecStoreVirtualTuple(myslot);
993 
994  /*
995  * Constraints and where clause might reference the tableoid column,
996  * so (re-)initialize tts_tableOid before evaluating them.
997  */
998  myslot->tts_tableOid = RelationGetRelid(target_resultRelInfo->ri_RelationDesc);
999 
1000  /* Triggers and stuff need to be invoked in query context. */
1001  MemoryContextSwitchTo(oldcontext);
1002 
1003  if (cstate->whereClause)
1004  {
1005  econtext->ecxt_scantuple = myslot;
1006  /* Skip items that don't match COPY's WHERE clause */
1007  if (!ExecQual(cstate->qualexpr, econtext))
1008  {
1009  /*
1010  * Report that this tuple was filtered out by the WHERE
1011  * clause.
1012  */
1014  ++excluded);
1015  continue;
1016  }
1017  }
1018 
1019  /* Determine the partition to insert the tuple into */
1020  if (proute)
1021  {
1022  TupleConversionMap *map;
1023 
1024  /*
1025  * Attempt to find a partition suitable for this tuple.
1026  * ExecFindPartition() will raise an error if none can be found or
1027  * if the found partition is not suitable for INSERTs.
1028  */
1029  resultRelInfo = ExecFindPartition(mtstate, target_resultRelInfo,
1030  proute, myslot, estate);
1031 
1032  if (prevResultRelInfo != resultRelInfo)
1033  {
1034  /* Determine which triggers exist on this partition */
1035  has_before_insert_row_trig = (resultRelInfo->ri_TrigDesc &&
1036  resultRelInfo->ri_TrigDesc->trig_insert_before_row);
1037 
1038  has_instead_insert_row_trig = (resultRelInfo->ri_TrigDesc &&
1039  resultRelInfo->ri_TrigDesc->trig_insert_instead_row);
1040 
1041  /*
1042  * Disable multi-inserts when the partition has BEFORE/INSTEAD
1043  * OF triggers, or if the partition is a foreign table that
1044  * can't use batching.
1045  */
1046  leafpart_use_multi_insert = insertMethod == CIM_MULTI_CONDITIONAL &&
1047  !has_before_insert_row_trig &&
1048  !has_instead_insert_row_trig &&
1049  (resultRelInfo->ri_FdwRoutine == NULL ||
1050  resultRelInfo->ri_BatchSize > 1);
1051 
1052  /* Set the multi-insert buffer to use for this partition. */
1053  if (leafpart_use_multi_insert)
1054  {
1055  if (resultRelInfo->ri_CopyMultiInsertBuffer == NULL)
1056  CopyMultiInsertInfoSetupBuffer(&multiInsertInfo,
1057  resultRelInfo);
1058  }
1059  else if (insertMethod == CIM_MULTI_CONDITIONAL &&
1060  !CopyMultiInsertInfoIsEmpty(&multiInsertInfo))
1061  {
1062  /*
1063  * Flush pending inserts if this partition can't use
1064  * batching, so rows are visible to triggers etc.
1065  */
1066  CopyMultiInsertInfoFlush(&multiInsertInfo,
1067  resultRelInfo,
1068  &processed);
1069  }
1070 
1071  if (bistate != NULL)
1072  ReleaseBulkInsertStatePin(bistate);
1073  prevResultRelInfo = resultRelInfo;
1074  }
1075 
1076  /*
1077  * If we're capturing transition tuples, we might need to convert
1078  * from the partition rowtype to root rowtype. But if there are no
1079  * BEFORE triggers on the partition that could change the tuple,
1080  * we can just remember the original unconverted tuple to avoid a
1081  * needless round trip conversion.
1082  */
1083  if (cstate->transition_capture != NULL)
1085  !has_before_insert_row_trig ? myslot : NULL;
1086 
1087  /*
1088  * We might need to convert from the root rowtype to the partition
1089  * rowtype.
1090  */
1091  map = ExecGetRootToChildMap(resultRelInfo, estate);
1092  if (insertMethod == CIM_SINGLE || !leafpart_use_multi_insert)
1093  {
1094  /* non batch insert */
1095  if (map != NULL)
1096  {
1097  TupleTableSlot *new_slot;
1098 
1099  new_slot = resultRelInfo->ri_PartitionTupleSlot;
1100  myslot = execute_attr_map_slot(map->attrMap, myslot, new_slot);
1101  }
1102  }
1103  else
1104  {
1105  /*
1106  * Prepare to queue up tuple for later batch insert into
1107  * current partition.
1108  */
1109  TupleTableSlot *batchslot;
1110 
1111  /* no other path available for partitioned table */
1112  Assert(insertMethod == CIM_MULTI_CONDITIONAL);
1113 
1114  batchslot = CopyMultiInsertInfoNextFreeSlot(&multiInsertInfo,
1115  resultRelInfo);
1116 
1117  if (map != NULL)
1118  myslot = execute_attr_map_slot(map->attrMap, myslot,
1119  batchslot);
1120  else
1121  {
1122  /*
1123  * This looks more expensive than it is (Believe me, I
1124  * optimized it away. Twice.). The input is in virtual
1125  * form, and we'll materialize the slot below - for most
1126  * slot types the copy performs the work materialization
1127  * would later require anyway.
1128  */
1129  ExecCopySlot(batchslot, myslot);
1130  myslot = batchslot;
1131  }
1132  }
1133 
1134  /* ensure that triggers etc see the right relation */
1135  myslot->tts_tableOid = RelationGetRelid(resultRelInfo->ri_RelationDesc);
1136  }
1137 
1138  skip_tuple = false;
1139 
1140  /* BEFORE ROW INSERT Triggers */
1141  if (has_before_insert_row_trig)
1142  {
1143  if (!ExecBRInsertTriggers(estate, resultRelInfo, myslot))
1144  skip_tuple = true; /* "do nothing" */
1145  }
1146 
1147  if (!skip_tuple)
1148  {
1149  /*
1150  * If there is an INSTEAD OF INSERT ROW trigger, let it handle the
1151  * tuple. Otherwise, proceed with inserting the tuple into the
1152  * table or foreign table.
1153  */
1154  if (has_instead_insert_row_trig)
1155  {
1156  ExecIRInsertTriggers(estate, resultRelInfo, myslot);
1157  }
1158  else
1159  {
1160  /* Compute stored generated columns */
1161  if (resultRelInfo->ri_RelationDesc->rd_att->constr &&
1163  ExecComputeStoredGenerated(resultRelInfo, estate, myslot,
1164  CMD_INSERT);
1165 
1166  /*
1167  * If the target is a plain table, check the constraints of
1168  * the tuple.
1169  */
1170  if (resultRelInfo->ri_FdwRoutine == NULL &&
1171  resultRelInfo->ri_RelationDesc->rd_att->constr)
1172  ExecConstraints(resultRelInfo, myslot, estate);
1173 
1174  /*
1175  * Also check the tuple against the partition constraint, if
1176  * there is one; except that if we got here via tuple-routing,
1177  * we don't need to if there's no BR trigger defined on the
1178  * partition.
1179  */
1180  if (resultRelInfo->ri_RelationDesc->rd_rel->relispartition &&
1181  (proute == NULL || has_before_insert_row_trig))
1182  ExecPartitionCheck(resultRelInfo, myslot, estate, true);
1183 
1184  /* Store the slot in the multi-insert buffer, when enabled. */
1185  if (insertMethod == CIM_MULTI || leafpart_use_multi_insert)
1186  {
1187  /*
1188  * The slot previously might point into the per-tuple
1189  * context. For batching it needs to be longer lived.
1190  */
1191  ExecMaterializeSlot(myslot);
1192 
1193  /* Add this tuple to the tuple buffer */
1194  CopyMultiInsertInfoStore(&multiInsertInfo,
1195  resultRelInfo, myslot,
1196  cstate->line_buf.len,
1197  cstate->cur_lineno);
1198 
1199  /*
1200  * If enough inserts have queued up, then flush all
1201  * buffers out to their tables.
1202  */
1203  if (CopyMultiInsertInfoIsFull(&multiInsertInfo))
1204  CopyMultiInsertInfoFlush(&multiInsertInfo,
1205  resultRelInfo,
1206  &processed);
1207 
1208  /*
1209  * We delay updating the row counter and progress of the
1210  * COPY command until after writing the tuples stored in
1211  * the buffer out to the table, as in single insert mode.
1212  * See CopyMultiInsertBufferFlush().
1213  */
1214  continue; /* next tuple please */
1215  }
1216  else
1217  {
1218  List *recheckIndexes = NIL;
1219 
1220  /* OK, store the tuple */
1221  if (resultRelInfo->ri_FdwRoutine != NULL)
1222  {
1223  myslot = resultRelInfo->ri_FdwRoutine->ExecForeignInsert(estate,
1224  resultRelInfo,
1225  myslot,
1226  NULL);
1227 
1228  if (myslot == NULL) /* "do nothing" */
1229  continue; /* next tuple please */
1230 
1231  /*
1232  * AFTER ROW Triggers might reference the tableoid
1233  * column, so (re-)initialize tts_tableOid before
1234  * evaluating them.
1235  */
1236  myslot->tts_tableOid = RelationGetRelid(resultRelInfo->ri_RelationDesc);
1237  }
1238  else
1239  {
1240  /* OK, store the tuple and create index entries for it */
1241  table_tuple_insert(resultRelInfo->ri_RelationDesc,
1242  myslot, mycid, ti_options, bistate);
1243 
1244  if (resultRelInfo->ri_NumIndices > 0)
1245  recheckIndexes = ExecInsertIndexTuples(resultRelInfo,
1246  myslot,
1247  estate,
1248  false,
1249  false,
1250  NULL,
1251  NIL,
1252  false);
1253  }
1254 
1255  /* AFTER ROW INSERT Triggers */
1256  ExecARInsertTriggers(estate, resultRelInfo, myslot,
1257  recheckIndexes, cstate->transition_capture);
1258 
1259  list_free(recheckIndexes);
1260  }
1261  }
1262 
1263  /*
1264  * We count only tuples not suppressed by a BEFORE INSERT trigger
1265  * or FDW; this is the same definition used by nodeModifyTable.c
1266  * for counting tuples inserted by an INSERT command. Update
1267  * progress of the COPY command as well.
1268  */
1270  ++processed);
1271  }
1272  }
1273 
1274  /* Flush any remaining buffered tuples */
1275  if (insertMethod != CIM_SINGLE)
1276  {
1277  if (!CopyMultiInsertInfoIsEmpty(&multiInsertInfo))
1278  CopyMultiInsertInfoFlush(&multiInsertInfo, NULL, &processed);
1279  }
1280 
1281  /* Done, clean up */
1282  error_context_stack = errcallback.previous;
1283 
1284  if (bistate != NULL)
1285  FreeBulkInsertState(bistate);
1286 
1287  MemoryContextSwitchTo(oldcontext);
1288 
1289  /* Execute AFTER STATEMENT insertion triggers */
1290  ExecASInsertTriggers(estate, target_resultRelInfo, cstate->transition_capture);
1291 
1292  /* Handle queued AFTER triggers */
1293  AfterTriggerEndQuery(estate);
1294 
1295  ExecResetTupleTable(estate->es_tupleTable, false);
1296 
1297  /* Allow the FDW to shut down */
1298  if (target_resultRelInfo->ri_FdwRoutine != NULL &&
1299  target_resultRelInfo->ri_FdwRoutine->EndForeignInsert != NULL)
1300  target_resultRelInfo->ri_FdwRoutine->EndForeignInsert(estate,
1301  target_resultRelInfo);
1302 
1303  /* Tear down the multi-insert buffer data */
1304  if (insertMethod != CIM_SINGLE)
1305  CopyMultiInsertInfoCleanup(&multiInsertInfo);
1306 
1307  /* Close all the partitioned tables, leaf partitions, and their indices */
1308  if (proute)
1309  ExecCleanupTupleRouting(mtstate, proute);
1310 
1311  /* Close the result relations, including any trigger target relations */
1312  ExecCloseResultRelations(estate);
1314 
1315  FreeExecutorState(estate);
1316 
1317  return processed;
1318 }
void pgstat_progress_update_param(int index, int64 val)
#define InvalidSubTransactionId
Definition: c.h:642
uint32 CommandId
Definition: c.h:650
bool contain_volatile_functions(Node *clause)
Definition: clauses.c:483
static void CopyMultiInsertInfoSetupBuffer(CopyMultiInsertInfo *miinfo, ResultRelInfo *rri)
Definition: copyfrom.c:242
static void CopyMultiInsertInfoInit(CopyMultiInsertInfo *miinfo, ResultRelInfo *rri, CopyFromState cstate, EState *estate, CommandId mycid, int ti_options)
Definition: copyfrom.c:262
static void CopyMultiInsertInfoFlush(CopyMultiInsertInfo *miinfo, ResultRelInfo *curr_rri, int64 *processed)
Definition: copyfrom.c:524
static void CopyMultiInsertInfoStore(CopyMultiInsertInfo *miinfo, ResultRelInfo *rri, TupleTableSlot *slot, int tuplen, uint64 lineno)
Definition: copyfrom.c:609
static void CopyMultiInsertInfoCleanup(CopyMultiInsertInfo *miinfo)
Definition: copyfrom.c:571
static bool CopyMultiInsertInfoIsFull(CopyMultiInsertInfo *miinfo)
Definition: copyfrom.c:287
static TupleTableSlot * CopyMultiInsertInfoNextFreeSlot(CopyMultiInsertInfo *miinfo, ResultRelInfo *rri)
Definition: copyfrom.c:590
static bool CopyMultiInsertInfoIsEmpty(CopyMultiInsertInfo *miinfo)
Definition: copyfrom.c:299
void CopyFromErrorCallback(void *arg)
Definition: copyfrom.c:116
CopyInsertMethod
@ CIM_SINGLE
@ CIM_MULTI_CONDITIONAL
@ CIM_MULTI
bool NextCopyFrom(CopyFromState cstate, ExprContext *econtext, Datum *values, bool *nulls)
ErrorContextCallback * error_context_stack
Definition: elog.c:95
ExprState * ExecInitQual(List *qual, PlanState *parent)
Definition: execExpr.c:213
List * ExecInsertIndexTuples(ResultRelInfo *resultRelInfo, TupleTableSlot *slot, EState *estate, bool update, bool noDupErr, bool *specConflict, List *arbiterIndexes, bool onlySummarizing)
Definition: execIndexing.c:293
void ExecOpenIndices(ResultRelInfo *resultRelInfo, bool speculative)
Definition: execIndexing.c:156
bool ExecPartitionCheck(ResultRelInfo *resultRelInfo, TupleTableSlot *slot, EState *estate, bool emitError)
Definition: execMain.c:1807
void ExecCloseResultRelations(EState *estate)
Definition: execMain.c:1532
void ExecCloseRangeTableRelations(EState *estate)
Definition: execMain.c:1592
void ExecConstraints(ResultRelInfo *resultRelInfo, TupleTableSlot *slot, EState *estate)
Definition: execMain.c:1931
void CheckValidResultRel(ResultRelInfo *resultRelInfo, CmdType operation)
Definition: execMain.c:1015
ResultRelInfo * ExecFindPartition(ModifyTableState *mtstate, ResultRelInfo *rootResultRelInfo, PartitionTupleRouting *proute, TupleTableSlot *slot, EState *estate)
PartitionTupleRouting * ExecSetupPartitionTupleRouting(EState *estate, Relation rel)
void ExecCleanupTupleRouting(ModifyTableState *mtstate, PartitionTupleRouting *proute)
void ExecResetTupleTable(List *tupleTable, bool shouldFree)
Definition: execTuples.c:1192
TupleTableSlot * ExecStoreVirtualTuple(TupleTableSlot *slot)
Definition: execTuples.c:1553
void ExecInitRangeTable(EState *estate, List *rangeTable, List *permInfos)
Definition: execUtils.c:759
void ExecInitResultRelation(EState *estate, ResultRelInfo *resultRelInfo, Index rti)
Definition: execUtils.c:845
EState * CreateExecutorState(void)
Definition: execUtils.c:93
TupleConversionMap * ExecGetRootToChildMap(ResultRelInfo *resultRelInfo, EState *estate)
Definition: execUtils.c:1263
void FreeExecutorState(EState *estate)
Definition: execUtils.c:194
#define ResetPerTupleExprContext(estate)
Definition: executor.h:558
#define GetPerTupleExprContext(estate)
Definition: executor.h:549
#define GetPerTupleMemoryContext(estate)
Definition: executor.h:554
static bool ExecQual(ExprState *state, ExprContext *econtext)
Definition: executor.h:412
void ReleaseBulkInsertStatePin(BulkInsertState bistate)
Definition: heapam.c:1798
BulkInsertState GetBulkInsertState(void)
Definition: heapam.c:1770
void FreeBulkInsertState(BulkInsertState bistate)
Definition: heapam.c:1786
void list_free(List *list)
Definition: list.c:1545
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121
void ExecComputeStoredGenerated(ResultRelInfo *resultRelInfo, EState *estate, TupleTableSlot *slot, CmdType cmdtype)
#define makeNode(_type_)
Definition: nodes.h:176
#define castNode(_type_, nodeptr)
Definition: nodes.h:197
bool ThereAreNoReadyPortals(void)
Definition: portalmem.c:1169
#define PROGRESS_COPY_TUPLES_PROCESSED
Definition: progress.h:139
#define PROGRESS_COPY_TUPLES_EXCLUDED
Definition: progress.h:140
bool ThereAreNoPriorRegisteredSnapshots(void)
Definition: snapmgr.c:1623
void InvalidateCatalogSnapshot(void)
Definition: snapmgr.c:457
bool freeze
Definition: copy.h:44
TransitionCaptureState * transition_capture
List * es_tupleTable
Definition: execnodes.h:661
struct ErrorContextCallback * previous
Definition: elog.h:295
void(* callback)(void *arg)
Definition: elog.h:296
TupleTableSlot * ecxt_scantuple
Definition: execnodes.h:249
EndForeignInsert_function EndForeignInsert
Definition: fdwapi.h:239
BeginForeignInsert_function BeginForeignInsert
Definition: fdwapi.h:238
ExecForeignInsert_function ExecForeignInsert
Definition: fdwapi.h:232
ExecForeignBatchInsert_function ExecForeignBatchInsert
Definition: fdwapi.h:233
GetForeignModifyBatchSize_function GetForeignModifyBatchSize
Definition: fdwapi.h:234
CmdType operation
Definition: execnodes.h:1276
ResultRelInfo * resultRelInfo
Definition: execnodes.h:1280
PlanState ps
Definition: execnodes.h:1275
ResultRelInfo * rootResultRelInfo
Definition: execnodes.h:1288
struct TransitionCaptureState * mt_transition_capture
Definition: execnodes.h:1314
Plan * plan
Definition: execnodes.h:1037
EState * state
Definition: execnodes.h:1039
SubTransactionId rd_firstRelfilelocatorSubid
Definition: rel.h:106
TriggerDesc * trigdesc
Definition: rel.h:117
TupleDesc rd_att
Definition: rel.h:112
SubTransactionId rd_newRelfilelocatorSubid
Definition: rel.h:104
SubTransactionId rd_createSubid
Definition: rel.h:103
TupleTableSlot * ri_PartitionTupleSlot
Definition: execnodes.h:575
int ri_NumIndices
Definition: execnodes.h:453
Relation ri_RelationDesc
Definition: execnodes.h:450
struct CopyMultiInsertBuffer * ri_CopyMultiInsertBuffer
Definition: execnodes.h:578
TriggerDesc * ri_TrigDesc
Definition: execnodes.h:480
struct FdwRoutine * ri_FdwRoutine
Definition: execnodes.h:497
int ri_BatchSize
Definition: execnodes.h:508
TupleTableSlot * tcs_original_insert_tuple
Definition: trigger.h:76
bool trig_insert_instead_row
Definition: reltrigger.h:58
bool trig_insert_new_table
Definition: reltrigger.h:75
bool trig_insert_before_row
Definition: reltrigger.h:56
bool has_generated_stored
Definition: tupdesc.h:45
AttrMap * attrMap
Definition: tupconvert.h:28
TupleConstr * constr
Definition: tupdesc.h:85
Oid tts_tableOid
Definition: tuptable.h:131
bool * tts_isnull
Definition: tuptable.h:128
Datum * tts_values
Definition: tuptable.h:126
TupleTableSlot * table_slot_create(Relation relation, List **reglist)
Definition: tableam.c:91
#define TABLE_INSERT_FROZEN
Definition: tableam.h:253
#define TABLE_INSERT_SKIP_FSM
Definition: tableam.h:252
static void table_tuple_insert(Relation rel, TupleTableSlot *slot, CommandId cid, int options, struct BulkInsertStateData *bistate)
Definition: tableam.h:1397
void ExecBSInsertTriggers(EState *estate, ResultRelInfo *relinfo)
Definition: trigger.c:2400
bool ExecBRInsertTriggers(EState *estate, ResultRelInfo *relinfo, TupleTableSlot *slot)
Definition: trigger.c:2464
bool ExecIRInsertTriggers(EState *estate, ResultRelInfo *relinfo, TupleTableSlot *slot)
Definition: trigger.c:2557
void ExecARInsertTriggers(EState *estate, ResultRelInfo *relinfo, TupleTableSlot *slot, List *recheckIndexes, TransitionCaptureState *transition_capture)
Definition: trigger.c:2540
TransitionCaptureState * MakeTransitionCaptureState(TriggerDesc *trigdesc, Oid relid, CmdType cmdType)
Definition: trigger.c:4839
void ExecASInsertTriggers(EState *estate, ResultRelInfo *relinfo, TransitionCaptureState *transition_capture)
Definition: trigger.c:2451
void AfterTriggerEndQuery(EState *estate)
Definition: trigger.c:4995
void AfterTriggerBeginQuery(void)
Definition: trigger.c:4975
TupleTableSlot * execute_attr_map_slot(AttrMap *attrMap, TupleTableSlot *in_slot, TupleTableSlot *out_slot)
Definition: tupconvert.c:192
static TupleTableSlot * ExecClearTuple(TupleTableSlot *slot)
Definition: tuptable.h:433
static TupleTableSlot * ExecCopySlot(TupleTableSlot *dstslot, TupleTableSlot *srcslot)
Definition: tuptable.h:483
static void ExecMaterializeSlot(TupleTableSlot *slot)
Definition: tuptable.h:451
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:780
CommandId GetCurrentCommandId(bool used)
Definition: xact.c:818

References AfterTriggerBeginQuery(), AfterTriggerEndQuery(), ErrorContextCallback::arg, Assert(), TupleConversionMap::attrMap, FdwRoutine::BeginForeignInsert, ErrorContextCallback::callback, castNode, CHECK_FOR_INTERRUPTS, CheckValidResultRel(), CIM_MULTI, CIM_MULTI_CONDITIONAL, CIM_SINGLE, CMD_INSERT, TupleDescData::constr, contain_volatile_functions(), CopyFromErrorCallback(), CopyMultiInsertInfoCleanup(), CopyMultiInsertInfoFlush(), CopyMultiInsertInfoInit(), CopyMultiInsertInfoIsEmpty(), CopyMultiInsertInfoIsFull(), CopyMultiInsertInfoNextFreeSlot(), CopyMultiInsertInfoSetupBuffer(), CopyMultiInsertInfoStore(), CreateExecutorState(), CopyFromStateData::cur_lineno, CurrentMemoryContext, ExprContext::ecxt_scantuple, FdwRoutine::EndForeignInsert, ereport, errcode(), errhint(), errmsg(), ERROR, error_context_stack, EState::es_tupleTable, ExecARInsertTriggers(), ExecASInsertTriggers(), ExecBRInsertTriggers(), ExecBSInsertTriggers(), ExecCleanupTupleRouting(), ExecClearTuple(), ExecCloseRangeTableRelations(), ExecCloseResultRelations(), ExecComputeStoredGenerated(), ExecConstraints(), ExecCopySlot(), ExecFindPartition(), FdwRoutine::ExecForeignBatchInsert, FdwRoutine::ExecForeignInsert, ExecGetRootToChildMap(), ExecInitQual(), ExecInitRangeTable(), ExecInitResultRelation(), ExecInsertIndexTuples(), ExecIRInsertTriggers(), ExecMaterializeSlot(), ExecOpenIndices(), ExecPartitionCheck(), ExecQual(), ExecResetTupleTable(), ExecSetupPartitionTupleRouting(), ExecStoreVirtualTuple(), execute_attr_map_slot(), FreeBulkInsertState(), FreeExecutorState(), CopyFormatOptions::freeze, GetBulkInsertState(), GetCurrentCommandId(), GetCurrentSubTransactionId(), FdwRoutine::GetForeignModifyBatchSize, GetPerTupleExprContext, GetPerTupleMemoryContext, TupleConstr::has_generated_stored, InvalidateCatalogSnapshot(), InvalidSubTransactionId, StringInfoData::len, CopyFromStateData::line_buf, list_free(), list_length(), makeNode, MakeTransitionCaptureState(), MemoryContextSwitchTo(), ModifyTableState::mt_nrels, ModifyTableState::mt_transition_capture, NextCopyFrom(), NIL, ModifyTableState::operation, CopyFromStateData::opts, pgstat_progress_update_param(), PlanState::plan, ErrorContextCallback::previous, PROGRESS_COPY_TUPLES_EXCLUDED, PROGRESS_COPY_TUPLES_PROCESSED, ModifyTableState::ps, CopyFromStateData::qualexpr, CopyFromStateData::range_table, RelationData::rd_att, RelationData::rd_createSubid, RelationData::rd_firstRelfilelocatorSubid, RelationData::rd_newRelfilelocatorSubid, RelationData::rd_rel, CopyFromStateData::rel, RelationGetRelationName, RelationGetRelid, ReleaseBulkInsertStatePin(), ResetPerTupleExprContext, ModifyTableState::resultRelInfo, ResultRelInfo::ri_BatchSize, ResultRelInfo::ri_CopyMultiInsertBuffer, ResultRelInfo::ri_FdwRoutine, ResultRelInfo::ri_NumIndices, ResultRelInfo::ri_PartitionTupleSlot, ResultRelInfo::ri_RelationDesc, ResultRelInfo::ri_TrigDesc, ModifyTableState::rootResultRelInfo, CopyFromStateData::rteperminfos, PlanState::state, TABLE_INSERT_FROZEN, TABLE_INSERT_SKIP_FSM, table_slot_create(), table_tuple_insert(), TransitionCaptureState::tcs_original_insert_tuple, ThereAreNoPriorRegisteredSnapshots(), ThereAreNoReadyPortals(), CopyFromStateData::transition_capture, TriggerDesc::trig_insert_before_row, TriggerDesc::trig_insert_instead_row, TriggerDesc::trig_insert_new_table, RelationData::trigdesc, TupleTableSlot::tts_isnull, TupleTableSlot::tts_tableOid, TupleTableSlot::tts_values, CopyFromStateData::volatile_defexprs, and CopyFromStateData::whereClause.

Referenced by copy_table(), and DoCopy().

◆ CopyFromErrorCallback()

void CopyFromErrorCallback ( void *  arg)

Definition at line 116 of file copyfrom.c.

117 {
118  CopyFromState cstate = (CopyFromState) arg;
119 
120  if (cstate->relname_only)
121  {
122  errcontext("COPY %s",
123  cstate->cur_relname);
124  return;
125  }
126  if (cstate->opts.binary)
127  {
128  /* can't usefully display the data */
129  if (cstate->cur_attname)
130  errcontext("COPY %s, line %llu, column %s",
131  cstate->cur_relname,
132  (unsigned long long) cstate->cur_lineno,
133  cstate->cur_attname);
134  else
135  errcontext("COPY %s, line %llu",
136  cstate->cur_relname,
137  (unsigned long long) cstate->cur_lineno);
138  }
139  else
140  {
141  if (cstate->cur_attname && cstate->cur_attval)
142  {
143  /* error is relevant to a particular column */
144  char *attval;
145 
146  attval = limit_printout_length(cstate->cur_attval);
147  errcontext("COPY %s, line %llu, column %s: \"%s\"",
148  cstate->cur_relname,
149  (unsigned long long) cstate->cur_lineno,
150  cstate->cur_attname,
151  attval);
152  pfree(attval);
153  }
154  else if (cstate->cur_attname)
155  {
156  /* error is relevant to a particular column, value is NULL */
157  errcontext("COPY %s, line %llu, column %s: null input",
158  cstate->cur_relname,
159  (unsigned long long) cstate->cur_lineno,
160  cstate->cur_attname);
161  }
162  else
163  {
164  /*
165  * Error is relevant to a particular line.
166  *
167  * If line_buf still contains the correct line, print it.
168  */
169  if (cstate->line_buf_valid)
170  {
171  char *lineval;
172 
173  lineval = limit_printout_length(cstate->line_buf.data);
174  errcontext("COPY %s, line %llu: \"%s\"",
175  cstate->cur_relname,
176  (unsigned long long) cstate->cur_lineno, lineval);
177  pfree(lineval);
178  }
179  else
180  {
181  errcontext("COPY %s, line %llu",
182  cstate->cur_relname,
183  (unsigned long long) cstate->cur_lineno);
184  }
185  }
186  }
187 }
static char * limit_printout_length(const char *str)
Definition: copyfrom.c:195
#define errcontext
Definition: elog.h:196
struct CopyFromStateData * CopyFromState
Definition: copy.h:67
void pfree(void *pointer)
Definition: mcxt.c:1456
void * arg

References arg, CopyFormatOptions::binary, CopyFromStateData::cur_attname, CopyFromStateData::cur_attval, CopyFromStateData::cur_lineno, CopyFromStateData::cur_relname, StringInfoData::data, errcontext, limit_printout_length(), CopyFromStateData::line_buf, CopyFromStateData::line_buf_valid, CopyFromStateData::opts, pfree(), and CopyFromStateData::relname_only.

Referenced by CopyFrom(), file_acquire_sample_rows(), and fileIterateForeignScan().

◆ CopyGetAttnums()

List* CopyGetAttnums ( TupleDesc  tupDesc,
Relation  rel,
List attnamelist 
)

Definition at line 782 of file copy.c.

783 {
784  List *attnums = NIL;
785 
786  if (attnamelist == NIL)
787  {
788  /* Generate default column list */
789  int attr_count = tupDesc->natts;
790  int i;
791 
792  for (i = 0; i < attr_count; i++)
793  {
794  if (TupleDescAttr(tupDesc, i)->attisdropped)
795  continue;
796  if (TupleDescAttr(tupDesc, i)->attgenerated)
797  continue;
798  attnums = lappend_int(attnums, i + 1);
799  }
800  }
801  else
802  {
803  /* Validate the user-supplied list and extract attnums */
804  ListCell *l;
805 
806  foreach(l, attnamelist)
807  {
808  char *name = strVal(lfirst(l));
809  int attnum;
810  int i;
811 
812  /* Lookup column name */
814  for (i = 0; i < tupDesc->natts; i++)
815  {
816  Form_pg_attribute att = TupleDescAttr(tupDesc, i);
817 
818  if (att->attisdropped)
819  continue;
820  if (namestrcmp(&(att->attname), name) == 0)
821  {
822  if (att->attgenerated)
823  ereport(ERROR,
824  (errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
825  errmsg("column \"%s\" is a generated column",
826  name),
827  errdetail("Generated columns cannot be used in COPY.")));
828  attnum = att->attnum;
829  break;
830  }
831  }
832  if (attnum == InvalidAttrNumber)
833  {
834  if (rel != NULL)
835  ereport(ERROR,
836  (errcode(ERRCODE_UNDEFINED_COLUMN),
837  errmsg("column \"%s\" of relation \"%s\" does not exist",
838  name, RelationGetRelationName(rel))));
839  else
840  ereport(ERROR,
841  (errcode(ERRCODE_UNDEFINED_COLUMN),
842  errmsg("column \"%s\" does not exist",
843  name)));
844  }
845  /* Check for duplicates */
846  if (list_member_int(attnums, attnum))
847  ereport(ERROR,
848  (errcode(ERRCODE_DUPLICATE_COLUMN),
849  errmsg("column \"%s\" specified more than once",
850  name)));
851  attnums = lappend_int(attnums, attnum);
852  }
853  }
854 
855  return attnums;
856 }
#define InvalidAttrNumber
Definition: attnum.h:23
int errdetail(const char *fmt,...)
Definition: elog.c:1202
const char * name
Definition: encode.c:571
List * lappend_int(List *list, int datum)
Definition: list.c:356
int namestrcmp(Name name, const char *str)
Definition: name.c:247
#define lfirst(lc)
Definition: pg_list.h:172
#define strVal(v)
Definition: value.h:82

References attnum, ereport, errcode(), errdetail(), errmsg(), ERROR, i, InvalidAttrNumber, lappend_int(), lfirst, list_member_int(), name, namestrcmp(), TupleDescData::natts, NIL, RelationGetRelationName, strVal, and TupleDescAttr.

Referenced by BeginCopyFrom(), BeginCopyTo(), and DoCopy().

◆ CreateCopyDestReceiver()

DestReceiver* CreateCopyDestReceiver ( void  )

Definition at line 1275 of file copyto.c.

1276 {
1277  DR_copy *self = (DR_copy *) palloc(sizeof(DR_copy));
1278 
1279  self->pub.receiveSlot = copy_dest_receive;
1280  self->pub.rStartup = copy_dest_startup;
1281  self->pub.rShutdown = copy_dest_shutdown;
1282  self->pub.rDestroy = copy_dest_destroy;
1283  self->pub.mydest = DestCopyOut;
1284 
1285  self->cstate = NULL; /* will be set later */
1286  self->processed = 0;
1287 
1288  return (DestReceiver *) self;
1289 }
static bool copy_dest_receive(TupleTableSlot *slot, DestReceiver *self)
Definition: copyto.c:1238
static void copy_dest_destroy(DestReceiver *self)
Definition: copyto.c:1266
static void copy_dest_shutdown(DestReceiver *self)
Definition: copyto.c:1257
static void copy_dest_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
Definition: copyto.c:1229

References copy_dest_destroy(), copy_dest_receive(), copy_dest_shutdown(), copy_dest_startup(), DestCopyOut, and palloc().

Referenced by CreateDestReceiver().

◆ DoCopy()

void DoCopy ( ParseState pstate,
const CopyStmt stmt,
int  stmt_location,
int  stmt_len,
uint64 *  processed 
)

Definition at line 64 of file copy.c.

67 {
68  bool is_from = stmt->is_from;
69  bool pipe = (stmt->filename == NULL);
70  Relation rel;
71  Oid relid;
72  RawStmt *query = NULL;
73  Node *whereClause = NULL;
74 
75  /*
76  * Disallow COPY to/from file or program except to users with the
77  * appropriate role.
78  */
79  if (!pipe)
80  {
81  if (stmt->is_program)
82  {
83  if (!has_privs_of_role(GetUserId(), ROLE_PG_EXECUTE_SERVER_PROGRAM))
84  ereport(ERROR,
85  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
86  errmsg("permission denied to COPY to or from an external program"),
87  errdetail("Only roles with privileges of the \"%s\" role may COPY to or from an external program.",
88  "pg_execute_server_program"),
89  errhint("Anyone can COPY to stdout or from stdin. "
90  "psql's \\copy command also works for anyone.")));
91  }
92  else
93  {
94  if (is_from && !has_privs_of_role(GetUserId(), ROLE_PG_READ_SERVER_FILES))
95  ereport(ERROR,
96  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
97  errmsg("permission denied to COPY from a file"),
98  errdetail("Only roles with privileges of the \"%s\" role may COPY from a file.",
99  "pg_read_server_files"),
100  errhint("Anyone can COPY to stdout or from stdin. "
101  "psql's \\copy command also works for anyone.")));
102 
103  if (!is_from && !has_privs_of_role(GetUserId(), ROLE_PG_WRITE_SERVER_FILES))
104  ereport(ERROR,
105  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
106  errmsg("permission denied to COPY to a file"),
107  errdetail("Only roles with privileges of the \"%s\" role may COPY to a file.",
108  "pg_write_server_files"),
109  errhint("Anyone can COPY to stdout or from stdin. "
110  "psql's \\copy command also works for anyone.")));
111  }
112  }
113 
114  if (stmt->relation)
115  {
116  LOCKMODE lockmode = is_from ? RowExclusiveLock : AccessShareLock;
117  ParseNamespaceItem *nsitem;
118  RTEPermissionInfo *perminfo;
119  TupleDesc tupDesc;
120  List *attnums;
121  ListCell *cur;
122 
123  Assert(!stmt->query);
124 
125  /* Open and lock the relation, using the appropriate lock type. */
126  rel = table_openrv(stmt->relation, lockmode);
127 
128  relid = RelationGetRelid(rel);
129 
130  nsitem = addRangeTableEntryForRelation(pstate, rel, lockmode,
131  NULL, false, false);
132 
133  perminfo = nsitem->p_perminfo;
134  perminfo->requiredPerms = (is_from ? ACL_INSERT : ACL_SELECT);
135 
136  if (stmt->whereClause)
137  {
138  /* add nsitem to query namespace */
139  addNSItemToQuery(pstate, nsitem, false, true, true);
140 
141  /* Transform the raw expression tree */
142  whereClause = transformExpr(pstate, stmt->whereClause, EXPR_KIND_COPY_WHERE);
143 
144  /* Make sure it yields a boolean result. */
145  whereClause = coerce_to_boolean(pstate, whereClause, "WHERE");
146 
147  /* we have to fix its collations too */
148  assign_expr_collations(pstate, whereClause);
149 
150  whereClause = eval_const_expressions(NULL, whereClause);
151 
152  whereClause = (Node *) canonicalize_qual((Expr *) whereClause, false);
153  whereClause = (Node *) make_ands_implicit((Expr *) whereClause);
154  }
155 
156  tupDesc = RelationGetDescr(rel);
157  attnums = CopyGetAttnums(tupDesc, rel, stmt->attlist);
158  foreach(cur, attnums)
159  {
160  int attno;
161  Bitmapset **bms;
162 
164  bms = is_from ? &perminfo->insertedCols : &perminfo->selectedCols;
165 
166  *bms = bms_add_member(*bms, attno);
167  }
168  ExecCheckPermissions(pstate->p_rtable, list_make1(perminfo), true);
169 
170  /*
171  * Permission check for row security policies.
172  *
173  * check_enable_rls will ereport(ERROR) if the user has requested
174  * something invalid and will otherwise indicate if we should enable
175  * RLS (returns RLS_ENABLED) or not for this COPY statement.
176  *
177  * If the relation has a row security policy and we are to apply it
178  * then perform a "query" copy and allow the normal query processing
179  * to handle the policies.
180  *
181  * If RLS is not enabled for this, then just fall through to the
182  * normal non-filtering relation handling.
183  */
184  if (check_enable_rls(relid, InvalidOid, false) == RLS_ENABLED)
185  {
187  ColumnRef *cr;
188  ResTarget *target;
189  RangeVar *from;
190  List *targetList = NIL;
191 
192  if (is_from)
193  ereport(ERROR,
194  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
195  errmsg("COPY FROM not supported with row-level security"),
196  errhint("Use INSERT statements instead.")));
197 
198  /*
199  * Build target list
200  *
201  * If no columns are specified in the attribute list of the COPY
202  * command, then the target list is 'all' columns. Therefore, '*'
203  * should be used as the target list for the resulting SELECT
204  * statement.
205  *
206  * In the case that columns are specified in the attribute list,
207  * create a ColumnRef and ResTarget for each column and add them
208  * to the target list for the resulting SELECT statement.
209  */
210  if (!stmt->attlist)
211  {
212  cr = makeNode(ColumnRef);
214  cr->location = -1;
215 
216  target = makeNode(ResTarget);
217  target->name = NULL;
218  target->indirection = NIL;
219  target->val = (Node *) cr;
220  target->location = -1;
221 
222  targetList = list_make1(target);
223  }
224  else
225  {
226  ListCell *lc;
227 
228  foreach(lc, stmt->attlist)
229  {
230  /*
231  * Build the ColumnRef for each column. The ColumnRef
232  * 'fields' property is a String node that corresponds to
233  * the column name respectively.
234  */
235  cr = makeNode(ColumnRef);
236  cr->fields = list_make1(lfirst(lc));
237  cr->location = -1;
238 
239  /* Build the ResTarget and add the ColumnRef to it. */
240  target = makeNode(ResTarget);
241  target->name = NULL;
242  target->indirection = NIL;
243  target->val = (Node *) cr;
244  target->location = -1;
245 
246  /* Add each column to the SELECT statement's target list */
247  targetList = lappend(targetList, target);
248  }
249  }
250 
251  /*
252  * Build RangeVar for from clause, fully qualified based on the
253  * relation which we have opened and locked. Use "ONLY" so that
254  * COPY retrieves rows from only the target table not any
255  * inheritance children, the same as when RLS doesn't apply.
256  */
259  -1);
260  from->inh = false; /* apply ONLY */
261 
262  /* Build query */
264  select->targetList = targetList;
265  select->fromClause = list_make1(from);
266 
267  query = makeNode(RawStmt);
268  query->stmt = (Node *) select;
269  query->stmt_location = stmt_location;
270  query->stmt_len = stmt_len;
271 
272  /*
273  * Close the relation for now, but keep the lock on it to prevent
274  * changes between now and when we start the query-based COPY.
275  *
276  * We'll reopen it later as part of the query-based COPY.
277  */
278  table_close(rel, NoLock);
279  rel = NULL;
280  }
281  }
282  else
283  {
284  Assert(stmt->query);
285 
286  /* MERGE is allowed by parser, but unimplemented. Reject for now */
287  if (IsA(stmt->query, MergeStmt))
288  ereport(ERROR,
289  errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
290  errmsg("MERGE not supported in COPY"));
291 
292  query = makeNode(RawStmt);
293  query->stmt = stmt->query;
294  query->stmt_location = stmt_location;
295  query->stmt_len = stmt_len;
296 
297  relid = InvalidOid;
298  rel = NULL;
299  }
300 
301  if (is_from)
302  {
303  CopyFromState cstate;
304 
305  Assert(rel);
306 
307  /* check read-only transaction and parallel mode */
308  if (XactReadOnly && !rel->rd_islocaltemp)
309  PreventCommandIfReadOnly("COPY FROM");
310 
311  cstate = BeginCopyFrom(pstate, rel, whereClause,
312  stmt->filename, stmt->is_program,
313  NULL, stmt->attlist, stmt->options);
314  *processed = CopyFrom(cstate); /* copy from file to database */
315  EndCopyFrom(cstate);
316  }
317  else
318  {
319  CopyToState cstate;
320 
321  cstate = BeginCopyTo(pstate, rel, query, relid,
322  stmt->filename, stmt->is_program,
323  NULL, stmt->attlist, stmt->options);
324  *processed = DoCopyTo(cstate); /* copy from database to file */
325  EndCopyTo(cstate);
326  }
327 
328  if (rel != NULL)
329  table_close(rel, NoLock);
330 }
bool has_privs_of_role(Oid member, Oid role)
Definition: acl.c:4969
Bitmapset * bms_add_member(Bitmapset *a, int x)
Definition: bitmapset.c:755
Node * eval_const_expressions(PlannerInfo *root, Node *node)
Definition: clauses.c:2171
CopyFromState BeginCopyFrom(ParseState *pstate, Relation rel, Node *whereClause, const char *filename, bool is_program, copy_data_source_cb data_source_cb, List *attnamelist, List *options)
Definition: copyfrom.c:1334
uint64 CopyFrom(CopyFromState cstate)
Definition: copyfrom.c:632
void EndCopyFrom(CopyFromState cstate)
Definition: copyfrom.c:1717
uint64 DoCopyTo(CopyToState cstate)
Definition: copyto.c:749
CopyToState BeginCopyTo(ParseState *pstate, Relation rel, RawStmt *raw_query, Oid queryRelId, const char *filename, bool is_program, copy_data_dest_cb data_dest_cb, List *attnamelist, List *options)
Definition: copyto.c:357
void EndCopyTo(CopyToState cstate)
Definition: copyto.c:728
bool ExecCheckPermissions(List *rangeTable, List *rteperminfos, bool ereport_on_violation)
Definition: execMain.c:581
#define stmt
Definition: indent_codes.h:59
List * lappend(List *list, void *datum)
Definition: list.c:338
int LOCKMODE
Definition: lockdefs.h:26
#define NoLock
Definition: lockdefs.h:34
#define AccessShareLock
Definition: lockdefs.h:36
#define RowExclusiveLock
Definition: lockdefs.h:38
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3324
List * make_ands_implicit(Expr *clause)
Definition: makefuncs.c:722
RangeVar * makeRangeVar(char *schemaname, char *relname, int location)
Definition: makefuncs.c:425
Oid GetUserId(void)
Definition: miscinit.c:510
Node * coerce_to_boolean(ParseState *pstate, Node *node, const char *constructName)
void assign_expr_collations(ParseState *pstate, Node *expr)
Node * transformExpr(ParseState *pstate, Node *expr, ParseExprKind exprKind)
Definition: parse_expr.c:106
@ EXPR_KIND_COPY_WHERE
Definition: parse_node.h:81
ParseNamespaceItem * addRangeTableEntryForRelation(ParseState *pstate, Relation rel, int lockmode, Alias *alias, bool inh, bool inFromCl)
void addNSItemToQuery(ParseState *pstate, ParseNamespaceItem *nsitem, bool addToJoinList, bool addToRelNameSpace, bool addToVarNameSpace)
#define ACL_INSERT
Definition: parsenodes.h:83
#define ACL_SELECT
Definition: parsenodes.h:84
#define list_make1(x1)
Definition: pg_list.h:212
Expr * canonicalize_qual(Expr *qual, bool is_check)
Definition: prepqual.c:294
#define RelationGetNamespace(relation)
Definition: rel.h:545
int check_enable_rls(Oid relid, Oid checkAsUser, bool noError)
Definition: rls.c:52
@ RLS_ENABLED
Definition: rls.h:45
int location
Definition: parsenodes.h:293
List * fields
Definition: parsenodes.h:292
RTEPermissionInfo * p_perminfo
Definition: parse_node.h:288
Bitmapset * selectedCols
Definition: parsenodes.h:1248
AclMode requiredPerms
Definition: parsenodes.h:1246
Bitmapset * insertedCols
Definition: parsenodes.h:1249
bool inh
Definition: primnodes.h:77
int stmt_len
Definition: parsenodes.h:1849
Node * stmt
Definition: parsenodes.h:1847
int stmt_location
Definition: parsenodes.h:1848
bool rd_islocaltemp
Definition: rel.h:61
int location
Definition: parsenodes.h:518
Node * val
Definition: parsenodes.h:517
List * indirection
Definition: parsenodes.h:516
char * name
Definition: parsenodes.h:515
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
Relation table_openrv(const RangeVar *relation, LOCKMODE lockmode)
Definition: table.c:83
void PreventCommandIfReadOnly(const char *cmdname)
Definition: utility.c:411
#define select(n, r, w, e, timeout)
Definition: win32_port.h:505
bool XactReadOnly
Definition: xact.c:82

References AccessShareLock, ACL_INSERT, ACL_SELECT, addNSItemToQuery(), addRangeTableEntryForRelation(), Assert(), assign_expr_collations(), BeginCopyFrom(), BeginCopyTo(), bms_add_member(), canonicalize_qual(), check_enable_rls(), coerce_to_boolean(), CopyFrom(), CopyGetAttnums(), cur, DoCopyTo(), EndCopyFrom(), EndCopyTo(), ereport, errcode(), errdetail(), errhint(), errmsg(), ERROR, eval_const_expressions(), ExecCheckPermissions(), EXPR_KIND_COPY_WHERE, ColumnRef::fields, FirstLowInvalidHeapAttributeNumber, get_namespace_name(), GetUserId(), has_privs_of_role(), ResTarget::indirection, RangeVar::inh, RTEPermissionInfo::insertedCols, InvalidOid, IsA, lappend(), lfirst, lfirst_int, list_make1, ColumnRef::location, ResTarget::location, make_ands_implicit(), makeNode, makeRangeVar(), ResTarget::name, NIL, NoLock, ParseNamespaceItem::p_perminfo, ParseState::p_rtable, PreventCommandIfReadOnly(), pstrdup(), RelationData::rd_islocaltemp, RelationGetDescr, RelationGetNamespace, RelationGetRelationName, RelationGetRelid, RTEPermissionInfo::requiredPerms, RLS_ENABLED, RowExclusiveLock, select, RTEPermissionInfo::selectedCols, RawStmt::stmt, stmt, RawStmt::stmt_len, RawStmt::stmt_location, table_close(), table_openrv(), transformExpr(), ResTarget::val, and XactReadOnly.

Referenced by standard_ProcessUtility().

◆ DoCopyTo()

uint64 DoCopyTo ( CopyToState  cstate)

Definition at line 749 of file copyto.c.

750 {
751  bool pipe = (cstate->filename == NULL && cstate->data_dest_cb == NULL);
752  bool fe_copy = (pipe && whereToSendOutput == DestRemote);
753  TupleDesc tupDesc;
754  int num_phys_attrs;
755  ListCell *cur;
756  uint64 processed;
757 
758  if (fe_copy)
759  SendCopyBegin(cstate);
760 
761  if (cstate->rel)
762  tupDesc = RelationGetDescr(cstate->rel);
763  else
764  tupDesc = cstate->queryDesc->tupDesc;
765  num_phys_attrs = tupDesc->natts;
766  cstate->opts.null_print_client = cstate->opts.null_print; /* default */
767 
768  /* We use fe_msgbuf as a per-row buffer regardless of copy_dest */
769  cstate->fe_msgbuf = makeStringInfo();
770 
771  /* Get info about the columns we need to process. */
772  cstate->out_functions = (FmgrInfo *) palloc(num_phys_attrs * sizeof(FmgrInfo));
773  foreach(cur, cstate->attnumlist)
774  {
775  int attnum = lfirst_int(cur);
776  Oid out_func_oid;
777  bool isvarlena;
778  Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
779 
780  if (cstate->opts.binary)
781  getTypeBinaryOutputInfo(attr->atttypid,
782  &out_func_oid,
783  &isvarlena);
784  else
785  getTypeOutputInfo(attr->atttypid,
786  &out_func_oid,
787  &isvarlena);
788  fmgr_info(out_func_oid, &cstate->out_functions[attnum - 1]);
789  }
790 
791  /*
792  * Create a temporary memory context that we can reset once per row to
793  * recover palloc'd memory. This avoids any problems with leaks inside
794  * datatype output routines, and should be faster than retail pfree's
795  * anyway. (We don't need a whole econtext as CopyFrom does.)
796  */
798  "COPY TO",
800 
801  if (cstate->opts.binary)
802  {
803  /* Generate header for a binary copy */
804  int32 tmp;
805 
806  /* Signature */
807  CopySendData(cstate, BinarySignature, 11);
808  /* Flags field */
809  tmp = 0;
810  CopySendInt32(cstate, tmp);
811  /* No header extension */
812  tmp = 0;
813  CopySendInt32(cstate, tmp);
814  }
815  else
816  {
817  /*
818  * For non-binary copy, we need to convert null_print to file
819  * encoding, because it will be sent directly with CopySendString.
820  */
821  if (cstate->need_transcoding)
823  cstate->opts.null_print_len,
824  cstate->file_encoding);
825 
826  /* if a header has been requested send the line */
827  if (cstate->opts.header_line)
828  {
829  bool hdr_delim = false;
830 
831  foreach(cur, cstate->attnumlist)
832  {
833  int attnum = lfirst_int(cur);
834  char *colname;
835 
836  if (hdr_delim)
837  CopySendChar(cstate, cstate->opts.delim[0]);
838  hdr_delim = true;
839 
840  colname = NameStr(TupleDescAttr(tupDesc, attnum - 1)->attname);
841 
842  if (cstate->opts.csv_mode)
843  CopyAttributeOutCSV(cstate, colname, false,
844  list_length(cstate->attnumlist) == 1);
845  else
846  CopyAttributeOutText(cstate, colname);
847  }
848 
849  CopySendEndOfRow(cstate);
850  }
851  }
852 
853  if (cstate->rel)
854  {
855  TupleTableSlot *slot;
856  TableScanDesc scandesc;
857 
858  scandesc = table_beginscan(cstate->rel, GetActiveSnapshot(), 0, NULL);
859  slot = table_slot_create(cstate->rel, NULL);
860 
861  processed = 0;
862  while (table_scan_getnextslot(scandesc, ForwardScanDirection, slot))
863  {
865 
866  /* Deconstruct the tuple ... */
867  slot_getallattrs(slot);
868 
869  /* Format and send the data */
870  CopyOneRowTo(cstate, slot);
871 
872  /*
873  * Increment the number of processed tuples, and report the
874  * progress.
875  */
877  ++processed);
878  }
879 
881  table_endscan(scandesc);
882  }
883  else
884  {
885  /* run the plan --- the dest receiver will send tuples */
886  ExecutorRun(cstate->queryDesc, ForwardScanDirection, 0, true);
887  processed = ((DR_copy *) cstate->queryDesc->dest)->processed;
888  }
889 
890  if (cstate->opts.binary)
891  {
892  /* Generate trailer for a binary copy */
893  CopySendInt16(cstate, -1);
894  /* Need to flush out the trailer */
895  CopySendEndOfRow(cstate);
896  }
897 
899 
900  if (fe_copy)
901  SendCopyEnd(cstate);
902 
903  return processed;
904 }
signed int int32
Definition: c.h:478
static void CopySendInt32(CopyToState cstate, int32 val)
Definition: copyto.c:272
static void CopyAttributeOutText(CopyToState cstate, const char *string)
Definition: copyto.c:991
static void CopySendInt16(CopyToState cstate, int16 val)
Definition: copyto.c:284
static void CopySendData(CopyToState cstate, const void *databuf, int datasize)
Definition: copyto.c:176
static void CopySendChar(CopyToState cstate, char c)
Definition: copyto.c:188
static void CopyAttributeOutCSV(CopyToState cstate, const char *string, bool use_quote, bool single_attr)
Definition: copyto.c:1144
static void SendCopyBegin(CopyToState cstate)
Definition: copyto.c:140
static void SendCopyEnd(CopyToState cstate)
Definition: copyto.c:157
static void CopySendEndOfRow(CopyToState cstate)
Definition: copyto.c:194
static void CopyOneRowTo(CopyToState cstate, TupleTableSlot *slot)
Definition: copyto.c:910
static const char BinarySignature[11]
Definition: copyto.c:113
void ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once)
Definition: execMain.c:302
void ExecDropSingleTupleTableSlot(TupleTableSlot *slot)
Definition: execTuples.c:1255
void getTypeBinaryOutputInfo(Oid type, Oid *typSend, bool *typIsVarlena)
Definition: lsyscache.c:2931
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2865
char * pg_server_to_any(const char *s, int len, int encoding)
Definition: mbutils.c:750
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:403
NameData attname
Definition: pg_attribute.h:41
@ ForwardScanDirection
Definition: sdir.h:28
StringInfo makeStringInfo(void)
Definition: stringinfo.c:41
int null_print_len
Definition: copy.h:48
CopyHeaderChoice header_line
Definition: copy.h:46
char * null_print
Definition: copy.h:47
char * delim
Definition: copy.h:52
char * null_print_client
Definition: copy.h:49
bool csv_mode
Definition: copy.h:45
FmgrInfo * out_functions
Definition: copyto.c:99
MemoryContext rowcontext
Definition: copyto.c:100
StringInfo fe_msgbuf
Definition: copyto.c:77
DestReceiver * dest
Definition: execdesc.h:41
static TableScanDesc table_beginscan(Relation rel, Snapshot snapshot, int nkeys, struct ScanKeyData *key)
Definition: tableam.h:901
static void table_endscan(TableScanDesc scan)
Definition: tableam.h:1009
static bool table_scan_getnextslot(TableScanDesc sscan, ScanDirection direction, TupleTableSlot *slot)
Definition: tableam.h:1050
static void slot_getallattrs(TupleTableSlot *slot)
Definition: tuptable.h:362

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, attname, attnum, CopyToStateData::attnumlist, CopyFormatOptions::binary, BinarySignature, CHECK_FOR_INTERRUPTS, CopyAttributeOutCSV(), CopyAttributeOutText(), CopyOneRowTo(), CopySendChar(), CopySendData(), CopySendEndOfRow(), CopySendInt16(), CopySendInt32(), CopyFormatOptions::csv_mode, cur, CurrentMemoryContext, CopyToStateData::data_dest_cb, CopyFormatOptions::delim, QueryDesc::dest, DestRemote, ExecDropSingleTupleTableSlot(), ExecutorRun(), CopyToStateData::fe_msgbuf, CopyToStateData::file_encoding, CopyToStateData::filename, fmgr_info(), ForwardScanDirection, GetActiveSnapshot(), getTypeBinaryOutputInfo(), getTypeOutputInfo(), CopyFormatOptions::header_line, lfirst_int, list_length(), makeStringInfo(), MemoryContextDelete(), NameStr, TupleDescData::natts, CopyToStateData::need_transcoding, CopyFormatOptions::null_print, CopyFormatOptions::null_print_client, CopyFormatOptions::null_print_len, CopyToStateData::opts, CopyToStateData::out_functions, palloc(), pg_server_to_any(), pgstat_progress_update_param(), PROGRESS_COPY_TUPLES_PROCESSED, CopyToStateData::queryDesc, CopyToStateData::rel, RelationGetDescr, CopyToStateData::rowcontext, SendCopyBegin(), SendCopyEnd(), slot_getallattrs(), table_beginscan(), table_endscan(), table_scan_getnextslot(), table_slot_create(), QueryDesc::tupDesc, TupleDescAttr, and whereToSendOutput.

Referenced by DoCopy(), and test_copy_to_callback().

◆ EndCopyFrom()

void EndCopyFrom ( CopyFromState  cstate)

Definition at line 1717 of file copyfrom.c.

1718 {
1719  /* No COPY FROM related resources except memory. */
1720  if (cstate->is_program)
1721  {
1722  ClosePipeFromProgram(cstate);
1723  }
1724  else
1725  {
1726  if (cstate->filename != NULL && FreeFile(cstate->copy_file))
1727  ereport(ERROR,
1729  errmsg("could not close file \"%s\": %m",
1730  cstate->filename)));
1731  }
1732 
1734 
1736  pfree(cstate);
1737 }
void pgstat_progress_end_command(void)
static void ClosePipeFromProgram(CopyFromState cstate)
Definition: copyfrom.c:1743
int FreeFile(FILE *file)
Definition: fd.c:2678

References ClosePipeFromProgram(), CopyFromStateData::copy_file, CopyFromStateData::copycontext, ereport, errcode_for_file_access(), errmsg(), ERROR, CopyFromStateData::filename, FreeFile(), CopyFromStateData::is_program, MemoryContextDelete(), pfree(), and pgstat_progress_end_command().

Referenced by DoCopy(), file_acquire_sample_rows(), fileEndForeignScan(), and fileReScanForeignScan().

◆ EndCopyTo()

void EndCopyTo ( CopyToState  cstate)

Definition at line 728 of file copyto.c.

729 {
730  if (cstate->queryDesc != NULL)
731  {
732  /* Close down the query and free resources. */
733  ExecutorFinish(cstate->queryDesc);
734  ExecutorEnd(cstate->queryDesc);
735  FreeQueryDesc(cstate->queryDesc);
737  }
738 
739  /* Clean up storage */
740  EndCopy(cstate);
741 }
static void EndCopy(CopyToState cstate)
Definition: copyto.c:321
void ExecutorEnd(QueryDesc *queryDesc)
Definition: execMain.c:469
void ExecutorFinish(QueryDesc *queryDesc)
Definition: execMain.c:409
void FreeQueryDesc(QueryDesc *qdesc)
Definition: pquery.c:105
void PopActiveSnapshot(void)
Definition: snapmgr.c:778

References EndCopy(), ExecutorEnd(), ExecutorFinish(), FreeQueryDesc(), PopActiveSnapshot(), and CopyToStateData::queryDesc.

Referenced by DoCopy(), and test_copy_to_callback().

◆ NextCopyFrom()

bool NextCopyFrom ( CopyFromState  cstate,
ExprContext econtext,
Datum values,
bool nulls 
)

Definition at line 854 of file copyfromparse.c.

856 {
857  TupleDesc tupDesc;
858  AttrNumber num_phys_attrs,
859  attr_count,
860  num_defaults = cstate->num_defaults;
861  FmgrInfo *in_functions = cstate->in_functions;
862  Oid *typioparams = cstate->typioparams;
863  int i;
864  int *defmap = cstate->defmap;
865  ExprState **defexprs = cstate->defexprs;
866 
867  tupDesc = RelationGetDescr(cstate->rel);
868  num_phys_attrs = tupDesc->natts;
869  attr_count = list_length(cstate->attnumlist);
870 
871  /* Initialize all values for row to NULL */
872  MemSet(values, 0, num_phys_attrs * sizeof(Datum));
873  MemSet(nulls, true, num_phys_attrs * sizeof(bool));
874  cstate->defaults = (bool *) palloc0(num_phys_attrs * sizeof(bool));
875 
876  if (!cstate->opts.binary)
877  {
878  char **field_strings;
879  ListCell *cur;
880  int fldct;
881  int fieldno;
882  char *string;
883 
884  /* read raw fields in the next line */
885  if (!NextCopyFromRawFields(cstate, &field_strings, &fldct))
886  return false;
887 
888  /* check for overflowing fields */
889  if (attr_count > 0 && fldct > attr_count)
890  ereport(ERROR,
891  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
892  errmsg("extra data after last expected column")));
893 
894  fieldno = 0;
895 
896  /* Loop to read the user attributes on the line. */
897  foreach(cur, cstate->attnumlist)
898  {
899  int attnum = lfirst_int(cur);
900  int m = attnum - 1;
901  Form_pg_attribute att = TupleDescAttr(tupDesc, m);
902 
903  if (fieldno >= fldct)
904  ereport(ERROR,
905  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
906  errmsg("missing data for column \"%s\"",
907  NameStr(att->attname))));
908  string = field_strings[fieldno++];
909 
910  if (cstate->convert_select_flags &&
911  !cstate->convert_select_flags[m])
912  {
913  /* ignore input field, leaving column as NULL */
914  continue;
915  }
916 
917  if (cstate->opts.csv_mode)
918  {
919  if (string == NULL &&
920  cstate->opts.force_notnull_flags[m])
921  {
922  /*
923  * FORCE_NOT_NULL option is set and column is NULL -
924  * convert it to the NULL string.
925  */
926  string = cstate->opts.null_print;
927  }
928  else if (string != NULL && cstate->opts.force_null_flags[m]
929  && strcmp(string, cstate->opts.null_print) == 0)
930  {
931  /*
932  * FORCE_NULL option is set and column matches the NULL
933  * string. It must have been quoted, or otherwise the
934  * string would already have been set to NULL. Convert it
935  * to NULL as specified.
936  */
937  string = NULL;
938  }
939  }
940 
941  cstate->cur_attname = NameStr(att->attname);
942  cstate->cur_attval = string;
943 
944  if (string != NULL)
945  nulls[m] = false;
946 
947  if (cstate->defaults[m])
948  {
949  /*
950  * The caller must supply econtext and have switched into the
951  * per-tuple memory context in it.
952  */
953  Assert(econtext != NULL);
955 
956  values[m] = ExecEvalExpr(defexprs[m], econtext, &nulls[m]);
957  }
958  else
959  values[m] = InputFunctionCall(&in_functions[m],
960  string,
961  typioparams[m],
962  att->atttypmod);
963 
964  cstate->cur_attname = NULL;
965  cstate->cur_attval = NULL;
966  }
967 
968  Assert(fieldno == attr_count);
969  }
970  else
971  {
972  /* binary */
973  int16 fld_count;
974  ListCell *cur;
975 
976  cstate->cur_lineno++;
977 
978  if (!CopyGetInt16(cstate, &fld_count))
979  {
980  /* EOF detected (end of file, or protocol-level EOF) */
981  return false;
982  }
983 
984  if (fld_count == -1)
985  {
986  /*
987  * Received EOF marker. Wait for the protocol-level EOF, and
988  * complain if it doesn't come immediately. In COPY FROM STDIN,
989  * this ensures that we correctly handle CopyFail, if client
990  * chooses to send that now. When copying from file, we could
991  * ignore the rest of the file like in text mode, but we choose to
992  * be consistent with the COPY FROM STDIN case.
993  */
994  char dummy;
995 
996  if (CopyReadBinaryData(cstate, &dummy, 1) > 0)
997  ereport(ERROR,
998  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
999  errmsg("received copy data after EOF marker")));
1000  return false;
1001  }
1002 
1003  if (fld_count != attr_count)
1004  ereport(ERROR,
1005  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
1006  errmsg("row field count is %d, expected %d",
1007  (int) fld_count, attr_count)));
1008 
1009  foreach(cur, cstate->attnumlist)
1010  {
1011  int attnum = lfirst_int(cur);
1012  int m = attnum - 1;
1013  Form_pg_attribute att = TupleDescAttr(tupDesc, m);
1014 
1015  cstate->cur_attname = NameStr(att->attname);
1016  values[m] = CopyReadBinaryAttribute(cstate,
1017  &in_functions[m],
1018  typioparams[m],
1019  att->atttypmod,
1020  &nulls[m]);
1021  cstate->cur_attname = NULL;
1022  }
1023  }
1024 
1025  /*
1026  * Now compute and insert any defaults available for the columns not
1027  * provided by the input data. Anything not processed here or above will
1028  * remain NULL.
1029  */
1030  for (i = 0; i < num_defaults; i++)
1031  {
1032  /*
1033  * The caller must supply econtext and have switched into the
1034  * per-tuple memory context in it.
1035  */
1036  Assert(econtext != NULL);
1038 
1039  values[defmap[i]] = ExecEvalExpr(defexprs[defmap[i]], econtext,
1040  &nulls[defmap[i]]);
1041  }
1042 
1043  pfree(cstate->defaults);
1044 
1045  return true;
1046 }
static Datum values[MAXATTR]
Definition: bootstrap.c:156
signed short int16
Definition: c.h:477
#define MemSet(start, val, len)
Definition: c.h:1004
static bool CopyGetInt16(CopyFromState cstate, int16 *val)
static Datum CopyReadBinaryAttribute(CopyFromState cstate, FmgrInfo *flinfo, Oid typioparam, int32 typmod, bool *isnull)
static int CopyReadBinaryData(CopyFromState cstate, char *dest, int nbytes)
bool NextCopyFromRawFields(CopyFromState cstate, char ***fields, int *nfields)
static Datum ExecEvalExpr(ExprState *state, ExprContext *econtext, bool *isNull)
Definition: executor.h:332
Datum InputFunctionCall(FmgrInfo *flinfo, char *str, Oid typioparam, int32 typmod)
Definition: fmgr.c:1501
uintptr_t Datum
Definition: postgres.h:64
char string[11]
Definition: preproc-type.c:52
MemoryContext ecxt_per_tuple_memory
Definition: execnodes.h:257

References Assert(), attnum, CopyFromStateData::attnumlist, CopyFormatOptions::binary, CopyFromStateData::convert_select_flags, CopyGetInt16(), CopyReadBinaryAttribute(), CopyReadBinaryData(), CopyFormatOptions::csv_mode, cur, CopyFromStateData::cur_attname, CopyFromStateData::cur_attval, CopyFromStateData::cur_lineno, CurrentMemoryContext, CopyFromStateData::defaults, CopyFromStateData::defexprs, CopyFromStateData::defmap, ExprContext::ecxt_per_tuple_memory, ereport, errcode(), errmsg(), ERROR, ExecEvalExpr(), CopyFormatOptions::force_notnull_flags, CopyFormatOptions::force_null_flags, i, CopyFromStateData::in_functions, InputFunctionCall(), lfirst_int, list_length(), MemSet, NameStr, TupleDescData::natts, NextCopyFromRawFields(), CopyFormatOptions::null_print, CopyFromStateData::num_defaults, CopyFromStateData::opts, palloc0(), pfree(), CopyFromStateData::rel, RelationGetDescr, TupleDescAttr, CopyFromStateData::typioparams, and values.

Referenced by CopyFrom(), file_acquire_sample_rows(), and fileIterateForeignScan().

◆ NextCopyFromRawFields()

bool NextCopyFromRawFields ( CopyFromState  cstate,
char ***  fields,
int *  nfields 
)

Definition at line 754 of file copyfromparse.c.

755 {
756  int fldct;
757  bool done;
758 
759  /* only available for text or csv input */
760  Assert(!cstate->opts.binary);
761 
762  /* on input check that the header line is correct if needed */
763  if (cstate->cur_lineno == 0 && cstate->opts.header_line)
764  {
765  ListCell *cur;
766  TupleDesc tupDesc;
767 
768  tupDesc = RelationGetDescr(cstate->rel);
769 
770  cstate->cur_lineno++;
771  done = CopyReadLine(cstate);
772 
773  if (cstate->opts.header_line == COPY_HEADER_MATCH)
774  {
775  int fldnum;
776 
777  if (cstate->opts.csv_mode)
778  fldct = CopyReadAttributesCSV(cstate);
779  else
780  fldct = CopyReadAttributesText(cstate);
781 
782  if (fldct != list_length(cstate->attnumlist))
783  ereport(ERROR,
784  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
785  errmsg("wrong number of fields in header line: got %d, expected %d",
786  fldct, list_length(cstate->attnumlist))));
787 
788  fldnum = 0;
789  foreach(cur, cstate->attnumlist)
790  {
791  int attnum = lfirst_int(cur);
792  char *colName;
793  Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
794 
795  Assert(fldnum < cstate->max_fields);
796 
797  colName = cstate->raw_fields[fldnum++];
798  if (colName == NULL)
799  ereport(ERROR,
800  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
801  errmsg("column name mismatch in header line field %d: got null value (\"%s\"), expected \"%s\"",
802  fldnum, cstate->opts.null_print, NameStr(attr->attname))));
803 
804  if (namestrcmp(&attr->attname, colName) != 0)
805  {
806  ereport(ERROR,
807  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
808  errmsg("column name mismatch in header line field %d: got \"%s\", expected \"%s\"",
809  fldnum, colName, NameStr(attr->attname))));
810  }
811  }
812  }
813 
814  if (done)
815  return false;
816  }
817 
818  cstate->cur_lineno++;
819 
820  /* Actually read the line into memory here */
821  done = CopyReadLine(cstate);
822 
823  /*
824  * EOF at start of line means we're done. If we see EOF after some
825  * characters, we act as though it was newline followed by EOF, ie,
826  * process the line and then exit loop on next iteration.
827  */
828  if (done && cstate->line_buf.len == 0)
829  return false;
830 
831  /* Parse the line into de-escaped field values */
832  if (cstate->opts.csv_mode)
833  fldct = CopyReadAttributesCSV(cstate);
834  else
835  fldct = CopyReadAttributesText(cstate);
836 
837  *fields = cstate->raw_fields;
838  *nfields = fldct;
839  return true;
840 }
static int CopyReadAttributesCSV(CopyFromState cstate)
static int CopyReadAttributesText(CopyFromState cstate)
static bool CopyReadLine(CopyFromState cstate)

References Assert(), attnum, CopyFromStateData::attnumlist, CopyFormatOptions::binary, COPY_HEADER_MATCH, CopyReadAttributesCSV(), CopyReadAttributesText(), CopyReadLine(), CopyFormatOptions::csv_mode, cur, CopyFromStateData::cur_lineno, ereport, errcode(), errmsg(), ERROR, CopyFormatOptions::header_line, StringInfoData::len, lfirst_int, CopyFromStateData::line_buf, list_length(), NameStr, namestrcmp(), CopyFormatOptions::null_print, CopyFromStateData::opts, CopyFromStateData::raw_fields, CopyFromStateData::rel, RelationGetDescr, and TupleDescAttr.

Referenced by NextCopyFrom().

◆ ProcessCopyOptions()

void ProcessCopyOptions ( ParseState pstate,
CopyFormatOptions opts_out,
bool  is_from,
List options 
)

Definition at line 414 of file copy.c.

418 {
419  bool format_specified = false;
420  bool freeze_specified = false;
421  bool header_specified = false;
422  ListCell *option;
423 
424  /* Support external use for option sanity checking */
425  if (opts_out == NULL)
426  opts_out = (CopyFormatOptions *) palloc0(sizeof(CopyFormatOptions));
427 
428  opts_out->file_encoding = -1;
429 
430  /* Extract options from the statement node tree */
431  foreach(option, options)
432  {
433  DefElem *defel = lfirst_node(DefElem, option);
434 
435  if (strcmp(defel->defname, "format") == 0)
436  {
437  char *fmt = defGetString(defel);
438 
439  if (format_specified)
440  errorConflictingDefElem(defel, pstate);
441  format_specified = true;
442  if (strcmp(fmt, "text") == 0)
443  /* default format */ ;
444  else if (strcmp(fmt, "csv") == 0)
445  opts_out->csv_mode = true;
446  else if (strcmp(fmt, "binary") == 0)
447  opts_out->binary = true;
448  else
449  ereport(ERROR,
450  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
451  errmsg("COPY format \"%s\" not recognized", fmt),
452  parser_errposition(pstate, defel->location)));
453  }
454  else if (strcmp(defel->defname, "freeze") == 0)
455  {
456  if (freeze_specified)
457  errorConflictingDefElem(defel, pstate);
458  freeze_specified = true;
459  opts_out->freeze = defGetBoolean(defel);
460  }
461  else if (strcmp(defel->defname, "delimiter") == 0)
462  {
463  if (opts_out->delim)
464  errorConflictingDefElem(defel, pstate);
465  opts_out->delim = defGetString(defel);
466  }
467  else if (strcmp(defel->defname, "null") == 0)
468  {
469  if (opts_out->null_print)
470  errorConflictingDefElem(defel, pstate);
471  opts_out->null_print = defGetString(defel);
472  }
473  else if (strcmp(defel->defname, "default") == 0)
474  {
475  if (opts_out->default_print)
476  errorConflictingDefElem(defel, pstate);
477  opts_out->default_print = defGetString(defel);
478  }
479  else if (strcmp(defel->defname, "header") == 0)
480  {
481  if (header_specified)
482  errorConflictingDefElem(defel, pstate);
483  header_specified = true;
484  opts_out->header_line = defGetCopyHeaderChoice(defel, is_from);
485  }
486  else if (strcmp(defel->defname, "quote") == 0)
487  {
488  if (opts_out->quote)
489  errorConflictingDefElem(defel, pstate);
490  opts_out->quote = defGetString(defel);
491  }
492  else if (strcmp(defel->defname, "escape") == 0)
493  {
494  if (opts_out->escape)
495  errorConflictingDefElem(defel, pstate);
496  opts_out->escape = defGetString(defel);
497  }
498  else if (strcmp(defel->defname, "force_quote") == 0)
499  {
500  if (opts_out->force_quote || opts_out->force_quote_all)
501  errorConflictingDefElem(defel, pstate);
502  if (defel->arg && IsA(defel->arg, A_Star))
503  opts_out->force_quote_all = true;
504  else if (defel->arg && IsA(defel->arg, List))
505  opts_out->force_quote = castNode(List, defel->arg);
506  else
507  ereport(ERROR,
508  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
509  errmsg("argument to option \"%s\" must be a list of column names",
510  defel->defname),
511  parser_errposition(pstate, defel->location)));
512  }
513  else if (strcmp(defel->defname, "force_not_null") == 0)
514  {
515  if (opts_out->force_notnull)
516  errorConflictingDefElem(defel, pstate);
517  if (defel->arg && IsA(defel->arg, List))
518  opts_out->force_notnull = castNode(List, defel->arg);
519  else
520  ereport(ERROR,
521  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
522  errmsg("argument to option \"%s\" must be a list of column names",
523  defel->defname),
524  parser_errposition(pstate, defel->location)));
525  }
526  else if (strcmp(defel->defname, "force_null") == 0)
527  {
528  if (opts_out->force_null)
529  errorConflictingDefElem(defel, pstate);
530  if (defel->arg && IsA(defel->arg, List))
531  opts_out->force_null = castNode(List, defel->arg);
532  else
533  ereport(ERROR,
534  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
535  errmsg("argument to option \"%s\" must be a list of column names",
536  defel->defname),
537  parser_errposition(pstate, defel->location)));
538  }
539  else if (strcmp(defel->defname, "convert_selectively") == 0)
540  {
541  /*
542  * Undocumented, not-accessible-from-SQL option: convert only the
543  * named columns to binary form, storing the rest as NULLs. It's
544  * allowed for the column list to be NIL.
545  */
546  if (opts_out->convert_selectively)
547  errorConflictingDefElem(defel, pstate);
548  opts_out->convert_selectively = true;
549  if (defel->arg == NULL || IsA(defel->arg, List))
550  opts_out->convert_select = castNode(List, defel->arg);
551  else
552  ereport(ERROR,
553  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
554  errmsg("argument to option \"%s\" must be a list of column names",
555  defel->defname),
556  parser_errposition(pstate, defel->location)));
557  }
558  else if (strcmp(defel->defname, "encoding") == 0)
559  {
560  if (opts_out->file_encoding >= 0)
561  errorConflictingDefElem(defel, pstate);
562  opts_out->file_encoding = pg_char_to_encoding(defGetString(defel));
563  if (opts_out->file_encoding < 0)
564  ereport(ERROR,
565  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
566  errmsg("argument to option \"%s\" must be a valid encoding name",
567  defel->defname),
568  parser_errposition(pstate, defel->location)));
569  }
570  else
571  ereport(ERROR,
572  (errcode(ERRCODE_SYNTAX_ERROR),
573  errmsg("option \"%s\" not recognized",
574  defel->defname),
575  parser_errposition(pstate, defel->location)));
576  }
577 
578  /*
579  * Check for incompatible options (must do these two before inserting
580  * defaults)
581  */
582  if (opts_out->binary && opts_out->delim)
583  ereport(ERROR,
584  (errcode(ERRCODE_SYNTAX_ERROR),
585  errmsg("cannot specify DELIMITER in BINARY mode")));
586 
587  if (opts_out->binary && opts_out->null_print)
588  ereport(ERROR,
589  (errcode(ERRCODE_SYNTAX_ERROR),
590  errmsg("cannot specify NULL in BINARY mode")));
591 
592  if (opts_out->binary && opts_out->default_print)
593  ereport(ERROR,
594  (errcode(ERRCODE_SYNTAX_ERROR),
595  errmsg("cannot specify DEFAULT in BINARY mode")));
596 
597  /* Set defaults for omitted options */
598  if (!opts_out->delim)
599  opts_out->delim = opts_out->csv_mode ? "," : "\t";
600 
601  if (!opts_out->null_print)
602  opts_out->null_print = opts_out->csv_mode ? "" : "\\N";
603  opts_out->null_print_len = strlen(opts_out->null_print);
604 
605  if (opts_out->csv_mode)
606  {
607  if (!opts_out->quote)
608  opts_out->quote = "\"";
609  if (!opts_out->escape)
610  opts_out->escape = opts_out->quote;
611  }
612 
613  /* Only single-byte delimiter strings are supported. */
614  if (strlen(opts_out->delim) != 1)
615  ereport(ERROR,
616  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
617  errmsg("COPY delimiter must be a single one-byte character")));
618 
619  /* Disallow end-of-line characters */
620  if (strchr(opts_out->delim, '\r') != NULL ||
621  strchr(opts_out->delim, '\n') != NULL)
622  ereport(ERROR,
623  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
624  errmsg("COPY delimiter cannot be newline or carriage return")));
625 
626  if (strchr(opts_out->null_print, '\r') != NULL ||
627  strchr(opts_out->null_print, '\n') != NULL)
628  ereport(ERROR,
629  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
630  errmsg("COPY null representation cannot use newline or carriage return")));
631 
632  if (opts_out->default_print)
633  {
634  opts_out->default_print_len = strlen(opts_out->default_print);
635 
636  if (strchr(opts_out->default_print, '\r') != NULL ||
637  strchr(opts_out->default_print, '\n') != NULL)
638  ereport(ERROR,
639  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
640  errmsg("COPY default representation cannot use newline or carriage return")));
641  }
642 
643  /*
644  * Disallow unsafe delimiter characters in non-CSV mode. We can't allow
645  * backslash because it would be ambiguous. We can't allow the other
646  * cases because data characters matching the delimiter must be
647  * backslashed, and certain backslash combinations are interpreted
648  * non-literally by COPY IN. Disallowing all lower case ASCII letters is
649  * more than strictly necessary, but seems best for consistency and
650  * future-proofing. Likewise we disallow all digits though only octal
651  * digits are actually dangerous.
652  */
653  if (!opts_out->csv_mode &&
654  strchr("\\.abcdefghijklmnopqrstuvwxyz0123456789",
655  opts_out->delim[0]) != NULL)
656  ereport(ERROR,
657  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
658  errmsg("COPY delimiter cannot be \"%s\"", opts_out->delim)));
659 
660  /* Check header */
661  if (opts_out->binary && opts_out->header_line)
662  ereport(ERROR,
663  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
664  errmsg("cannot specify HEADER in BINARY mode")));
665 
666  /* Check quote */
667  if (!opts_out->csv_mode && opts_out->quote != NULL)
668  ereport(ERROR,
669  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
670  errmsg("COPY quote available only in CSV mode")));
671 
672  if (opts_out->csv_mode && strlen(opts_out->quote) != 1)
673  ereport(ERROR,
674  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
675  errmsg("COPY quote must be a single one-byte character")));
676 
677  if (opts_out->csv_mode && opts_out->delim[0] == opts_out->quote[0])
678  ereport(ERROR,
679  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
680  errmsg("COPY delimiter and quote must be different")));
681 
682  /* Check escape */
683  if (!opts_out->csv_mode && opts_out->escape != NULL)
684  ereport(ERROR,
685  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
686  errmsg("COPY escape available only in CSV mode")));
687 
688  if (opts_out->csv_mode && strlen(opts_out->escape) != 1)
689  ereport(ERROR,
690  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
691  errmsg("COPY escape must be a single one-byte character")));
692 
693  /* Check force_quote */
694  if (!opts_out->csv_mode && (opts_out->force_quote || opts_out->force_quote_all))
695  ereport(ERROR,
696  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
697  errmsg("COPY force quote available only in CSV mode")));
698  if ((opts_out->force_quote || opts_out->force_quote_all) && is_from)
699  ereport(ERROR,
700  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
701  errmsg("COPY force quote only available using COPY TO")));
702 
703  /* Check force_notnull */
704  if (!opts_out->csv_mode && opts_out->force_notnull != NIL)
705  ereport(ERROR,
706  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
707  errmsg("COPY force not null available only in CSV mode")));
708  if (opts_out->force_notnull != NIL && !is_from)
709  ereport(ERROR,
710  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
711  errmsg("COPY force not null only available using COPY FROM")));
712 
713  /* Check force_null */
714  if (!opts_out->csv_mode && opts_out->force_null != NIL)
715  ereport(ERROR,
716  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
717  errmsg("COPY force null available only in CSV mode")));
718 
719  if (opts_out->force_null != NIL && !is_from)
720  ereport(ERROR,
721  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
722  errmsg("COPY force null only available using COPY FROM")));
723 
724  /* Don't allow the delimiter to appear in the null string. */
725  if (strchr(opts_out->null_print, opts_out->delim[0]) != NULL)
726  ereport(ERROR,
727  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
728  errmsg("COPY delimiter must not appear in the NULL specification")));
729 
730  /* Don't allow the CSV quote char to appear in the null string. */
731  if (opts_out->csv_mode &&
732  strchr(opts_out->null_print, opts_out->quote[0]) != NULL)
733  ereport(ERROR,
734  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
735  errmsg("CSV quote character must not appear in the NULL specification")));
736 
737  if (opts_out->default_print)
738  {
739  if (!is_from)
740  ereport(ERROR,
741  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
742  errmsg("COPY DEFAULT only available using COPY FROM")));
743 
744  /* Don't allow the delimiter to appear in the default string. */
745  if (strchr(opts_out->default_print, opts_out->delim[0]) != NULL)
746  ereport(ERROR,
747  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
748  errmsg("COPY delimiter must not appear in the DEFAULT specification")));
749 
750  /* Don't allow the CSV quote char to appear in the default string. */
751  if (opts_out->csv_mode &&
752  strchr(opts_out->default_print, opts_out->quote[0]) != NULL)
753  ereport(ERROR,
754  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
755  errmsg("CSV quote character must not appear in the DEFAULT specification")));
756 
757  /* Don't allow the NULL and DEFAULT string to be the same */
758  if (opts_out->null_print_len == opts_out->default_print_len &&
759  strncmp(opts_out->null_print, opts_out->default_print,
760  opts_out->null_print_len) == 0)
761  ereport(ERROR,
762  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
763  errmsg("NULL specification and DEFAULT specification cannot be the same")));
764  }
765 }
static CopyHeaderChoice defGetCopyHeaderChoice(DefElem *def, bool is_from)
Definition: copy.c:337
bool defGetBoolean(DefElem *def)
Definition: define.c:108
char * defGetString(DefElem *def)
Definition: define.c:49
void errorConflictingDefElem(DefElem *defel, ParseState *pstate)
Definition: define.c:385
int pg_char_to_encoding(const char *name)
Definition: encnames.c:550
static void const char * fmt
int parser_errposition(ParseState *pstate, int location)
Definition: parse_node.c:111
int default_print_len
Definition: copy.h:51
char * quote
Definition: copy.h:53
char * escape
Definition: copy.h:54
char * default_print
Definition: copy.h:50
char * defname
Definition: parsenodes.h:810
int location
Definition: parsenodes.h:814
Node * arg
Definition: parsenodes.h:811

References DefElem::arg, CopyFormatOptions::binary, castNode, CopyFormatOptions::convert_select, CopyFormatOptions::convert_selectively, CopyFormatOptions::csv_mode, CopyFormatOptions::default_print, CopyFormatOptions::default_print_len, defGetBoolean(), defGetCopyHeaderChoice(), defGetString(), DefElem::defname, CopyFormatOptions::delim, ereport, errcode(), errmsg(), ERROR, errorConflictingDefElem(), CopyFormatOptions::escape, CopyFormatOptions::file_encoding, fmt, CopyFormatOptions::force_notnull, CopyFormatOptions::force_null, CopyFormatOptions::force_quote, CopyFormatOptions::force_quote_all, CopyFormatOptions::freeze, CopyFormatOptions::header_line, IsA, lfirst_node, DefElem::location, NIL, CopyFormatOptions::null_print, CopyFormatOptions::null_print_len, palloc0(), parser_errposition(), pg_char_to_encoding(), and CopyFormatOptions::quote.

Referenced by BeginCopyFrom(), BeginCopyTo(), and file_fdw_validator().