PostgreSQL Source Code  git master
copy.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * copy.h
4  * Definitions for using the POSTGRES copy command.
5  *
6  *
7  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/commands/copy.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef COPY_H
15 #define COPY_H
16 
17 #include "nodes/execnodes.h"
18 #include "nodes/parsenodes.h"
19 #include "parser/parse_node.h"
20 #include "tcop/dest.h"
21 
22 /*
23  * Represents whether a header line should be present, and whether it must
24  * match the actual names (which implies "true").
25  */
26 typedef enum CopyHeaderChoice
27 {
32 
33 /*
34  * Represents where to save input processing errors. More values to be added
35  * in the future.
36  */
37 typedef enum CopyOnErrorChoice
38 {
39  COPY_ON_ERROR_STOP = 0, /* immediately throw errors, default */
40  COPY_ON_ERROR_IGNORE, /* ignore errors */
42 
43 /*
44  * A struct to hold COPY options, in a parsed form. All of these are related
45  * to formatting, except for 'freeze', which doesn't really belong here, but
46  * it's expedient to parse it along with all the other options.
47  */
48 typedef struct CopyFormatOptions
49 {
50  /* parameters from the COPY command */
51  int file_encoding; /* file or remote side's character encoding,
52  * -1 if not specified */
53  bool binary; /* binary format? */
54  bool freeze; /* freeze rows on loading? */
55  bool csv_mode; /* Comma Separated Value format? */
56  CopyHeaderChoice header_line; /* header line? */
57  char *null_print; /* NULL marker string (server encoding!) */
58  int null_print_len; /* length of same */
59  char *null_print_client; /* same converted to file encoding */
60  char *default_print; /* DEFAULT marker string */
61  int default_print_len; /* length of same */
62  char *delim; /* column delimiter (must be 1 byte) */
63  char *quote; /* CSV quote char (must be 1 byte) */
64  char *escape; /* CSV escape char (must be 1 byte) */
65  List *force_quote; /* list of column names */
66  bool force_quote_all; /* FORCE_QUOTE *? */
67  bool *force_quote_flags; /* per-column CSV FQ flags */
68  List *force_notnull; /* list of column names */
69  bool force_notnull_all; /* FORCE_NOT_NULL *? */
70  bool *force_notnull_flags; /* per-column CSV FNN flags */
71  List *force_null; /* list of column names */
72  bool force_null_all; /* FORCE_NULL *? */
73  bool *force_null_flags; /* per-column CSV FN flags */
74  bool convert_selectively; /* do selective binary conversion? */
75  CopyOnErrorChoice on_error; /* what to do when error happened */
76  List *convert_select; /* list of column names (can be NIL) */
78 
79 /* These are private in commands/copy[from|to].c */
81 typedef struct CopyToStateData *CopyToState;
82 
83 typedef int (*copy_data_source_cb) (void *outbuf, int minread, int maxread);
84 typedef void (*copy_data_dest_cb) (void *data, int len);
85 
86 extern void DoCopy(ParseState *pstate, const CopyStmt *stmt,
87  int stmt_location, int stmt_len,
88  uint64 *processed);
89 
90 extern void ProcessCopyOptions(ParseState *pstate, CopyFormatOptions *opts_out, bool is_from, List *options);
92  const char *filename,
93  bool is_program, copy_data_source_cb data_source_cb, List *attnamelist, List *options);
94 extern void EndCopyFrom(CopyFromState cstate);
95 extern bool NextCopyFrom(CopyFromState cstate, ExprContext *econtext,
96  Datum *values, bool *nulls);
97 extern bool NextCopyFromRawFields(CopyFromState cstate,
98  char ***fields, int *nfields);
99 extern void CopyFromErrorCallback(void *arg);
100 
101 extern uint64 CopyFrom(CopyFromState cstate);
102 
104 
105 /*
106  * internal prototypes
107  */
108 extern CopyToState BeginCopyTo(ParseState *pstate, Relation rel, RawStmt *raw_query,
109  Oid queryRelId, const char *filename, bool is_program,
111 extern void EndCopyTo(CopyToState cstate);
112 extern uint64 DoCopyTo(CopyToState cstate);
113 extern List *CopyGetAttnums(TupleDesc tupDesc, Relation rel,
114  List *attnamelist);
115 
116 #endif /* COPY_H */
static Datum values[MAXATTR]
Definition: bootstrap.c:156
struct CopyFormatOptions CopyFormatOptions
CopyOnErrorChoice
Definition: copy.h:38
@ COPY_ON_ERROR_IGNORE
Definition: copy.h:40
@ COPY_ON_ERROR_STOP
Definition: copy.h:39
List * CopyGetAttnums(TupleDesc tupDesc, Relation rel, List *attnamelist)
Definition: copy.c:841
uint64 DoCopyTo(CopyToState cstate)
Definition: copyto.c:748
void DoCopy(ParseState *pstate, const CopyStmt *stmt, int stmt_location, int stmt_len, uint64 *processed)
Definition: copy.c:64
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:1373
struct CopyFromStateData * CopyFromState
Definition: copy.h:80
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(* copy_data_dest_cb)(void *data, int len)
Definition: copy.h:84
uint64 CopyFrom(CopyFromState cstate)
Definition: copyfrom.c:633
int(* copy_data_source_cb)(void *outbuf, int minread, int maxread)
Definition: copy.h:83
void ProcessCopyOptions(ParseState *pstate, CopyFormatOptions *opts_out, bool is_from, List *options)
Definition: copy.c:450
void EndCopyFrom(CopyFromState cstate)
Definition: copyfrom.c:1790
struct CopyToStateData * CopyToState
Definition: copy.h:81
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
void EndCopyTo(CopyToState cstate)
Definition: copyto.c:727
DestReceiver * CreateCopyDestReceiver(void)
Definition: copyto.c:1273
void CopyFromErrorCallback(void *arg)
Definition: copyfrom.c:117
bool NextCopyFrom(CopyFromState cstate, ExprContext *econtext, Datum *values, bool *nulls)
bool NextCopyFromRawFields(CopyFromState cstate, char ***fields, int *nfields)
#define stmt
Definition: indent_codes.h:59
void * arg
const void size_t len
const void * data
static char * filename
Definition: pg_dumpall.c:121
uintptr_t Datum
Definition: postgres.h:64
unsigned int Oid
Definition: postgres_ext.h:31
int default_print_len
Definition: copy.h:61
bool force_notnull_all
Definition: copy.h:69
bool force_quote_all
Definition: copy.h:66
bool freeze
Definition: copy.h:54
bool binary
Definition: copy.h:53
int null_print_len
Definition: copy.h:58
bool convert_selectively
Definition: copy.h:74
char * quote
Definition: copy.h:63
CopyOnErrorChoice on_error
Definition: copy.h:75
CopyHeaderChoice header_line
Definition: copy.h:56
List * force_quote
Definition: copy.h:65
char * escape
Definition: copy.h:64
char * null_print
Definition: copy.h:57
List * force_null
Definition: copy.h:71
char * delim
Definition: copy.h:62
List * convert_select
Definition: copy.h:76
bool * force_quote_flags
Definition: copy.h:67
bool force_null_all
Definition: copy.h:72
bool * force_notnull_flags
Definition: copy.h:70
char * null_print_client
Definition: copy.h:59
bool csv_mode
Definition: copy.h:55
int file_encoding
Definition: copy.h:51
bool * force_null_flags
Definition: copy.h:73
char * default_print
Definition: copy.h:60
List * force_notnull
Definition: copy.h:68
Node * whereClause
Definition: copyto.c:92
Relation rel
Definition: copyto.c:84
copy_data_dest_cb data_dest_cb
Definition: copyto.c:89
bool is_program
Definition: copyto.c:88
Definition: pg_list.h:54
Definition: nodes.h:129