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.

Typedefs

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

Functions

void DoCopy (ParseState *state, const CopyStmt *stmt, int stmt_location, int stmt_len, uint64 *processed)
 
void ProcessCopyOptions (ParseState *pstate, CopyState cstate, bool is_from, List *options)
 
CopyState BeginCopyFrom (ParseState *pstate, Relation rel, const char *filename, bool is_program, copy_data_source_cb data_source_cb, List *attnamelist, List *options)
 
void EndCopyFrom (CopyState cstate)
 
bool NextCopyFrom (CopyState cstate, ExprContext *econtext, Datum *values, bool *nulls, Oid *tupleOid)
 
bool NextCopyFromRawFields (CopyState cstate, char ***fields, int *nfields)
 
void CopyFromErrorCallback (void *arg)
 
uint64 CopyFrom (CopyState cstate)
 
DestReceiverCreateCopyDestReceiver (void)
 

Typedef Documentation

◆ copy_data_source_cb

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

Definition at line 24 of file copy.h.

◆ CopyState

Definition at line 23 of file copy.h.

Function Documentation

◆ BeginCopyFrom()

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

Definition at line 2943 of file copy.c.

References AllocateFile(), Assert, CopyStateData::attnumlist, CopyStateData::attribute_buf, BeginCopy(), CopyStateData::binary, BinarySignature, build_column_default(), contain_volatile_functions_not_nextval(), COPY_CALLBACK, CopyStateData::copy_dest, CopyStateData::copy_file, CopyStateData::copycontext, CopyGetData(), CopyGetInt32(), CopyStateData::cur_attname, CopyStateData::cur_attval, CopyStateData::cur_lineno, CopyStateData::cur_relname, CopyStateData::data_source_cb, CopyStateData::defexprs, CopyStateData::defmap, DestRemote, CopyStateData::eol_type, EOL_UNKNOWN, ereport, errcode(), errcode_for_file_access(), errhint(), errmsg(), ERROR, ExecInitExpr(), expression_planner(), CopyStateData::fe_eof, CopyStateData::file_has_oids, CopyStateData::filename, fmgr_info(), getOwnedSequence(), getTypeBinaryInputInfo(), getTypeInputInfo(), CopyStateData::in_functions, initStringInfo(), InvalidOid, CopyStateData::is_program, CopyStateData::line_buf, CopyStateData::line_buf_converted, list_length(), list_member_int(), makeNode, CopyStateData::max_fields, MemoryContextSwitchTo(), tupleDesc::natts, CopyStateData::num_defaults, CopyStateData::oid_in_function, CopyStateData::oid_typioparam, OIDOID, CopyStateData::oids, OpenPipeStream(), ParseState::p_rtable, palloc(), PG_BINARY_R, pstrdup(), CopyStateData::range_table, CopyStateData::raw_buf, CopyStateData::raw_buf_index, CopyStateData::raw_buf_len, RAW_BUF_SIZE, CopyStateData::raw_fields, ReceiveCopyBegin(), CopyStateData::rel, RelationGetDescr, RelationGetRelationName, RelationGetRelid, S_ISDIR, NextValueExpr::seqid, stat, TupleDescAttr, NextValueExpr::typeId, CopyStateData::typioparams, CopyStateData::volatile_defexprs, and whereToSendOutput.

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

2950 {
2951  CopyState cstate;
2952  bool pipe = (filename == NULL);
2953  TupleDesc tupDesc;
2954  AttrNumber num_phys_attrs,
2955  num_defaults;
2956  FmgrInfo *in_functions;
2957  Oid *typioparams;
2958  int attnum;
2959  Oid in_func_oid;
2960  int *defmap;
2961  ExprState **defexprs;
2962  MemoryContext oldcontext;
2963  bool volatile_defexprs;
2964 
2965  cstate = BeginCopy(pstate, true, rel, NULL, InvalidOid, attnamelist, options);
2966  oldcontext = MemoryContextSwitchTo(cstate->copycontext);
2967 
2968  /* Initialize state variables */
2969  cstate->fe_eof = false;
2970  cstate->eol_type = EOL_UNKNOWN;
2971  cstate->cur_relname = RelationGetRelationName(cstate->rel);
2972  cstate->cur_lineno = 0;
2973  cstate->cur_attname = NULL;
2974  cstate->cur_attval = NULL;
2975 
2976  /* Set up variables to avoid per-attribute overhead. */
2977  initStringInfo(&cstate->attribute_buf);
2978  initStringInfo(&cstate->line_buf);
2979  cstate->line_buf_converted = false;
2980  cstate->raw_buf = (char *) palloc(RAW_BUF_SIZE + 1);
2981  cstate->raw_buf_index = cstate->raw_buf_len = 0;
2982 
2983  /* Assign range table, we'll need it in CopyFrom. */
2984  if (pstate)
2985  cstate->range_table = pstate->p_rtable;
2986 
2987  tupDesc = RelationGetDescr(cstate->rel);
2988  num_phys_attrs = tupDesc->natts;
2989  num_defaults = 0;
2990  volatile_defexprs = false;
2991 
2992  /*
2993  * Pick up the required catalog information for each attribute in the
2994  * relation, including the input function, the element type (to pass to
2995  * the input function), and info about defaults and constraints. (Which
2996  * input function we use depends on text/binary format choice.)
2997  */
2998  in_functions = (FmgrInfo *) palloc(num_phys_attrs * sizeof(FmgrInfo));
2999  typioparams = (Oid *) palloc(num_phys_attrs * sizeof(Oid));
3000  defmap = (int *) palloc(num_phys_attrs * sizeof(int));
3001  defexprs = (ExprState **) palloc(num_phys_attrs * sizeof(ExprState *));
3002 
3003  for (attnum = 1; attnum <= num_phys_attrs; attnum++)
3004  {
3005  Form_pg_attribute att = TupleDescAttr(tupDesc, attnum - 1);
3006 
3007  /* We don't need info for dropped attributes */
3008  if (att->attisdropped)
3009  continue;
3010 
3011  /* Fetch the input function and typioparam info */
3012  if (cstate->binary)
3013  getTypeBinaryInputInfo(att->atttypid,
3014  &in_func_oid, &typioparams[attnum - 1]);
3015  else
3016  getTypeInputInfo(att->atttypid,
3017  &in_func_oid, &typioparams[attnum - 1]);
3018  fmgr_info(in_func_oid, &in_functions[attnum - 1]);
3019 
3020  /* Get default info if needed */
3021  if (!list_member_int(cstate->attnumlist, attnum))
3022  {
3023  /* attribute is NOT to be copied from input */
3024  /* use default value if one exists */
3025  Expr *defexpr;
3026 
3027  if (att->attidentity)
3028  {
3030 
3031  nve->seqid = getOwnedSequence(RelationGetRelid(cstate->rel),
3032  attnum);
3033  nve->typeId = att->atttypid;
3034  defexpr = (Expr *) nve;
3035  }
3036  else
3037  defexpr = (Expr *) build_column_default(cstate->rel, attnum);
3038 
3039  if (defexpr != NULL)
3040  {
3041  /* Run the expression through planner */
3042  defexpr = expression_planner(defexpr);
3043 
3044  /* Initialize executable expression in copycontext */
3045  defexprs[num_defaults] = ExecInitExpr(defexpr, NULL);
3046  defmap[num_defaults] = attnum - 1;
3047  num_defaults++;
3048 
3049  /*
3050  * If a default expression looks at the table being loaded,
3051  * then it could give the wrong answer when using
3052  * multi-insert. Since database access can be dynamic this is
3053  * hard to test for exactly, so we use the much wider test of
3054  * whether the default expression is volatile. We allow for
3055  * the special case of when the default expression is the
3056  * nextval() of a sequence which in this specific case is
3057  * known to be safe for use with the multi-insert
3058  * optimization. Hence we use this special case function
3059  * checker rather than the standard check for
3060  * contain_volatile_functions().
3061  */
3062  if (!volatile_defexprs)
3063  volatile_defexprs = contain_volatile_functions_not_nextval((Node *) defexpr);
3064  }
3065  }
3066  }
3067 
3068  /* We keep those variables in cstate. */
3069  cstate->in_functions = in_functions;
3070  cstate->typioparams = typioparams;
3071  cstate->defmap = defmap;
3072  cstate->defexprs = defexprs;
3073  cstate->volatile_defexprs = volatile_defexprs;
3074  cstate->num_defaults = num_defaults;
3075  cstate->is_program = is_program;
3076 
3077  if (data_source_cb)
3078  {
3079  cstate->copy_dest = COPY_CALLBACK;
3080  cstate->data_source_cb = data_source_cb;
3081  }
3082  else if (pipe)
3083  {
3084  Assert(!is_program); /* the grammar does not allow this */
3086  ReceiveCopyBegin(cstate);
3087  else
3088  cstate->copy_file = stdin;
3089  }
3090  else
3091  {
3092  cstate->filename = pstrdup(filename);
3093 
3094  if (cstate->is_program)
3095  {
3096  cstate->copy_file = OpenPipeStream(cstate->filename, PG_BINARY_R);
3097  if (cstate->copy_file == NULL)
3098  ereport(ERROR,
3100  errmsg("could not execute command \"%s\": %m",
3101  cstate->filename)));
3102  }
3103  else
3104  {
3105  struct stat st;
3106 
3107  cstate->copy_file = AllocateFile(cstate->filename, PG_BINARY_R);
3108  if (cstate->copy_file == NULL)
3109  {
3110  /* copy errno because ereport subfunctions might change it */
3111  int save_errno = errno;
3112 
3113  ereport(ERROR,
3115  errmsg("could not open file \"%s\" for reading: %m",
3116  cstate->filename),
3117  (save_errno == ENOENT || save_errno == EACCES) ?
3118  errhint("COPY FROM instructs the PostgreSQL server process to read a file. "
3119  "You may want a client-side facility such as psql's \\copy.") : 0));
3120  }
3121 
3122  if (fstat(fileno(cstate->copy_file), &st))
3123  ereport(ERROR,
3125  errmsg("could not stat file \"%s\": %m",
3126  cstate->filename)));
3127 
3128  if (S_ISDIR(st.st_mode))
3129  ereport(ERROR,
3130  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
3131  errmsg("\"%s\" is a directory", cstate->filename)));
3132  }
3133  }
3134 
3135  if (!cstate->binary)
3136  {
3137  /* must rely on user to tell us... */
3138  cstate->file_has_oids = cstate->oids;
3139  }
3140  else
3141  {
3142  /* Read and verify binary header */
3143  char readSig[11];
3144  int32 tmp;
3145 
3146  /* Signature */
3147  if (CopyGetData(cstate, readSig, 11, 11) != 11 ||
3148  memcmp(readSig, BinarySignature, 11) != 0)
3149  ereport(ERROR,
3150  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3151  errmsg("COPY file signature not recognized")));
3152  /* Flags field */
3153  if (!CopyGetInt32(cstate, &tmp))
3154  ereport(ERROR,
3155  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3156  errmsg("invalid COPY file header (missing flags)")));
3157  cstate->file_has_oids = (tmp & (1 << 16)) != 0;
3158  tmp &= ~(1 << 16);
3159  if ((tmp >> 16) != 0)
3160  ereport(ERROR,
3161  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3162  errmsg("unrecognized critical flags in COPY file header")));
3163  /* Header extension length */
3164  if (!CopyGetInt32(cstate, &tmp) ||
3165  tmp < 0)
3166  ereport(ERROR,
3167  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3168  errmsg("invalid COPY file header (missing length)")));
3169  /* Skip extension header, if present */
3170  while (tmp-- > 0)
3171  {
3172  if (CopyGetData(cstate, readSig, 1, 1) != 1)
3173  ereport(ERROR,
3174  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3175  errmsg("invalid COPY file header (wrong length)")));
3176  }
3177  }
3178 
3179  if (cstate->file_has_oids && cstate->binary)
3180  {
3182  &in_func_oid, &cstate->oid_typioparam);
3183  fmgr_info(in_func_oid, &cstate->oid_in_function);
3184  }
3185 
3186  /* create workspace for CopyReadAttributes results */
3187  if (!cstate->binary)
3188  {
3189  AttrNumber attr_count = list_length(cstate->attnumlist);
3190  int nfields = cstate->file_has_oids ? (attr_count + 1) : attr_count;
3191 
3192  cstate->max_fields = nfields;
3193  cstate->raw_fields = (char **) palloc(nfields * sizeof(char *));
3194  }
3195 
3196  MemoryContextSwitchTo(oldcontext);
3197 
3198  return cstate;
3199 }
Definition: fmgr.h:56
Oid getOwnedSequence(Oid relid, AttrNumber attnum)
Definition: pg_depend.c:605
List * range_table
Definition: copy.c:167
static CopyState BeginCopy(ParseState *pstate, bool is_from, Relation rel, RawStmt *raw_query, Oid queryRelId, List *attnamelist, List *options)
Definition: copy.c:1372
bool contain_volatile_functions_not_nextval(Node *clause)
Definition: clauses.c:1010
static bool CopyGetInt32(CopyState cstate, int32 *val)
Definition: copy.c:682
int errhint(const char *fmt,...)
Definition: elog.c:987
char ** raw_fields
Definition: copy.c:188
bool binary
Definition: copy.c:116
#define RelationGetDescr(relation)
Definition: rel.h:437
AttrNumber num_defaults
Definition: copy.c:158
FmgrInfo * in_functions
Definition: copy.c:162
List * attnumlist
Definition: copy.c:112
#define OIDOID
Definition: pg_type.h:328
char * filename
Definition: copy.c:113
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:90
bool file_has_oids
Definition: copy.c:159
char * pstrdup(const char *in)
Definition: mcxt.c:1063
static void ReceiveCopyBegin(CopyState cstate)
Definition: copy.c:380
Expr * expression_planner(Expr *expr)
Definition: planner.c:6026
StringInfoData line_buf
Definition: copy.c:197
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
Definition: nodes.h:512
int raw_buf_index
Definition: copy.c:210
int errcode(int sqlerrcode)
Definition: elog.c:575
bool fe_eof
Definition: copy.c:103
unsigned int Oid
Definition: postgres_ext.h:31
bool volatile_defexprs
Definition: copy.c:166
#define PG_BINARY_R
Definition: c.h:1051
int natts
Definition: tupdesc.h:79
bool line_buf_converted
Definition: copy.c:198
signed int int32
Definition: c.h:294
CopyDest copy_dest
Definition: copy.c:99
const char * cur_attname
Definition: copy.c:141
Relation rel
Definition: copy.c:110
MemoryContext copycontext
Definition: copy.c:147
copy_data_source_cb data_source_cb
Definition: copy.c:115
#define ERROR
Definition: elog.h:43
static int CopyGetData(CopyState cstate, void *databuf, int minread, int maxread)
Definition: copy.c:556
void fmgr_info(Oid functionId, FmgrInfo *finfo)
Definition: fmgr.c:122
bool list_member_int(const List *list, int datum)
Definition: list.c:485
char * raw_buf
Definition: copy.c:209
ExprState ** defexprs
Definition: copy.c:165
const char * cur_relname
Definition: copy.c:139
int errcode_for_file_access(void)
Definition: elog.c:598
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2343
FmgrInfo oid_in_function
Definition: copy.c:160
#define RelationGetRelationName(relation)
Definition: rel.h:445
static const char BinarySignature[11]
Definition: copy.c:288
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:187
int raw_buf_len
Definition: copy.c:211
int max_fields
Definition: copy.c:187
FILE * OpenPipeStream(const char *command, const char *mode)
Definition: fd.c:2442
void getTypeBinaryInputInfo(Oid type, Oid *typReceive, Oid *typIOParam)
Definition: lsyscache.c:2698
#define ereport(elevel, rest)
Definition: elog.h:122
void getTypeInputInfo(Oid type, Oid *typInput, Oid *typIOParam)
Definition: lsyscache.c:2632
void initStringInfo(StringInfo str)
Definition: stringinfo.c:46
#define stat(a, b)
Definition: win32_port.h:266
Oid * typioparams
Definition: copy.c:163
bool is_program
Definition: copy.c:114
Node * build_column_default(Relation rel, int attrno)
#define RAW_BUF_SIZE
Definition: copy.c:208
#define InvalidOid
Definition: postgres_ext.h:36
#define makeNode(_type_)
Definition: nodes.h:560
EolType eol_type
Definition: copy.c:104
#define Assert(condition)
Definition: c.h:680
static int list_length(const List *l)
Definition: pg_list.h:89
#define S_ISDIR(m)
Definition: win32_port.h:307
static char * filename
Definition: pg_dumpall.c:90
void * palloc(Size size)
Definition: mcxt.c:835
int errmsg(const char *fmt,...)
Definition: elog.c:797
FILE * copy_file
Definition: copy.c:100
int cur_lineno
Definition: copy.c:140
StringInfoData attribute_buf
Definition: copy.c:183
ExprState * ExecInitExpr(Expr *node, PlanState *parent)
Definition: execExpr.c:118
const char * cur_attval
Definition: copy.c:142
CommandDest whereToSendOutput
Definition: postgres.c:88
Oid oid_typioparam
Definition: copy.c:161
int16 AttrNumber
Definition: attnum.h:21
#define RelationGetRelid(relation)
Definition: rel.h:425
int * defmap
Definition: copy.c:164
List * p_rtable
Definition: parse_node.h:173
bool oids
Definition: copy.c:117

◆ CopyFrom()

uint64 CopyFrom ( CopyState  cstate)

Definition at line 2280 of file copy.c.

References AfterTriggerBeginQuery(), AfterTriggerEndQuery(), ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, CHECK_FOR_INTERRUPTS, CMD_INSERT, tupleDesc::constr, convert_tuples_by_name(), CopyStateData::copy_dest, COPY_OLD_FE, CopyFromErrorCallback(), CopyFromInsertBatch(), CreateExecutorState(), CopyStateData::cur_lineno, CurrentMemoryContext, do_convert_tuple(), ereport, errcode(), errhint(), errmsg(), ERROR, error_context_stack, EState::es_num_result_relations, EState::es_range_table, EState::es_result_relation_info, EState::es_result_relations, EState::es_trig_tuple_slot, EState::es_tupleTable, ExecARInsertTriggers(), ExecASInsertTriggers(), ExecBRInsertTriggers(), ExecBSInsertTriggers(), ExecCleanUpTriggerState(), ExecCleanupTupleRouting(), ExecCloseIndices(), ExecConstraints(), ExecFindPartition(), ExecInitExtraTupleSlot(), ExecInsertIndexTuples(), ExecIRInsertTriggers(), ExecMaterializeSlot(), ExecOpenIndices(), ExecResetTupleTable(), ExecSetSlotDescriptor(), ExecSetupPartitionTupleRouting(), ExecStoreTuple(), FreeBulkInsertState(), FreeExecutorState(), CopyStateData::freeze, GetBulkInsertState(), GetCurrentCommandId(), GetCurrentSubTransactionId(), GetPerTupleExprContext, GetPerTupleMemoryContext, gettext_noop, heap_form_tuple(), heap_insert(), HEAP_INSERT_FROZEN, HEAP_INSERT_SKIP_FSM, HEAP_INSERT_SKIP_WAL, heap_sync(), HeapTupleSetOid, i, InitResultRelInfo(), InvalidateCatalogSnapshot(), InvalidBuffer, InvalidOid, InvalidSubTransactionId, list_free(), makeNode, MakeTransitionCaptureState(), MAX_BUFFERED_TUPLES, MemoryContextSwitchTo(), tupleDesc::natts, NextCopyFrom(), NIL, PartitionTupleRouting::num_partitions, palloc(), palloc0(), PartitionTupleRouting::partition_dispatch_info, PartitionTupleRouting::partition_tupconv_maps, CopyStateData::partition_tuple_routing, PartitionTupleRouting::partition_tuple_slot, PartitionTupleRouting::partitions, pfree(), pq_endmsgread(), ErrorContextCallback::previous, CopyStateData::range_table, RelationData::rd_att, RelationData::rd_createSubid, RelationData::rd_newRelfilenodeSubid, RelationData::rd_rel, CopyStateData::rel, RelationGetDescr, RelationGetRelationName, RelationGetRelid, ReleaseBulkInsertStatePin(), RELKIND_FOREIGN_TABLE, RELKIND_MATVIEW, RELKIND_PARTITIONED_TABLE, RELKIND_RELATION, RELKIND_SEQUENCE, RELKIND_VIEW, ResetPerTupleExprContext, ResultRelInfo::ri_FdwRoutine, ResultRelInfo::ri_NumIndices, ResultRelInfo::ri_PartitionCheck, ResultRelInfo::ri_RelationDesc, ResultRelInfo::ri_TrigDesc, HeapTupleData::t_len, HeapTupleData::t_self, HeapTupleData::t_tableOid, TransitionCaptureState::tcs_map, TransitionCaptureState::tcs_original_insert_tuple, ThereAreNoPriorRegisteredSnapshots(), ThereAreNoReadyPortals(), CopyStateData::transition_capture, CopyStateData::transition_tupconv_maps, TriggerDesc::trig_insert_before_row, TriggerDesc::trig_insert_instead_row, RelationData::trigdesc, values, CopyStateData::volatile_defexprs, and XLogIsNeeded.

Referenced by copy_table(), and DoCopy().

2281 {
2282  HeapTuple tuple;
2283  TupleDesc tupDesc;
2284  Datum *values;
2285  bool *nulls;
2286  ResultRelInfo *resultRelInfo;
2287  ResultRelInfo *saved_resultRelInfo = NULL;
2288  EState *estate = CreateExecutorState(); /* for ExecConstraints() */
2289  ExprContext *econtext;
2290  TupleTableSlot *myslot;
2291  MemoryContext oldcontext = CurrentMemoryContext;
2292 
2293  ErrorContextCallback errcallback;
2294  CommandId mycid = GetCurrentCommandId(true);
2295  int hi_options = 0; /* start with default heap_insert options */
2296  BulkInsertState bistate;
2297  uint64 processed = 0;
2298  bool useHeapMultiInsert;
2299  int nBufferedTuples = 0;
2300  int prev_leaf_part_index = -1;
2301 
2302 #define MAX_BUFFERED_TUPLES 1000
2303  HeapTuple *bufferedTuples = NULL; /* initialize to silence warning */
2304  Size bufferedTuplesSize = 0;
2305  int firstBufferedLineNo = 0;
2306 
2307  Assert(cstate->rel);
2308 
2309  /*
2310  * The target must be a plain relation or have an INSTEAD OF INSERT row
2311  * trigger. (Currently, such triggers are only allowed on views, so we
2312  * only hint about them in the view case.)
2313  */
2314  if (cstate->rel->rd_rel->relkind != RELKIND_RELATION &&
2315  cstate->rel->rd_rel->relkind != RELKIND_PARTITIONED_TABLE &&
2316  !(cstate->rel->trigdesc &&
2318  {
2319  if (cstate->rel->rd_rel->relkind == RELKIND_VIEW)
2320  ereport(ERROR,
2321  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2322  errmsg("cannot copy to view \"%s\"",
2323  RelationGetRelationName(cstate->rel)),
2324  errhint("To enable copying to a view, provide an INSTEAD OF INSERT trigger.")));
2325  else if (cstate->rel->rd_rel->relkind == RELKIND_MATVIEW)
2326  ereport(ERROR,
2327  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2328  errmsg("cannot copy to materialized view \"%s\"",
2329  RelationGetRelationName(cstate->rel))));
2330  else if (cstate->rel->rd_rel->relkind == RELKIND_FOREIGN_TABLE)
2331  ereport(ERROR,
2332  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2333  errmsg("cannot copy to foreign table \"%s\"",
2334  RelationGetRelationName(cstate->rel))));
2335  else if (cstate->rel->rd_rel->relkind == RELKIND_SEQUENCE)
2336  ereport(ERROR,
2337  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2338  errmsg("cannot copy to sequence \"%s\"",
2339  RelationGetRelationName(cstate->rel))));
2340  else
2341  ereport(ERROR,
2342  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
2343  errmsg("cannot copy to non-table relation \"%s\"",
2344  RelationGetRelationName(cstate->rel))));
2345  }
2346 
2347  tupDesc = RelationGetDescr(cstate->rel);
2348 
2349  /*----------
2350  * Check to see if we can avoid writing WAL
2351  *
2352  * If archive logging/streaming is not enabled *and* either
2353  * - table was created in same transaction as this COPY
2354  * - data is being written to relfilenode created in this transaction
2355  * then we can skip writing WAL. It's safe because if the transaction
2356  * doesn't commit, we'll discard the table (or the new relfilenode file).
2357  * If it does commit, we'll have done the heap_sync at the bottom of this
2358  * routine first.
2359  *
2360  * As mentioned in comments in utils/rel.h, the in-same-transaction test
2361  * is not always set correctly, since in rare cases rd_newRelfilenodeSubid
2362  * can be cleared before the end of the transaction. The exact case is
2363  * when a relation sets a new relfilenode twice in same transaction, yet
2364  * the second one fails in an aborted subtransaction, e.g.
2365  *
2366  * BEGIN;
2367  * TRUNCATE t;
2368  * SAVEPOINT save;
2369  * TRUNCATE t;
2370  * ROLLBACK TO save;
2371  * COPY ...
2372  *
2373  * Also, if the target file is new-in-transaction, we assume that checking
2374  * FSM for free space is a waste of time, even if we must use WAL because
2375  * of archiving. This could possibly be wrong, but it's unlikely.
2376  *
2377  * The comments for heap_insert and RelationGetBufferForTuple specify that
2378  * skipping WAL logging is only safe if we ensure that our tuples do not
2379  * go into pages containing tuples from any other transactions --- but this
2380  * must be the case if we have a new table or new relfilenode, so we need
2381  * no additional work to enforce that.
2382  *----------
2383  */
2384  /* createSubid is creation check, newRelfilenodeSubid is truncation check */
2385  if (cstate->rel->rd_createSubid != InvalidSubTransactionId ||
2387  {
2388  hi_options |= HEAP_INSERT_SKIP_FSM;
2389  if (!XLogIsNeeded())
2390  hi_options |= HEAP_INSERT_SKIP_WAL;
2391  }
2392 
2393  /*
2394  * Optimize if new relfilenode was created in this subxact or one of its
2395  * committed children and we won't see those rows later as part of an
2396  * earlier scan or command. The subxact test ensures that if this subxact
2397  * aborts then the frozen rows won't be visible after xact cleanup. Note
2398  * that the stronger test of exactly which subtransaction created it is
2399  * crucial for correctness of this optimization. The test for an earlier
2400  * scan or command tolerates false negatives. FREEZE causes other sessions
2401  * to see rows they would not see under MVCC, and a false negative merely
2402  * spreads that anomaly to the current session.
2403  */
2404  if (cstate->freeze)
2405  {
2406  /*
2407  * Tolerate one registration for the benefit of FirstXactSnapshot.
2408  * Scan-bearing queries generally create at least two registrations,
2409  * though relying on that is fragile, as is ignoring ActiveSnapshot.
2410  * Clear CatalogSnapshot to avoid counting its registration. We'll
2411  * still detect ongoing catalog scans, each of which separately
2412  * registers the snapshot it uses.
2413  */
2416  ereport(ERROR,
2417  (errcode(ERRCODE_INVALID_TRANSACTION_STATE),
2418  errmsg("cannot perform FREEZE because of prior transaction activity")));
2419 
2420  if (cstate->rel->rd_createSubid != GetCurrentSubTransactionId() &&
2422  ereport(ERROR,
2423  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
2424  errmsg("cannot perform FREEZE because the table was not created or truncated in the current subtransaction")));
2425 
2426  hi_options |= HEAP_INSERT_FROZEN;
2427  }
2428 
2429  /*
2430  * We need a ResultRelInfo so we can use the regular executor's
2431  * index-entry-making machinery. (There used to be a huge amount of code
2432  * here that basically duplicated execUtils.c ...)
2433  */
2434  resultRelInfo = makeNode(ResultRelInfo);
2435  InitResultRelInfo(resultRelInfo,
2436  cstate->rel,
2437  1, /* dummy rangetable index */
2438  NULL,
2439  0);
2440 
2441  ExecOpenIndices(resultRelInfo, false);
2442 
2443  estate->es_result_relations = resultRelInfo;
2444  estate->es_num_result_relations = 1;
2445  estate->es_result_relation_info = resultRelInfo;
2446  estate->es_range_table = cstate->range_table;
2447 
2448  /* Set up a tuple slot too */
2449  myslot = ExecInitExtraTupleSlot(estate);
2450  ExecSetSlotDescriptor(myslot, tupDesc);
2451  /* Triggers might need a slot as well */
2452  estate->es_trig_tuple_slot = ExecInitExtraTupleSlot(estate);
2453 
2454  /* Prepare to catch AFTER triggers. */
2456 
2457  /*
2458  * If there are any triggers with transition tables on the named relation,
2459  * we need to be prepared to capture transition tuples.
2460  */
2461  cstate->transition_capture =
2463  RelationGetRelid(cstate->rel),
2464  CMD_INSERT);
2465 
2466  /*
2467  * If the named relation is a partitioned table, initialize state for
2468  * CopyFrom tuple routing.
2469  */
2470  if (cstate->rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
2471  {
2472  PartitionTupleRouting *proute;
2473 
2474  proute = cstate->partition_tuple_routing =
2475  ExecSetupPartitionTupleRouting(NULL, cstate->rel, 1, estate);
2476 
2477  /*
2478  * If we are capturing transition tuples, they may need to be
2479  * converted from partition format back to partitioned table format
2480  * (this is only ever necessary if a BEFORE trigger modifies the
2481  * tuple).
2482  */
2483  if (cstate->transition_capture != NULL)
2484  {
2485  int i;
2486 
2488  palloc0(sizeof(TupleConversionMap *) * proute->num_partitions);
2489  for (i = 0; i < proute->num_partitions; ++i)
2490  {
2491  cstate->transition_tupconv_maps[i] =
2493  RelationGetDescr(cstate->rel),
2494  gettext_noop("could not convert row type"));
2495  }
2496  }
2497  }
2498 
2499  /*
2500  * It's more efficient to prepare a bunch of tuples for insertion, and
2501  * insert them in one heap_multi_insert() call, than call heap_insert()
2502  * separately for every tuple. However, we can't do that if there are
2503  * BEFORE/INSTEAD OF triggers, or we need to evaluate volatile default
2504  * expressions. Such triggers or expressions might query the table we're
2505  * inserting to, and act differently if the tuples that have already been
2506  * processed and prepared for insertion are not there. We also can't do
2507  * it if the table is partitioned.
2508  */
2509  if ((resultRelInfo->ri_TrigDesc != NULL &&
2510  (resultRelInfo->ri_TrigDesc->trig_insert_before_row ||
2511  resultRelInfo->ri_TrigDesc->trig_insert_instead_row)) ||
2512  cstate->partition_tuple_routing != NULL ||
2513  cstate->volatile_defexprs)
2514  {
2515  useHeapMultiInsert = false;
2516  }
2517  else
2518  {
2519  useHeapMultiInsert = true;
2520  bufferedTuples = palloc(MAX_BUFFERED_TUPLES * sizeof(HeapTuple));
2521  }
2522 
2523  /*
2524  * Check BEFORE STATEMENT insertion triggers. It's debatable whether we
2525  * should do this for COPY, since it's not really an "INSERT" statement as
2526  * such. However, executing these triggers maintains consistency with the
2527  * EACH ROW triggers that we already fire on COPY.
2528  */
2529  ExecBSInsertTriggers(estate, resultRelInfo);
2530 
2531  values = (Datum *) palloc(tupDesc->natts * sizeof(Datum));
2532  nulls = (bool *) palloc(tupDesc->natts * sizeof(bool));
2533 
2534  bistate = GetBulkInsertState();
2535  econtext = GetPerTupleExprContext(estate);
2536 
2537  /* Set up callback to identify error line number */
2538  errcallback.callback = CopyFromErrorCallback;
2539  errcallback.arg = (void *) cstate;
2540  errcallback.previous = error_context_stack;
2541  error_context_stack = &errcallback;
2542 
2543  for (;;)
2544  {
2545  TupleTableSlot *slot;
2546  bool skip_tuple;
2547  Oid loaded_oid = InvalidOid;
2548 
2550 
2551  if (nBufferedTuples == 0)
2552  {
2553  /*
2554  * Reset the per-tuple exprcontext. We can only do this if the
2555  * tuple buffer is empty. (Calling the context the per-tuple
2556  * memory context is a bit of a misnomer now.)
2557  */
2558  ResetPerTupleExprContext(estate);
2559  }
2560 
2561  /* Switch into its memory context */
2563 
2564  if (!NextCopyFrom(cstate, econtext, values, nulls, &loaded_oid))
2565  break;
2566 
2567  /* And now we can form the input tuple. */
2568  tuple = heap_form_tuple(tupDesc, values, nulls);
2569 
2570  if (loaded_oid != InvalidOid)
2571  HeapTupleSetOid(tuple, loaded_oid);
2572 
2573  /*
2574  * Constraints might reference the tableoid column, so initialize
2575  * t_tableOid before evaluating them.
2576  */
2577  tuple->t_tableOid = RelationGetRelid(resultRelInfo->ri_RelationDesc);
2578 
2579  /* Triggers and stuff need to be invoked in query context. */
2580  MemoryContextSwitchTo(oldcontext);
2581 
2582  /* Place tuple in tuple slot --- but slot shouldn't free it */
2583  slot = myslot;
2584  ExecStoreTuple(tuple, slot, InvalidBuffer, false);
2585 
2586  /* Determine the partition to heap_insert the tuple into */
2587  if (cstate->partition_tuple_routing)
2588  {
2589  int leaf_part_index;
2590  TupleConversionMap *map;
2592 
2593  /*
2594  * Away we go ... If we end up not finding a partition after all,
2595  * ExecFindPartition() does not return and errors out instead.
2596  * Otherwise, the returned value is to be used as an index into
2597  * arrays mt_partitions[] and mt_partition_tupconv_maps[] that
2598  * will get us the ResultRelInfo and TupleConversionMap for the
2599  * partition, respectively.
2600  */
2601  leaf_part_index = ExecFindPartition(resultRelInfo,
2602  proute->partition_dispatch_info,
2603  slot,
2604  estate);
2605  Assert(leaf_part_index >= 0 &&
2606  leaf_part_index < proute->num_partitions);
2607 
2608  /*
2609  * If this tuple is mapped to a partition that is not same as the
2610  * previous one, we'd better make the bulk insert mechanism gets a
2611  * new buffer.
2612  */
2613  if (prev_leaf_part_index != leaf_part_index)
2614  {
2615  ReleaseBulkInsertStatePin(bistate);
2616  prev_leaf_part_index = leaf_part_index;
2617  }
2618 
2619  /*
2620  * Save the old ResultRelInfo and switch to the one corresponding
2621  * to the selected partition.
2622  */
2623  saved_resultRelInfo = resultRelInfo;
2624  resultRelInfo = proute->partitions[leaf_part_index];
2625 
2626  /* We do not yet have a way to insert into a foreign partition */
2627  if (resultRelInfo->ri_FdwRoutine)
2628  ereport(ERROR,
2629  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2630  errmsg("cannot route inserted tuples to a foreign table")));
2631 
2632  /*
2633  * For ExecInsertIndexTuples() to work on the partition's indexes
2634  */
2635  estate->es_result_relation_info = resultRelInfo;
2636 
2637  /*
2638  * If we're capturing transition tuples, we might need to convert
2639  * from the partition rowtype to parent rowtype.
2640  */
2641  if (cstate->transition_capture != NULL)
2642  {
2643  if (resultRelInfo->ri_TrigDesc &&
2644  (resultRelInfo->ri_TrigDesc->trig_insert_before_row ||
2645  resultRelInfo->ri_TrigDesc->trig_insert_instead_row))
2646  {
2647  /*
2648  * If there are any BEFORE or INSTEAD triggers on the
2649  * partition, we'll have to be ready to convert their
2650  * result back to tuplestore format.
2651  */
2653  cstate->transition_capture->tcs_map =
2654  cstate->transition_tupconv_maps[leaf_part_index];
2655  }
2656  else
2657  {
2658  /*
2659  * Otherwise, just remember the original unconverted
2660  * tuple, to avoid a needless round trip conversion.
2661  */
2663  cstate->transition_capture->tcs_map = NULL;
2664  }
2665  }
2666 
2667  /*
2668  * We might need to convert from the parent rowtype to the
2669  * partition rowtype.
2670  */
2671  map = proute->partition_tupconv_maps[leaf_part_index];
2672  if (map)
2673  {
2674  Relation partrel = resultRelInfo->ri_RelationDesc;
2675 
2676  tuple = do_convert_tuple(tuple, map);
2677 
2678  /*
2679  * We must use the partition's tuple descriptor from this
2680  * point on. Use a dedicated slot from this point on until
2681  * we're finished dealing with the partition.
2682  */
2683  slot = proute->partition_tuple_slot;
2684  Assert(slot != NULL);
2685  ExecSetSlotDescriptor(slot, RelationGetDescr(partrel));
2686  ExecStoreTuple(tuple, slot, InvalidBuffer, true);
2687  }
2688 
2689  tuple->t_tableOid = RelationGetRelid(resultRelInfo->ri_RelationDesc);
2690  }
2691 
2692  skip_tuple = false;
2693 
2694  /* BEFORE ROW INSERT Triggers */
2695  if (resultRelInfo->ri_TrigDesc &&
2696  resultRelInfo->ri_TrigDesc->trig_insert_before_row)
2697  {
2698  slot = ExecBRInsertTriggers(estate, resultRelInfo, slot);
2699 
2700  if (slot == NULL) /* "do nothing" */
2701  skip_tuple = true;
2702  else /* trigger might have changed tuple */
2703  tuple = ExecMaterializeSlot(slot);
2704  }
2705 
2706  if (!skip_tuple)
2707  {
2708  if (resultRelInfo->ri_TrigDesc &&
2709  resultRelInfo->ri_TrigDesc->trig_insert_instead_row)
2710  {
2711  /* Pass the data to the INSTEAD ROW INSERT trigger */
2712  ExecIRInsertTriggers(estate, resultRelInfo, slot);
2713  }
2714  else
2715  {
2716  /*
2717  * We always check the partition constraint, including when
2718  * the tuple got here via tuple-routing. However we don't
2719  * need to in the latter case if no BR trigger is defined on
2720  * the partition. Note that a BR trigger might modify the
2721  * tuple such that the partition constraint is no longer
2722  * satisfied, so we need to check in that case.
2723  */
2724  bool check_partition_constr =
2725  (resultRelInfo->ri_PartitionCheck != NIL);
2726 
2727  if (saved_resultRelInfo != NULL &&
2728  !(resultRelInfo->ri_TrigDesc &&
2729  resultRelInfo->ri_TrigDesc->trig_insert_before_row))
2730  check_partition_constr = false;
2731 
2732  /* Check the constraints of the tuple */
2733  if (cstate->rel->rd_att->constr || check_partition_constr)
2734  ExecConstraints(resultRelInfo, slot, estate, true);
2735 
2736  if (useHeapMultiInsert)
2737  {
2738  /* Add this tuple to the tuple buffer */
2739  if (nBufferedTuples == 0)
2740  firstBufferedLineNo = cstate->cur_lineno;
2741  bufferedTuples[nBufferedTuples++] = tuple;
2742  bufferedTuplesSize += tuple->t_len;
2743 
2744  /*
2745  * If the buffer filled up, flush it. Also flush if the
2746  * total size of all the tuples in the buffer becomes
2747  * large, to avoid using large amounts of memory for the
2748  * buffer when the tuples are exceptionally wide.
2749  */
2750  if (nBufferedTuples == MAX_BUFFERED_TUPLES ||
2751  bufferedTuplesSize > 65535)
2752  {
2753  CopyFromInsertBatch(cstate, estate, mycid, hi_options,
2754  resultRelInfo, myslot, bistate,
2755  nBufferedTuples, bufferedTuples,
2756  firstBufferedLineNo);
2757  nBufferedTuples = 0;
2758  bufferedTuplesSize = 0;
2759  }
2760  }
2761  else
2762  {
2763  List *recheckIndexes = NIL;
2764 
2765  /* OK, store the tuple and create index entries for it */
2766  heap_insert(resultRelInfo->ri_RelationDesc, tuple, mycid,
2767  hi_options, bistate);
2768 
2769  if (resultRelInfo->ri_NumIndices > 0)
2770  recheckIndexes = ExecInsertIndexTuples(slot,
2771  &(tuple->t_self),
2772  estate,
2773  false,
2774  NULL,
2775  NIL);
2776 
2777  /* AFTER ROW INSERT Triggers */
2778  ExecARInsertTriggers(estate, resultRelInfo, tuple,
2779  recheckIndexes, cstate->transition_capture);
2780 
2781  list_free(recheckIndexes);
2782  }
2783  }
2784 
2785  /*
2786  * We count only tuples not suppressed by a BEFORE INSERT trigger;
2787  * this is the same definition used by execMain.c for counting
2788  * tuples inserted by an INSERT command.
2789  */
2790  processed++;
2791 
2792  if (saved_resultRelInfo)
2793  {
2794  resultRelInfo = saved_resultRelInfo;
2795  estate->es_result_relation_info = resultRelInfo;
2796  }
2797  }
2798  }
2799 
2800  /* Flush any remaining buffered tuples */
2801  if (nBufferedTuples > 0)
2802  CopyFromInsertBatch(cstate, estate, mycid, hi_options,
2803  resultRelInfo, myslot, bistate,
2804  nBufferedTuples, bufferedTuples,
2805  firstBufferedLineNo);
2806 
2807  /* Done, clean up */
2808  error_context_stack = errcallback.previous;
2809 
2810  FreeBulkInsertState(bistate);
2811 
2812  MemoryContextSwitchTo(oldcontext);
2813 
2814  /*
2815  * In the old protocol, tell pqcomm that we can process normal protocol
2816  * messages again.
2817  */
2818  if (cstate->copy_dest == COPY_OLD_FE)
2819  pq_endmsgread();
2820 
2821  /* Execute AFTER STATEMENT insertion triggers */
2822  ExecASInsertTriggers(estate, resultRelInfo, cstate->transition_capture);
2823 
2824  /* Handle queued AFTER triggers */
2825  AfterTriggerEndQuery(estate);
2826 
2827  pfree(values);
2828  pfree(nulls);
2829 
2830  ExecResetTupleTable(estate->es_tupleTable, false);
2831 
2832  ExecCloseIndices(resultRelInfo);
2833 
2834  /* Close all the partitioned tables, leaf partitions, and their indices */
2835  if (cstate->partition_tuple_routing)
2837 
2838  /* Close any trigger target relations */
2839  ExecCleanUpTriggerState(estate);
2840 
2841  FreeExecutorState(estate);
2842 
2843  /*
2844  * If we skipped writing WAL, then we need to sync the heap (but not
2845  * indexes since those use WAL anyway)
2846  */
2847  if (hi_options & HEAP_INSERT_SKIP_WAL)
2848  heap_sync(cstate->rel);
2849 
2850  return processed;
2851 }
int ri_NumIndices
Definition: execnodes.h:368
#define NIL
Definition: pg_list.h:69
uint32 CommandId
Definition: c.h:469
int ExecFindPartition(ResultRelInfo *resultRelInfo, PartitionDispatch *pd, TupleTableSlot *slot, EState *estate)
TupleTableSlot * ExecStoreTuple(HeapTuple tuple, TupleTableSlot *slot, Buffer buffer, bool shouldFree)
Definition: execTuples.c:320
void InitResultRelInfo(ResultRelInfo *resultRelInfo, Relation resultRelationDesc, Index resultRelationIndex, Relation partition_root, int instrument_options)
Definition: execMain.c:1306
Relation ri_RelationDesc
Definition: execnodes.h:365
List * range_table
Definition: copy.c:167
TupleTableSlot * ExecInitExtraTupleSlot(EState *estate)
Definition: execTuples.c:852
int errhint(const char *fmt,...)
Definition: elog.c:987
void CopyFromErrorCallback(void *arg)
Definition: copy.c:2175
List * ExecInsertIndexTuples(TupleTableSlot *slot, ItemPointer tupleid, EState *estate, bool noDupErr, bool *specConflict, List *arbiterIndexes)
Definition: execIndexing.c:271
#define ResetPerTupleExprContext(estate)
Definition: executor.h:483
#define RelationGetDescr(relation)
Definition: rel.h:437
#define HEAP_INSERT_FROZEN
Definition: heapam.h:30
TupleConversionMap ** partition_tupconv_maps
Definition: execPartition.h:82
#define XLogIsNeeded()
Definition: xlog.h:146
#define MAX_BUFFERED_TUPLES
TupleTableSlot * ExecIRInsertTriggers(EState *estate, ResultRelInfo *relinfo, TupleTableSlot *slot)
Definition: trigger.c:2369
#define RELKIND_MATVIEW
Definition: pg_class.h:165
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define InvalidBuffer
Definition: buf.h:25
#define gettext_noop(x)
Definition: c.h:1005
PartitionTupleRouting * ExecSetupPartitionTupleRouting(ModifyTableState *mtstate, Relation rel, Index resultRTindex, EState *estate)
Definition: execPartition.c:49
bool ThereAreNoPriorRegisteredSnapshots(void)
Definition: snapmgr.c:1655
int errcode(int sqlerrcode)
Definition: elog.c:575
SubTransactionId rd_newRelfilenodeSubid
Definition: rel.h:111
void ExecARInsertTriggers(EState *estate, ResultRelInfo *relinfo, HeapTuple trigtuple, List *recheckIndexes, TransitionCaptureState *transition_capture)
Definition: trigger.c:2354
void heap_sync(Relation rel)
Definition: heapam.c:9209
#define HEAP_INSERT_SKIP_WAL
Definition: heapam.h:28
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:695
TupleTableSlot * partition_tuple_slot
Definition: execPartition.h:83
List * es_range_table
Definition: execnodes.h:442
Form_pg_class rd_rel
Definition: rel.h:114
unsigned int Oid
Definition: postgres_ext.h:31
void ExecConstraints(ResultRelInfo *resultRelInfo, TupleTableSlot *slot, EState *estate, bool check_partition_constraint)
Definition: execMain.c:1954
bool volatile_defexprs
Definition: copy.c:166
void(* callback)(void *arg)
Definition: elog.h:239
struct ErrorContextCallback * previous
Definition: elog.h:238
int natts
Definition: tupdesc.h:79
HeapTuple tcs_original_insert_tuple
Definition: trigger.h:82
ResultRelInfo ** partitions
Definition: execPartition.h:80
void ExecOpenIndices(ResultRelInfo *resultRelInfo, bool speculative)
Definition: execIndexing.c:149
CopyDest copy_dest
Definition: copy.c:99
#define HeapTupleSetOid(tuple, oid)
Definition: htup_details.h:703
ErrorContextCallback * error_context_stack
Definition: elog.c:88
bool trig_insert_instead_row
Definition: reltrigger.h:57
void FreeExecutorState(EState *estate)
Definition: execUtils.c:186
Relation rel
Definition: copy.c:110
#define GetPerTupleExprContext(estate)
Definition: executor.h:474
BulkInsertState GetBulkInsertState(void)
Definition: heapam.c:2336
void pfree(void *pointer)
Definition: mcxt.c:936
bool ThereAreNoReadyPortals(void)
Definition: portalmem.c:1147
#define ERROR
Definition: elog.h:43
static void CopyFromInsertBatch(CopyState cstate, EState *estate, CommandId mycid, int hi_options, ResultRelInfo *resultRelInfo, TupleTableSlot *myslot, BulkInsertState bistate, int nBufferedTuples, HeapTuple *bufferedTuples, int firstBufferedLineNo)
Definition: copy.c:2859
TupleConversionMap * tcs_map
Definition: trigger.h:73
ItemPointerData t_self
Definition: htup.h:65
TriggerDesc * trigdesc
Definition: rel.h:120
uint32 t_len
Definition: htup.h:64
void ExecBSInsertTriggers(EState *estate, ResultRelInfo *relinfo)
Definition: trigger.c:2220
ResultRelInfo * es_result_relations
Definition: execnodes.h:452
#define RelationGetRelationName(relation)
Definition: rel.h:445
struct FdwRoutine * ri_FdwRoutine
Definition: execnodes.h:389
Oid t_tableOid
Definition: htup.h:66
PartitionDispatch * partition_dispatch_info
Definition: execPartition.h:78
#define RELKIND_FOREIGN_TABLE
Definition: pg_class.h:167
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
TupleTableSlot * es_trig_tuple_slot
Definition: execnodes.h:471
#define ereport(elevel, rest)
Definition: elog.h:122
Oid heap_insert(Relation relation, HeapTuple tup, CommandId cid, int options, BulkInsertState bistate)
Definition: heapam.c:2413
void InvalidateCatalogSnapshot(void)
Definition: snapmgr.c:510
TriggerDesc * ri_TrigDesc
Definition: execnodes.h:377
EState * CreateExecutorState(void)
Definition: execUtils.c:81
TupleConversionMap * convert_tuples_by_name(TupleDesc indesc, TupleDesc outdesc, const char *msg)
Definition: tupconvert.c:210
TupleConversionMap ** transition_tupconv_maps
Definition: copy.c:173
SubTransactionId rd_createSubid
Definition: rel.h:110
#define RELKIND_PARTITIONED_TABLE
Definition: pg_class.h:168
bool trig_insert_before_row
Definition: reltrigger.h:55
List * es_tupleTable
Definition: execnodes.h:484
void ExecResetTupleTable(List *tupleTable, bool shouldFree)
Definition: execTuples.c:156
void * palloc0(Size size)
Definition: mcxt.c:864
void ExecASInsertTriggers(EState *estate, ResultRelInfo *relinfo, TransitionCaptureState *transition_capture)
Definition: trigger.c:2277
uintptr_t Datum
Definition: postgres.h:372
void ExecSetSlotDescriptor(TupleTableSlot *slot, TupleDesc tupdesc)
Definition: execTuples.c:247
TransitionCaptureState * MakeTransitionCaptureState(TriggerDesc *trigdesc, Oid relid, CmdType cmdType)
Definition: trigger.c:4404
int es_num_result_relations
Definition: execnodes.h:453
List * ri_PartitionCheck
Definition: execnodes.h:419
TupleDesc rd_att
Definition: rel.h:115
bool freeze
Definition: copy.c:118
void ExecCleanupTupleRouting(PartitionTupleRouting *proute)
void pq_endmsgread(void)
Definition: pqcomm.c:1234
#define InvalidOid
Definition: postgres_ext.h:36
PartitionTupleRouting * partition_tuple_routing
Definition: copy.c:170
void AfterTriggerBeginQuery(void)
Definition: trigger.c:4526
#define makeNode(_type_)
Definition: nodes.h:560
#define Assert(condition)
Definition: c.h:680
void FreeBulkInsertState(BulkInsertState bistate)
Definition: heapam.c:2350
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:642
TupleConstr * constr
Definition: tupdesc.h:84
size_t Size
Definition: c.h:414
#define InvalidSubTransactionId
Definition: c.h:461
HeapTuple ExecMaterializeSlot(TupleTableSlot *slot)
Definition: execTuples.c:725
void ReleaseBulkInsertStatePin(BulkInsertState bistate)
Definition: heapam.c:2362
HeapTuple do_convert_tuple(HeapTuple tuple, TupleConversionMap *map)
Definition: tupconvert.c:354
#define GetPerTupleMemoryContext(estate)
Definition: executor.h:479
void ExecCleanUpTriggerState(EState *estate)
Definition: execMain.c:1466
#define HEAP_INSERT_SKIP_FSM
Definition: heapam.h:29
static Datum values[MAXATTR]
Definition: bootstrap.c:164
void AfterTriggerEndQuery(EState *estate)
Definition: trigger.c:4546
void * palloc(Size size)
Definition: mcxt.c:835
int errmsg(const char *fmt,...)
Definition: elog.c:797
#define RELKIND_VIEW
Definition: pg_class.h:164
void list_free(List *list)
Definition: list.c:1133
bool NextCopyFrom(CopyState cstate, ExprContext *econtext, Datum *values, bool *nulls, Oid *tupleOid)
Definition: copy.c:3265
int i
int cur_lineno
Definition: copy.c:140
TransitionCaptureState * transition_capture
Definition: copy.c:172
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:98
TupleTableSlot * ExecBRInsertTriggers(EState *estate, ResultRelInfo *relinfo, TupleTableSlot *slot)
Definition: trigger.c:2288
CommandId GetCurrentCommandId(bool used)
Definition: xact.c:680
#define RELKIND_RELATION
Definition: pg_class.h:160
#define RELKIND_SEQUENCE
Definition: pg_class.h:162
Definition: pg_list.h:45
#define RelationGetRelid(relation)
Definition: rel.h:425
void ExecCloseIndices(ResultRelInfo *resultRelInfo)
Definition: execIndexing.c:224
ResultRelInfo * es_result_relation_info
Definition: execnodes.h:454

◆ CopyFromErrorCallback()

void CopyFromErrorCallback ( void *  arg)

Definition at line 2175 of file copy.c.

References CopyStateData::binary, CopyStateData::cur_attname, CopyStateData::cur_attval, CopyStateData::cur_lineno, CopyStateData::cur_relname, StringInfoData::data, errcontext, limit_printout_length(), CopyStateData::line_buf, CopyStateData::line_buf_converted, CopyStateData::line_buf_valid, CopyStateData::need_transcoding, and pfree().

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

2176 {
2177  CopyState cstate = (CopyState) arg;
2178 
2179  if (cstate->binary)
2180  {
2181  /* can't usefully display the data */
2182  if (cstate->cur_attname)
2183  errcontext("COPY %s, line %d, column %s",
2184  cstate->cur_relname, cstate->cur_lineno,
2185  cstate->cur_attname);
2186  else
2187  errcontext("COPY %s, line %d",
2188  cstate->cur_relname, cstate->cur_lineno);
2189  }
2190  else
2191  {
2192  if (cstate->cur_attname && cstate->cur_attval)
2193  {
2194  /* error is relevant to a particular column */
2195  char *attval;
2196 
2197  attval = limit_printout_length(cstate->cur_attval);
2198  errcontext("COPY %s, line %d, column %s: \"%s\"",
2199  cstate->cur_relname, cstate->cur_lineno,
2200  cstate->cur_attname, attval);
2201  pfree(attval);
2202  }
2203  else if (cstate->cur_attname)
2204  {
2205  /* error is relevant to a particular column, value is NULL */
2206  errcontext("COPY %s, line %d, column %s: null input",
2207  cstate->cur_relname, cstate->cur_lineno,
2208  cstate->cur_attname);
2209  }
2210  else
2211  {
2212  /*
2213  * Error is relevant to a particular line.
2214  *
2215  * If line_buf still contains the correct line, and it's already
2216  * transcoded, print it. If it's still in a foreign encoding, it's
2217  * quite likely that the error is precisely a failure to do
2218  * encoding conversion (ie, bad data). We dare not try to convert
2219  * it, and at present there's no way to regurgitate it without
2220  * conversion. So we have to punt and just report the line number.
2221  */
2222  if (cstate->line_buf_valid &&
2223  (cstate->line_buf_converted || !cstate->need_transcoding))
2224  {
2225  char *lineval;
2226 
2227  lineval = limit_printout_length(cstate->line_buf.data);
2228  errcontext("COPY %s, line %d: \"%s\"",
2229  cstate->cur_relname, cstate->cur_lineno, lineval);
2230  pfree(lineval);
2231  }
2232  else
2233  {
2234  errcontext("COPY %s, line %d",
2235  cstate->cur_relname, cstate->cur_lineno);
2236  }
2237  }
2238  }
2239 }
bool binary
Definition: copy.c:116
bool need_transcoding
Definition: copy.c:106
StringInfoData line_buf
Definition: copy.c:197
bool line_buf_valid
Definition: copy.c:199
bool line_buf_converted
Definition: copy.c:198
const char * cur_attname
Definition: copy.c:141
void pfree(void *pointer)
Definition: mcxt.c:936
static char * limit_printout_length(const char *str)
Definition: copy.c:2251
const char * cur_relname
Definition: copy.c:139
#define errcontext
Definition: elog.h:164
struct CopyStateData * CopyState
Definition: copy.h:23
void * arg
int cur_lineno
Definition: copy.c:140
const char * cur_attval
Definition: copy.c:142

◆ CreateCopyDestReceiver()

DestReceiver* CreateCopyDestReceiver ( void  )

Definition at line 4817 of file copy.c.

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

Referenced by CreateDestReceiver().

4818 {
4819  DR_copy *self = (DR_copy *) palloc(sizeof(DR_copy));
4820 
4821  self->pub.receiveSlot = copy_dest_receive;
4822  self->pub.rStartup = copy_dest_startup;
4823  self->pub.rShutdown = copy_dest_shutdown;
4824  self->pub.rDestroy = copy_dest_destroy;
4825  self->pub.mydest = DestCopyOut;
4826 
4827  self->cstate = NULL; /* will be set later */
4828  self->processed = 0;
4829 
4830  return (DestReceiver *) self;
4831 }
Definition: copy.c:215
static void copy_dest_destroy(DestReceiver *self)
Definition: copy.c:4808
static void copy_dest_shutdown(DestReceiver *self)
Definition: copy.c:4799
static void copy_dest_startup(DestReceiver *self, int operation, TupleDesc typeinfo)
Definition: copy.c:4771
static bool copy_dest_receive(TupleTableSlot *slot, DestReceiver *self)
Definition: copy.c:4780
void * palloc(Size size)
Definition: mcxt.c:835

◆ DoCopy()

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

Definition at line 781 of file copy.c.

References AccessShareLock, ACL_INSERT, ACL_SELECT, addRangeTableEntryForRelation(), Assert, CopyStmt::attlist, BeginCopyFrom(), BeginCopyTo(), bms_add_member(), check_enable_rls(), CopyFrom(), CopyGetAttnums(), cur, DoCopyTo(), EndCopyFrom(), EndCopyTo(), ereport, errcode(), errhint(), errmsg(), ERROR, ExecCheckRTPerms(), ColumnRef::fields, CopyStmt::filename, FirstLowInvalidHeapAttributeNumber, SelectStmt::fromClause, get_namespace_name(), heap_close, heap_openrv(), ResTarget::indirection, RangeTblEntry::insertedCols, InvalidOid, CopyStmt::is_from, CopyStmt::is_program, lappend(), lfirst, lfirst_int, list_make1, ColumnRef::location, ResTarget::location, makeNode, makeRangeVar(), ResTarget::name, NIL, NoLock, CopyStmt::options, ParseState::p_rtable, PreventCommandIfParallelMode(), PreventCommandIfReadOnly(), pstrdup(), CopyStmt::query, RelationData::rd_islocaltemp, CopyStateData::rel, CopyStmt::relation, RelationGetDescr, RelationGetNamespace, RelationGetRelationName, RelationGetRelid, RangeTblEntry::relid, RangeTblEntry::requiredPerms, RLS_ENABLED, RowExclusiveLock, select, RangeTblEntry::selectedCols, RawStmt::stmt, RawStmt::stmt_len, RawStmt::stmt_location, superuser(), SelectStmt::targetList, ResTarget::val, and XactReadOnly.

Referenced by standard_ProcessUtility().

784 {
785  CopyState cstate;
786  bool is_from = stmt->is_from;
787  bool pipe = (stmt->filename == NULL);
788  Relation rel;
789  Oid relid;
790  RawStmt *query = NULL;
791 
792  /* Disallow COPY to/from file or program except to superusers. */
793  if (!pipe && !superuser())
794  {
795  if (stmt->is_program)
796  ereport(ERROR,
797  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
798  errmsg("must be superuser to COPY to or from an external program"),
799  errhint("Anyone can COPY to stdout or from stdin. "
800  "psql's \\copy command also works for anyone.")));
801  else
802  ereport(ERROR,
803  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
804  errmsg("must be superuser to COPY to or from a file"),
805  errhint("Anyone can COPY to stdout or from stdin. "
806  "psql's \\copy command also works for anyone.")));
807  }
808 
809  if (stmt->relation)
810  {
811  TupleDesc tupDesc;
812  List *attnums;
813  ListCell *cur;
814  RangeTblEntry *rte;
815 
816  Assert(!stmt->query);
817 
818  /* Open and lock the relation, using the appropriate lock type. */
819  rel = heap_openrv(stmt->relation,
820  (is_from ? RowExclusiveLock : AccessShareLock));
821 
822  relid = RelationGetRelid(rel);
823 
824  rte = addRangeTableEntryForRelation(pstate, rel, NULL, false, false);
825  rte->requiredPerms = (is_from ? ACL_INSERT : ACL_SELECT);
826 
827  tupDesc = RelationGetDescr(rel);
828  attnums = CopyGetAttnums(tupDesc, rel, stmt->attlist);
829  foreach(cur, attnums)
830  {
831  int attno = lfirst_int(cur) -
833 
834  if (is_from)
835  rte->insertedCols = bms_add_member(rte->insertedCols, attno);
836  else
837  rte->selectedCols = bms_add_member(rte->selectedCols, attno);
838  }
839  ExecCheckRTPerms(pstate->p_rtable, true);
840 
841  /*
842  * Permission check for row security policies.
843  *
844  * check_enable_rls will ereport(ERROR) if the user has requested
845  * something invalid and will otherwise indicate if we should enable
846  * RLS (returns RLS_ENABLED) or not for this COPY statement.
847  *
848  * If the relation has a row security policy and we are to apply it
849  * then perform a "query" copy and allow the normal query processing
850  * to handle the policies.
851  *
852  * If RLS is not enabled for this, then just fall through to the
853  * normal non-filtering relation handling.
854  */
855  if (check_enable_rls(rte->relid, InvalidOid, false) == RLS_ENABLED)
856  {
858  ColumnRef *cr;
859  ResTarget *target;
860  RangeVar *from;
861  List *targetList = NIL;
862 
863  if (is_from)
864  ereport(ERROR,
865  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
866  errmsg("COPY FROM not supported with row-level security"),
867  errhint("Use INSERT statements instead.")));
868 
869  /*
870  * Build target list
871  *
872  * If no columns are specified in the attribute list of the COPY
873  * command, then the target list is 'all' columns. Therefore, '*'
874  * should be used as the target list for the resulting SELECT
875  * statement.
876  *
877  * In the case that columns are specified in the attribute list,
878  * create a ColumnRef and ResTarget for each column and add them
879  * to the target list for the resulting SELECT statement.
880  */
881  if (!stmt->attlist)
882  {
883  cr = makeNode(ColumnRef);
885  cr->location = -1;
886 
887  target = makeNode(ResTarget);
888  target->name = NULL;
889  target->indirection = NIL;
890  target->val = (Node *) cr;
891  target->location = -1;
892 
893  targetList = list_make1(target);
894  }
895  else
896  {
897  ListCell *lc;
898 
899  foreach(lc, stmt->attlist)
900  {
901  /*
902  * Build the ColumnRef for each column. The ColumnRef
903  * 'fields' property is a String 'Value' node (see
904  * nodes/value.h) that corresponds to the column name
905  * respectively.
906  */
907  cr = makeNode(ColumnRef);
908  cr->fields = list_make1(lfirst(lc));
909  cr->location = -1;
910 
911  /* Build the ResTarget and add the ColumnRef to it. */
912  target = makeNode(ResTarget);
913  target->name = NULL;
914  target->indirection = NIL;
915  target->val = (Node *) cr;
916  target->location = -1;
917 
918  /* Add each column to the SELECT statement's target list */
919  targetList = lappend(targetList, target);
920  }
921  }
922 
923  /*
924  * Build RangeVar for from clause, fully qualified based on the
925  * relation which we have opened and locked.
926  */
929  -1);
930 
931  /* Build query */
932  select = makeNode(SelectStmt);
933  select->targetList = targetList;
934  select->fromClause = list_make1(from);
935 
936  query = makeNode(RawStmt);
937  query->stmt = (Node *) select;
938  query->stmt_location = stmt_location;
939  query->stmt_len = stmt_len;
940 
941  /*
942  * Close the relation for now, but keep the lock on it to prevent
943  * changes between now and when we start the query-based COPY.
944  *
945  * We'll reopen it later as part of the query-based COPY.
946  */
947  heap_close(rel, NoLock);
948  rel = NULL;
949  }
950  }
951  else
952  {
953  Assert(stmt->query);
954 
955  query = makeNode(RawStmt);
956  query->stmt = stmt->query;
957  query->stmt_location = stmt_location;
958  query->stmt_len = stmt_len;
959 
960  relid = InvalidOid;
961  rel = NULL;
962  }
963 
964  if (is_from)
965  {
966  Assert(rel);
967 
968  /* check read-only transaction and parallel mode */
969  if (XactReadOnly && !rel->rd_islocaltemp)
970  PreventCommandIfReadOnly("COPY FROM");
971  PreventCommandIfParallelMode("COPY FROM");
972 
973  cstate = BeginCopyFrom(pstate, rel, stmt->filename, stmt->is_program,
974  NULL, stmt->attlist, stmt->options);
975  *processed = CopyFrom(cstate); /* copy from file to database */
976  EndCopyFrom(cstate);
977  }
978  else
979  {
980  cstate = BeginCopyTo(pstate, rel, query, relid,
981  stmt->filename, stmt->is_program,
982  stmt->attlist, stmt->options);
983  *processed = DoCopyTo(cstate); /* copy from database to file */
984  EndCopyTo(cstate);
985  }
986 
987  /*
988  * Close the relation. If reading, we can release the AccessShareLock we
989  * got; if writing, we should hold the lock until end of transaction to
990  * ensure that updates will be committed before lock is released.
991  */
992  if (rel != NULL)
993  heap_close(rel, (is_from ? NoLock : AccessShareLock));
994 }
List * indirection
Definition: parsenodes.h:440
#define NIL
Definition: pg_list.h:69
Node * val
Definition: parsenodes.h:441
int errhint(const char *fmt,...)
Definition: elog.c:987
void PreventCommandIfParallelMode(const char *cmdname)
Definition: utility.c:254
List * attlist
Definition: parsenodes.h:1956
List * fromClause
Definition: parsenodes.h:1521
#define RelationGetDescr(relation)
Definition: rel.h:437
char * name
Definition: parsenodes.h:439
CopyState BeginCopyFrom(ParseState *pstate, Relation rel, const char *filename, bool is_program, copy_data_source_cb data_source_cb, List *attnamelist, List *options)
Definition: copy.c:2943
char * pstrdup(const char *in)
Definition: mcxt.c:1063
bool rd_islocaltemp
Definition: rel.h:90
#define AccessShareLock
Definition: lockdefs.h:36
Definition: nodes.h:512
struct cursor * cur
Definition: ecpg.c:28
int errcode(int sqlerrcode)
Definition: elog.c:575
bool superuser(void)
Definition: superuser.c:47
uint64 CopyFrom(CopyState cstate)
Definition: copy.c:2280
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:28
AclMode requiredPerms
Definition: parsenodes.h:1059
#define heap_close(r, l)
Definition: heapam.h:97
unsigned int Oid
Definition: postgres_ext.h:31
bool is_program
Definition: parsenodes.h:1959
int location
Definition: parsenodes.h:235
int location
Definition: parsenodes.h:442
#define list_make1(x1)
Definition: pg_list.h:139
Bitmapset * selectedCols
Definition: parsenodes.h:1061
static CopyState BeginCopyTo(ParseState *pstate, Relation rel, RawStmt *query, Oid queryRelId, const char *filename, bool is_program, List *attnamelist, List *options)
Definition: copy.c:1737
#define ERROR
Definition: elog.h:43
#define lfirst_int(lc)
Definition: pg_list.h:107
RangeVar * relation
Definition: parsenodes.h:1953
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3066
Node * stmt
Definition: parsenodes.h:1431
#define NoLock
Definition: lockdefs.h:34
List * targetList
Definition: parsenodes.h:1520
static uint64 DoCopyTo(CopyState cstate)
Definition: copy.c:1875
#define RowExclusiveLock
Definition: lockdefs.h:38
List * options
Definition: parsenodes.h:1961
#define select(n, r, w, e, timeout)
Definition: win32_port.h:447
#define RelationGetRelationName(relation)
Definition: rel.h:445
#define ereport(elevel, rest)
Definition: elog.h:122
List * lappend(List *list, void *datum)
Definition: list.c:128
static List * CopyGetAttnums(TupleDesc tupDesc, Relation rel, List *attnamelist)
Definition: copy.c:4698
#define ACL_SELECT
Definition: parsenodes.h:73
int stmt_len
Definition: parsenodes.h:1433
int stmt_location
Definition: parsenodes.h:1432
Relation heap_openrv(const RangeVar *relation, LOCKMODE lockmode)
Definition: heapam.c:1318
#define InvalidOid
Definition: postgres_ext.h:36
bool XactReadOnly
Definition: xact.c:77
int check_enable_rls(Oid relid, Oid checkAsUser, bool noError)
Definition: rls.c:53
void EndCopyFrom(CopyState cstate)
Definition: copy.c:3506
#define makeNode(_type_)
Definition: nodes.h:560
#define Assert(condition)
Definition: c.h:680
#define lfirst(lc)
Definition: pg_list.h:106
#define ACL_INSERT
Definition: parsenodes.h:72
RangeTblEntry * addRangeTableEntryForRelation(ParseState *pstate, Relation rel, Alias *alias, bool inh, bool inFromCl)
Bitmapset * bms_add_member(Bitmapset *a, int x)
Definition: bitmapset.c:742
void PreventCommandIfReadOnly(const char *cmdname)
Definition: utility.c:236
Node * query
Definition: parsenodes.h:1954
bool is_from
Definition: parsenodes.h:1958
int errmsg(const char *fmt,...)
Definition: elog.c:797
Bitmapset * insertedCols
Definition: parsenodes.h:1062
bool ExecCheckRTPerms(List *rangeTable, bool ereport_on_violation)
Definition: execMain.c:568
char * filename
Definition: parsenodes.h:1960
static void EndCopyTo(CopyState cstate)
Definition: copy.c:1910
Definition: pg_list.h:45
#define RelationGetRelid(relation)
Definition: rel.h:425
RangeVar * makeRangeVar(char *schemaname, char *relname, int location)
Definition: makefuncs.c:421
List * fields
Definition: parsenodes.h:234
#define RelationGetNamespace(relation)
Definition: rel.h:452

◆ EndCopyFrom()

void EndCopyFrom ( CopyState  cstate)

Definition at line 3506 of file copy.c.

References EndCopy().

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

3507 {
3508  /* No COPY FROM related resources except memory. */
3509 
3510  EndCopy(cstate);
3511 }
static void EndCopy(CopyState cstate)
Definition: copy.c:1714

◆ NextCopyFrom()

bool NextCopyFrom ( CopyState  cstate,
ExprContext econtext,
Datum values,
bool nulls,
Oid tupleOid 
)

Definition at line 3265 of file copy.c.

References Assert, CopyStateData::attnumlist, CopyStateData::binary, CopyStateData::convert_select_flags, CopyStateData::copy_dest, COPY_OLD_FE, CopyGetData(), CopyGetInt16(), CopyReadBinaryAttribute(), CStringGetDatum, CopyStateData::csv_mode, cur, CopyStateData::cur_attname, CopyStateData::cur_attval, CopyStateData::cur_lineno, CurrentMemoryContext, DatumGetObjectId, CopyStateData::defexprs, CopyStateData::defmap, DirectFunctionCall1, ExprContext::ecxt_per_tuple_memory, ereport, errcode(), errmsg(), ERROR, ExecEvalExpr(), CopyStateData::file_has_oids, CopyStateData::force_notnull_flags, CopyStateData::force_null_flags, i, CopyStateData::in_functions, InputFunctionCall(), InvalidOid, lfirst_int, list_length(), MemSet, NameStr, tupleDesc::natts, NextCopyFromRawFields(), CopyStateData::null_print, CopyStateData::num_defaults, CopyStateData::oid_in_function, CopyStateData::oid_typioparam, oidin(), CopyStateData::oids, CopyStateData::rel, RelationGetDescr, TupleDescAttr, and CopyStateData::typioparams.

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

3267 {
3268  TupleDesc tupDesc;
3269  AttrNumber num_phys_attrs,
3270  attr_count,
3271  num_defaults = cstate->num_defaults;
3272  FmgrInfo *in_functions = cstate->in_functions;
3273  Oid *typioparams = cstate->typioparams;
3274  int i;
3275  int nfields;
3276  bool isnull;
3277  bool file_has_oids = cstate->file_has_oids;
3278  int *defmap = cstate->defmap;
3279  ExprState **defexprs = cstate->defexprs;
3280 
3281  tupDesc = RelationGetDescr(cstate->rel);
3282  num_phys_attrs = tupDesc->natts;
3283  attr_count = list_length(cstate->attnumlist);
3284  nfields = file_has_oids ? (attr_count + 1) : attr_count;
3285 
3286  /* Initialize all values for row to NULL */
3287  MemSet(values, 0, num_phys_attrs * sizeof(Datum));
3288  MemSet(nulls, true, num_phys_attrs * sizeof(bool));
3289 
3290  if (!cstate->binary)
3291  {
3292  char **field_strings;
3293  ListCell *cur;
3294  int fldct;
3295  int fieldno;
3296  char *string;
3297 
3298  /* read raw fields in the next line */
3299  if (!NextCopyFromRawFields(cstate, &field_strings, &fldct))
3300  return false;
3301 
3302  /* check for overflowing fields */
3303  if (nfields > 0 && fldct > nfields)
3304  ereport(ERROR,
3305  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3306  errmsg("extra data after last expected column")));
3307 
3308  fieldno = 0;
3309 
3310  /* Read the OID field if present */
3311  if (file_has_oids)
3312  {
3313  if (fieldno >= fldct)
3314  ereport(ERROR,
3315  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3316  errmsg("missing data for OID column")));
3317  string = field_strings[fieldno++];
3318 
3319  if (string == NULL)
3320  ereport(ERROR,
3321  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3322  errmsg("null OID in COPY data")));
3323  else if (cstate->oids && tupleOid != NULL)
3324  {
3325  cstate->cur_attname = "oid";
3326  cstate->cur_attval = string;
3328  CStringGetDatum(string)));
3329  if (*tupleOid == InvalidOid)
3330  ereport(ERROR,
3331  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3332  errmsg("invalid OID in COPY data")));
3333  cstate->cur_attname = NULL;
3334  cstate->cur_attval = NULL;
3335  }
3336  }
3337 
3338  /* Loop to read the user attributes on the line. */
3339  foreach(cur, cstate->attnumlist)
3340  {
3341  int attnum = lfirst_int(cur);
3342  int m = attnum - 1;
3343  Form_pg_attribute att = TupleDescAttr(tupDesc, m);
3344 
3345  if (fieldno >= fldct)
3346  ereport(ERROR,
3347  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3348  errmsg("missing data for column \"%s\"",
3349  NameStr(att->attname))));
3350  string = field_strings[fieldno++];
3351 
3352  if (cstate->convert_select_flags &&
3353  !cstate->convert_select_flags[m])
3354  {
3355  /* ignore input field, leaving column as NULL */
3356  continue;
3357  }
3358 
3359  if (cstate->csv_mode)
3360  {
3361  if (string == NULL &&
3362  cstate->force_notnull_flags[m])
3363  {
3364  /*
3365  * FORCE_NOT_NULL option is set and column is NULL -
3366  * convert it to the NULL string.
3367  */
3368  string = cstate->null_print;
3369  }
3370  else if (string != NULL && cstate->force_null_flags[m]
3371  && strcmp(string, cstate->null_print) == 0)
3372  {
3373  /*
3374  * FORCE_NULL option is set and column matches the NULL
3375  * string. It must have been quoted, or otherwise the
3376  * string would already have been set to NULL. Convert it
3377  * to NULL as specified.
3378  */
3379  string = NULL;
3380  }
3381  }
3382 
3383  cstate->cur_attname = NameStr(att->attname);
3384  cstate->cur_attval = string;
3385  values[m] = InputFunctionCall(&in_functions[m],
3386  string,
3387  typioparams[m],
3388  att->atttypmod);
3389  if (string != NULL)
3390  nulls[m] = false;
3391  cstate->cur_attname = NULL;
3392  cstate->cur_attval = NULL;
3393  }
3394 
3395  Assert(fieldno == nfields);
3396  }
3397  else
3398  {
3399  /* binary */
3400  int16 fld_count;
3401  ListCell *cur;
3402 
3403  cstate->cur_lineno++;
3404 
3405  if (!CopyGetInt16(cstate, &fld_count))
3406  {
3407  /* EOF detected (end of file, or protocol-level EOF) */
3408  return false;
3409  }
3410 
3411  if (fld_count == -1)
3412  {
3413  /*
3414  * Received EOF marker. In a V3-protocol copy, wait for the
3415  * protocol-level EOF, and complain if it doesn't come
3416  * immediately. This ensures that we correctly handle CopyFail,
3417  * if client chooses to send that now.
3418  *
3419  * Note that we MUST NOT try to read more data in an old-protocol
3420  * copy, since there is no protocol-level EOF marker then. We
3421  * could go either way for copy from file, but choose to throw
3422  * error if there's data after the EOF marker, for consistency
3423  * with the new-protocol case.
3424  */
3425  char dummy;
3426 
3427  if (cstate->copy_dest != COPY_OLD_FE &&
3428  CopyGetData(cstate, &dummy, 1, 1) > 0)
3429  ereport(ERROR,
3430  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3431  errmsg("received copy data after EOF marker")));
3432  return false;
3433  }
3434 
3435  if (fld_count != attr_count)
3436  ereport(ERROR,
3437  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3438  errmsg("row field count is %d, expected %d",
3439  (int) fld_count, attr_count)));
3440 
3441  if (file_has_oids)
3442  {
3443  Oid loaded_oid;
3444 
3445  cstate->cur_attname = "oid";
3446  loaded_oid =
3448  0,
3449  &cstate->oid_in_function,
3450  cstate->oid_typioparam,
3451  -1,
3452  &isnull));
3453  if (isnull || loaded_oid == InvalidOid)
3454  ereport(ERROR,
3455  (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
3456  errmsg("invalid OID in COPY data")));
3457  cstate->cur_attname = NULL;
3458  if (cstate->oids && tupleOid != NULL)
3459  *tupleOid = loaded_oid;
3460  }
3461 
3462  i = 0;
3463  foreach(cur, cstate->attnumlist)
3464  {
3465  int attnum = lfirst_int(cur);
3466  int m = attnum - 1;
3467  Form_pg_attribute att = TupleDescAttr(tupDesc, m);
3468 
3469  cstate->cur_attname = NameStr(att->attname);
3470  i++;
3471  values[m] = CopyReadBinaryAttribute(cstate,
3472  i,
3473  &in_functions[m],
3474  typioparams[m],
3475  att->atttypmod,
3476  &nulls[m]);
3477  cstate->cur_attname = NULL;
3478  }
3479  }
3480 
3481  /*
3482  * Now compute and insert any defaults available for the columns not
3483  * provided by the input data. Anything not processed here or above will
3484  * remain NULL.
3485  */
3486  for (i = 0; i < num_defaults; i++)
3487  {
3488  /*
3489  * The caller must supply econtext and have switched into the
3490  * per-tuple memory context in it.
3491  */
3492  Assert(econtext != NULL);
3494 
3495  values[defmap[i]] = ExecEvalExpr(defexprs[i], econtext,
3496  &nulls[defmap[i]]);
3497  }
3498 
3499  return true;
3500 }
signed short int16
Definition: c.h:293
bool NextCopyFromRawFields(CopyState cstate, char ***fields, int *nfields)
Definition: copy.c:3213
static Datum CopyReadBinaryAttribute(CopyState cstate, int column_no, FmgrInfo *flinfo, Oid typioparam, int32 typmod, bool *isnull)
Definition: copy.c:4395
Definition: fmgr.h:56
bool csv_mode
Definition: copy.c:119
bool binary
Definition: copy.c:116
#define RelationGetDescr(relation)
Definition: rel.h:437
FmgrInfo * in_functions
Definition: copy.c:162
AttrNumber num_defaults
Definition: copy.c:158
List * attnumlist
Definition: copy.c:112
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:90
bool file_has_oids
Definition: copy.c:159
#define DatumGetObjectId(X)
Definition: postgres.h:506
MemoryContext ecxt_per_tuple_memory
Definition: execnodes.h:214
struct cursor * cur
Definition: ecpg.c:28
int errcode(int sqlerrcode)
Definition: elog.c:575
#define MemSet(start, val, len)
Definition: c.h:877
#define DirectFunctionCall1(func, arg1)
Definition: fmgr.h:585
unsigned int Oid
Definition: postgres_ext.h:31
bool * force_null_flags
Definition: copy.c:133
int natts
Definition: tupdesc.h:79
bool * convert_select_flags
Definition: copy.c:136
CopyDest copy_dest
Definition: copy.c:99
char * null_print
Definition: copy.c:121
const char * cur_attname
Definition: copy.c:141
Relation rel
Definition: copy.c:110
#define ERROR
Definition: elog.h:43
static int CopyGetData(CopyState cstate, void *databuf, int minread, int maxread)
Definition: copy.c:556
#define lfirst_int(lc)
Definition: pg_list.h:107
static Datum ExecEvalExpr(ExprState *state, ExprContext *econtext, bool *isNull)
Definition: executor.h:283
ExprState ** defexprs
Definition: copy.c:165
#define CStringGetDatum(X)
Definition: postgres.h:584
char string[11]
Definition: preproc-type.c:46
FmgrInfo oid_in_function
Definition: copy.c:160
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:187
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
#define ereport(elevel, rest)
Definition: elog.h:122
Oid * typioparams
Definition: copy.c:163
uintptr_t Datum
Definition: postgres.h:372
Datum InputFunctionCall(FmgrInfo *flinfo, char *str, Oid typioparam, int32 typmod)
Definition: fmgr.c:1618
#define InvalidOid
Definition: postgres_ext.h:36
bool * force_notnull_flags
Definition: copy.c:131
#define Assert(condition)
Definition: c.h:680
static int list_length(const List *l)
Definition: pg_list.h:89
static Datum values[MAXATTR]
Definition: bootstrap.c:164
int errmsg(const char *fmt,...)
Definition: elog.c:797
int i
#define NameStr(name)
Definition: c.h:557
static bool CopyGetInt16(CopyState cstate, int16 *val)
Definition: copy.c:711
int cur_lineno
Definition: copy.c:140
Datum oidin(PG_FUNCTION_ARGS)
Definition: oid.c:117
const char * cur_attval
Definition: copy.c:142
Oid oid_typioparam
Definition: copy.c:161
int16 AttrNumber
Definition: attnum.h:21
int * defmap
Definition: copy.c:164
bool oids
Definition: copy.c:117

◆ NextCopyFromRawFields()

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

Definition at line 3213 of file copy.c.

References Assert, CopyStateData::binary, CopyReadAttributesCSV(), CopyReadAttributesText(), CopyReadLine(), CopyStateData::csv_mode, CopyStateData::cur_lineno, CopyStateData::header_line, StringInfoData::len, CopyStateData::line_buf, and CopyStateData::raw_fields.

Referenced by NextCopyFrom().

3214 {
3215  int fldct;
3216  bool done;
3217 
3218  /* only available for text or csv input */
3219  Assert(!cstate->binary);
3220 
3221  /* on input just throw the header line away */
3222  if (cstate->cur_lineno == 0 && cstate->header_line)
3223  {
3224  cstate->cur_lineno++;
3225  if (CopyReadLine(cstate))
3226  return false; /* done */
3227  }
3228 
3229  cstate->cur_lineno++;
3230 
3231  /* Actually read the line into memory here */
3232  done = CopyReadLine(cstate);
3233 
3234  /*
3235  * EOF at start of line means we're done. If we see EOF after some
3236  * characters, we act as though it was newline followed by EOF, ie,
3237  * process the line and then exit loop on next iteration.
3238  */
3239  if (done && cstate->line_buf.len == 0)
3240  return false;
3241 
3242  /* Parse the line into de-escaped field values */
3243  if (cstate->csv_mode)
3244  fldct = CopyReadAttributesCSV(cstate);
3245  else
3246  fldct = CopyReadAttributesText(cstate);
3247 
3248  *fields = cstate->raw_fields;
3249  *nfields = fldct;
3250  return true;
3251 }
bool csv_mode
Definition: copy.c:119
char ** raw_fields
Definition: copy.c:188
bool binary
Definition: copy.c:116
StringInfoData line_buf
Definition: copy.c:197
static int CopyReadAttributesCSV(CopyState cstate)
Definition: copy.c:4226
bool header_line
Definition: copy.c:120
#define Assert(condition)
Definition: c.h:680
static bool CopyReadLine(CopyState cstate)
Definition: copy.c:3522
int cur_lineno
Definition: copy.c:140
static int CopyReadAttributesText(CopyState cstate)
Definition: copy.c:3998

◆ ProcessCopyOptions()

void ProcessCopyOptions ( ParseState pstate,
CopyState  cstate,
bool  is_from,
List options 
)

Definition at line 1014 of file copy.c.

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

Referenced by BeginCopy(), and file_fdw_validator().

1018 {
1019  bool format_specified = false;
1020  ListCell *option;
1021 
1022  /* Support external use for option sanity checking */
1023  if (cstate == NULL)
1024  cstate = (CopyStateData *) palloc0(sizeof(CopyStateData));
1025 
1026  cstate->file_encoding = -1;
1027 
1028  /* Extract options from the statement node tree */
1029  foreach(option, options)
1030  {
1031  DefElem *defel = lfirst_node(DefElem, option);
1032 
1033  if (strcmp(defel->defname, "format") == 0)
1034  {
1035  char *fmt = defGetString(defel);
1036 
1037  if (format_specified)
1038  ereport(ERROR,
1039  (errcode(ERRCODE_SYNTAX_ERROR),
1040  errmsg("conflicting or redundant options"),
1041  parser_errposition(pstate, defel->location)));
1042  format_specified = true;
1043  if (strcmp(fmt, "text") == 0)
1044  /* default format */ ;
1045  else if (strcmp(fmt, "csv") == 0)
1046  cstate->csv_mode = true;
1047  else if (strcmp(fmt, "binary") == 0)
1048  cstate->binary = true;
1049  else
1050  ereport(ERROR,
1051  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1052  errmsg("COPY format \"%s\" not recognized", fmt),
1053  parser_errposition(pstate, defel->location)));
1054  }
1055  else if (strcmp(defel->defname, "oids") == 0)
1056  {
1057  if (cstate->oids)
1058  ereport(ERROR,
1059  (errcode(ERRCODE_SYNTAX_ERROR),
1060  errmsg("conflicting or redundant options"),
1061  parser_errposition(pstate, defel->location)));
1062  cstate->oids = defGetBoolean(defel);
1063  }
1064  else if (strcmp(defel->defname, "freeze") == 0)
1065  {
1066  if (cstate->freeze)
1067  ereport(ERROR,
1068  (errcode(ERRCODE_SYNTAX_ERROR),
1069  errmsg("conflicting or redundant options"),
1070  parser_errposition(pstate, defel->location)));
1071  cstate->freeze = defGetBoolean(defel);
1072  }
1073  else if (strcmp(defel->defname, "delimiter") == 0)
1074  {
1075  if (cstate->delim)
1076  ereport(ERROR,
1077  (errcode(ERRCODE_SYNTAX_ERROR),
1078  errmsg("conflicting or redundant options"),
1079  parser_errposition(pstate, defel->location)));
1080  cstate->delim = defGetString(defel);
1081  }
1082  else if (strcmp(defel->defname, "null") == 0)
1083  {
1084  if (cstate->null_print)
1085  ereport(ERROR,
1086  (errcode(ERRCODE_SYNTAX_ERROR),
1087  errmsg("conflicting or redundant options"),
1088  parser_errposition(pstate, defel->location)));
1089  cstate->null_print = defGetString(defel);
1090  }
1091  else if (strcmp(defel->defname, "header") == 0)
1092  {
1093  if (cstate->header_line)
1094  ereport(ERROR,
1095  (errcode(ERRCODE_SYNTAX_ERROR),
1096  errmsg("conflicting or redundant options"),
1097  parser_errposition(pstate, defel->location)));
1098  cstate->header_line = defGetBoolean(defel);
1099  }
1100  else if (strcmp(defel->defname, "quote") == 0)
1101  {
1102  if (cstate->quote)
1103  ereport(ERROR,
1104  (errcode(ERRCODE_SYNTAX_ERROR),
1105  errmsg("conflicting or redundant options"),
1106  parser_errposition(pstate, defel->location)));
1107  cstate->quote = defGetString(defel);
1108  }
1109  else if (strcmp(defel->defname, "escape") == 0)
1110  {
1111  if (cstate->escape)
1112  ereport(ERROR,
1113  (errcode(ERRCODE_SYNTAX_ERROR),
1114  errmsg("conflicting or redundant options"),
1115  parser_errposition(pstate, defel->location)));
1116  cstate->escape = defGetString(defel);
1117  }
1118  else if (strcmp(defel->defname, "force_quote") == 0)
1119  {
1120  if (cstate->force_quote || cstate->force_quote_all)
1121  ereport(ERROR,
1122  (errcode(ERRCODE_SYNTAX_ERROR),
1123  errmsg("conflicting or redundant options"),
1124  parser_errposition(pstate, defel->location)));
1125  if (defel->arg && IsA(defel->arg, A_Star))
1126  cstate->force_quote_all = true;
1127  else if (defel->arg && IsA(defel->arg, List))
1128  cstate->force_quote = castNode(List, defel->arg);
1129  else
1130  ereport(ERROR,
1131  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1132  errmsg("argument to option \"%s\" must be a list of column names",
1133  defel->defname),
1134  parser_errposition(pstate, defel->location)));
1135  }
1136  else if (strcmp(defel->defname, "force_not_null") == 0)
1137  {
1138  if (cstate->force_notnull)
1139  ereport(ERROR,
1140  (errcode(ERRCODE_SYNTAX_ERROR),
1141  errmsg("conflicting or redundant options"),
1142  parser_errposition(pstate, defel->location)));
1143  if (defel->arg && IsA(defel->arg, List))
1144  cstate->force_notnull = castNode(List, defel->arg);
1145  else
1146  ereport(ERROR,
1147  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1148  errmsg("argument to option \"%s\" must be a list of column names",
1149  defel->defname),
1150  parser_errposition(pstate, defel->location)));
1151  }
1152  else if (strcmp(defel->defname, "force_null") == 0)
1153  {
1154  if (cstate->force_null)
1155  ereport(ERROR,
1156  (errcode(ERRCODE_SYNTAX_ERROR),
1157  errmsg("conflicting or redundant options")));
1158  if (defel->arg && IsA(defel->arg, List))
1159  cstate->force_null = castNode(List, defel->arg);
1160  else
1161  ereport(ERROR,
1162  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1163  errmsg("argument to option \"%s\" must be a list of column names",
1164  defel->defname),
1165  parser_errposition(pstate, defel->location)));
1166  }
1167  else if (strcmp(defel->defname, "convert_selectively") == 0)
1168  {
1169  /*
1170  * Undocumented, not-accessible-from-SQL option: convert only the
1171  * named columns to binary form, storing the rest as NULLs. It's
1172  * allowed for the column list to be NIL.
1173  */
1174  if (cstate->convert_selectively)
1175  ereport(ERROR,
1176  (errcode(ERRCODE_SYNTAX_ERROR),
1177  errmsg("conflicting or redundant options"),
1178  parser_errposition(pstate, defel->location)));
1179  cstate->convert_selectively = true;
1180  if (defel->arg == NULL || IsA(defel->arg, List))
1181  cstate->convert_select = castNode(List, defel->arg);
1182  else
1183  ereport(ERROR,
1184  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1185  errmsg("argument to option \"%s\" must be a list of column names",
1186  defel->defname),
1187  parser_errposition(pstate, defel->location)));
1188  }
1189  else if (strcmp(defel->defname, "encoding") == 0)
1190  {
1191  if (cstate->file_encoding >= 0)
1192  ereport(ERROR,
1193  (errcode(ERRCODE_SYNTAX_ERROR),
1194  errmsg("conflicting or redundant options"),
1195  parser_errposition(pstate, defel->location)));
1197  if (cstate->file_encoding < 0)
1198  ereport(ERROR,
1199  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1200  errmsg("argument to option \"%s\" must be a valid encoding name",
1201  defel->defname),
1202  parser_errposition(pstate, defel->location)));
1203  }
1204  else
1205  ereport(ERROR,
1206  (errcode(ERRCODE_SYNTAX_ERROR),
1207  errmsg("option \"%s\" not recognized",
1208  defel->defname),
1209  parser_errposition(pstate, defel->location)));
1210  }
1211 
1212  /*
1213  * Check for incompatible options (must do these two before inserting
1214  * defaults)
1215  */
1216  if (cstate->binary && cstate->delim)
1217  ereport(ERROR,
1218  (errcode(ERRCODE_SYNTAX_ERROR),
1219  errmsg("cannot specify DELIMITER in BINARY mode")));
1220 
1221  if (cstate->binary && cstate->null_print)
1222  ereport(ERROR,
1223  (errcode(ERRCODE_SYNTAX_ERROR),
1224  errmsg("cannot specify NULL in BINARY mode")));
1225 
1226  /* Set defaults for omitted options */
1227  if (!cstate->delim)
1228  cstate->delim = cstate->csv_mode ? "," : "\t";
1229 
1230  if (!cstate->null_print)
1231  cstate->null_print = cstate->csv_mode ? "" : "\\N";
1232  cstate->null_print_len = strlen(cstate->null_print);
1233 
1234  if (cstate->csv_mode)
1235  {
1236  if (!cstate->quote)
1237  cstate->quote = "\"";
1238  if (!cstate->escape)
1239  cstate->escape = cstate->quote;
1240  }
1241 
1242  /* Only single-byte delimiter strings are supported. */
1243  if (strlen(cstate->delim) != 1)
1244  ereport(ERROR,
1245  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1246  errmsg("COPY delimiter must be a single one-byte character")));
1247 
1248  /* Disallow end-of-line characters */
1249  if (strchr(cstate->delim, '\r') != NULL ||
1250  strchr(cstate->delim, '\n') != NULL)
1251  ereport(ERROR,
1252  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1253  errmsg("COPY delimiter cannot be newline or carriage return")));
1254 
1255  if (strchr(cstate->null_print, '\r') != NULL ||
1256  strchr(cstate->null_print, '\n') != NULL)
1257  ereport(ERROR,
1258  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1259  errmsg("COPY null representation cannot use newline or carriage return")));
1260 
1261  /*
1262  * Disallow unsafe delimiter characters in non-CSV mode. We can't allow
1263  * backslash because it would be ambiguous. We can't allow the other
1264  * cases because data characters matching the delimiter must be
1265  * backslashed, and certain backslash combinations are interpreted
1266  * non-literally by COPY IN. Disallowing all lower case ASCII letters is
1267  * more than strictly necessary, but seems best for consistency and
1268  * future-proofing. Likewise we disallow all digits though only octal
1269  * digits are actually dangerous.
1270  */
1271  if (!cstate->csv_mode &&
1272  strchr("\\.abcdefghijklmnopqrstuvwxyz0123456789",
1273  cstate->delim[0]) != NULL)
1274  ereport(ERROR,
1275  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1276  errmsg("COPY delimiter cannot be \"%s\"", cstate->delim)));
1277 
1278  /* Check header */
1279  if (!cstate->csv_mode && cstate->header_line)
1280  ereport(ERROR,
1281  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1282  errmsg("COPY HEADER available only in CSV mode")));
1283 
1284  /* Check quote */
1285  if (!cstate->csv_mode && cstate->quote != NULL)
1286  ereport(ERROR,
1287  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1288  errmsg("COPY quote available only in CSV mode")));
1289 
1290  if (cstate->csv_mode && strlen(cstate->quote) != 1)
1291  ereport(ERROR,
1292  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1293  errmsg("COPY quote must be a single one-byte character")));
1294 
1295  if (cstate->csv_mode && cstate->delim[0] == cstate->quote[0])
1296  ereport(ERROR,
1297  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1298  errmsg("COPY delimiter and quote must be different")));
1299 
1300  /* Check escape */
1301  if (!cstate->csv_mode && cstate->escape != NULL)
1302  ereport(ERROR,
1303  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1304  errmsg("COPY escape available only in CSV mode")));
1305 
1306  if (cstate->csv_mode && strlen(cstate->escape) != 1)
1307  ereport(ERROR,
1308  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1309  errmsg("COPY escape must be a single one-byte character")));
1310 
1311  /* Check force_quote */
1312  if (!cstate->csv_mode && (cstate->force_quote || cstate->force_quote_all))
1313  ereport(ERROR,
1314  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1315  errmsg("COPY force quote available only in CSV mode")));
1316  if ((cstate->force_quote || cstate->force_quote_all) && is_from)
1317  ereport(ERROR,
1318  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1319  errmsg("COPY force quote only available using COPY TO")));
1320 
1321  /* Check force_notnull */
1322  if (!cstate->csv_mode && cstate->force_notnull != NIL)
1323  ereport(ERROR,
1324  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1325  errmsg("COPY force not null available only in CSV mode")));
1326  if (cstate->force_notnull != NIL && !is_from)
1327  ereport(ERROR,
1328  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1329  errmsg("COPY force not null only available using COPY FROM")));
1330 
1331  /* Check force_null */
1332  if (!cstate->csv_mode && cstate->force_null != NIL)
1333  ereport(ERROR,
1334  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1335  errmsg("COPY force null available only in CSV mode")));
1336 
1337  if (cstate->force_null != NIL && !is_from)
1338  ereport(ERROR,
1339  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1340  errmsg("COPY force null only available using COPY FROM")));
1341 
1342  /* Don't allow the delimiter to appear in the null string. */
1343  if (strchr(cstate->null_print, cstate->delim[0]) != NULL)
1344  ereport(ERROR,
1345  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1346  errmsg("COPY delimiter must not appear in the NULL specification")));
1347 
1348  /* Don't allow the CSV quote char to appear in the null string. */
1349  if (cstate->csv_mode &&
1350  strchr(cstate->null_print, cstate->quote[0]) != NULL)
1351  ereport(ERROR,
1352  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1353  errmsg("CSV quote character must not appear in the NULL specification")));
1354 }
#define NIL
Definition: pg_list.h:69
bool csv_mode
Definition: copy.c:119
#define IsA(nodeptr, _type_)
Definition: nodes.h:563
int pg_char_to_encoding(const char *name)
Definition: encnames.c:551
bool binary
Definition: copy.c:116
#define castNode(_type_, nodeptr)
Definition: nodes.h:581
int errcode(int sqlerrcode)
Definition: elog.c:575
char * delim
Definition: copy.c:124
char * null_print
Definition: copy.c:121
bool defGetBoolean(DefElem *def)
Definition: define.c:111
#define ERROR
Definition: elog.h:43
char * defGetString(DefElem *def)
Definition: define.c:49
#define lfirst_node(type, lc)
Definition: pg_list.h:109
char * quote
Definition: copy.c:125
int location
Definition: parsenodes.h:722
char * escape
Definition: copy.c:126
#define ereport(elevel, rest)
Definition: elog.h:122
int null_print_len
Definition: copy.c:122
List * force_null
Definition: copy.c:132
Node * arg
Definition: parsenodes.h:720
int file_encoding
Definition: copy.c:105
void * palloc0(Size size)
Definition: mcxt.c:864
bool header_line
Definition: copy.c:120
bool freeze
Definition: copy.c:118
List * force_notnull
Definition: copy.c:130
List * convert_select
Definition: copy.c:135
int parser_errposition(ParseState *pstate, int location)
Definition: parse_node.c:111
bool force_quote_all
Definition: copy.c:128
int errmsg(const char *fmt,...)
Definition: elog.c:797
char * defname
Definition: parsenodes.h:719
Definition: pg_list.h:45
List * force_quote
Definition: copy.c:127
bool convert_selectively
Definition: copy.c:134
bool oids
Definition: copy.c:117