copyfrom_internal.h File Reference

#include "commands/copy.h"
#include "commands/trigger.h"
#include "nodes/miscnodes.h"

Include dependency graph for copyfrom_internal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	CopyFromStateData

Macros
#define	INPUT_BUF_SIZE   65536 /* we palloc INPUT_BUF_SIZE+1 bytes */
#define	INPUT_BUF_BYTES(cstate)   ((cstate)->input_buf_len - (cstate)->input_buf_index)
#define	RAW_BUF_SIZE   65536 /* we palloc RAW_BUF_SIZE+1 bytes */
#define	RAW_BUF_BYTES(cstate)   ((cstate)->raw_buf_len - (cstate)->raw_buf_index)

Typedefs
typedef enum CopySource	CopySource
typedef enum EolType	EolType
typedef enum CopyInsertMethod	CopyInsertMethod
typedef struct CopyFromStateData	CopyFromStateData

Enumerations
enum	CopySource { COPY_FILE , COPY_FRONTEND , COPY_CALLBACK }
enum	EolType { EOL_UNKNOWN , EOL_NL , EOL_CR , EOL_CRNL }
enum	CopyInsertMethod { CIM_SINGLE , CIM_MULTI , CIM_MULTI_CONDITIONAL }

Functions
void	ReceiveCopyBegin (CopyFromState cstate)
void	ReceiveCopyBinaryHeader (CopyFromState cstate)

Macro Definition Documentation

INPUT_BUF_BYTES

#define INPUT_BUF_BYTES

(

cstate

)

((cstate)->input_buf_len - (cstate)->input_buf_index)

Definition at line 164 of file copyfrom_internal.h.

INPUT_BUF_SIZE

#define INPUT_BUF_SIZE   65536 /* we palloc INPUT_BUF_SIZE+1 bytes */

Definition at line 157 of file copyfrom_internal.h.

RAW_BUF_BYTES

#define RAW_BUF_BYTES

(

cstate

)

((cstate)->raw_buf_len - (cstate)->raw_buf_index)

Definition at line 178 of file copyfrom_internal.h.

RAW_BUF_SIZE

#define RAW_BUF_SIZE   65536 /* we palloc RAW_BUF_SIZE+1 bytes */

Definition at line 171 of file copyfrom_internal.h.

Typedef Documentation

CopyFromStateData

typedef struct CopyFromStateData CopyFromStateData

CopyInsertMethod

typedef enum CopyInsertMethod CopyInsertMethod

CopySource

typedef enum CopySource CopySource

EolType

typedef enum EolType EolType

Enumeration Type Documentation

CopyInsertMethod

enum CopyInsertMethod

Enumerator
CIM_SINGLE
CIM_MULTI
CIM_MULTI_CONDITIONAL

Definition at line 46 of file copyfrom_internal.h.

{
    CIM_SINGLE,                 /* use table_tuple_insert or ExecForeignInsert */
    CIM_MULTI,                  /* always use table_multi_insert or
                                 * ExecForeignBatchInsert */
    CIM_MULTI_CONDITIONAL,      /* use table_multi_insert or
                                 * ExecForeignBatchInsert only if valid */
} CopyInsertMethod;

CopySource

enum CopySource

Enumerator
COPY_FILE
COPY_FRONTEND
COPY_CALLBACK

Definition at line 25 of file copyfrom_internal.h.

{
    COPY_FILE,                  /* from file (or a piped program) */
    COPY_FRONTEND,              /* from frontend */
    COPY_CALLBACK,              /* from callback function */
} CopySource;

EolType

enum EolType

Enumerator
EOL_UNKNOWN
EOL_NL
EOL_CR
EOL_CRNL

Definition at line 35 of file copyfrom_internal.h.

{
    EOL_UNKNOWN,
    EOL_NL,
    EOL_CR,
    EOL_CRNL,
} EolType;

Function Documentation

ReceiveCopyBegin()

void ReceiveCopyBegin

(

CopyFromState

cstate

)

Definition at line 170 of file copyfromparse.c.

{
    StringInfoData buf;
    int         natts = list_length(cstate->attnumlist);
    int16       format = (cstate->opts.binary ? 1 : 0);
    int         i;
 
    pq_beginmessage(&buf, PqMsg_CopyInResponse);
    pq_sendbyte(&buf, format);  /* overall format */
    pq_sendint16(&buf, natts);
    for (i = 0; i < natts; i++)
        pq_sendint16(&buf, format); /* per-column formats */
    pq_endmessage(&buf);
    cstate->copy_src = COPY_FRONTEND;
    cstate->fe_msgbuf = makeStringInfo();
    /* We *must* flush here to ensure FE knows it can send. */
    pq_flush();
}

References CopyFromStateData::attnumlist, CopyFormatOptions::binary, buf, COPY_FRONTEND, CopyFromStateData::copy_src, CopyFromStateData::fe_msgbuf, format, i, list_length(), makeStringInfo(), CopyFromStateData::opts, pq_beginmessage(), pq_endmessage(), pq_flush, pq_sendbyte(), pq_sendint16(), and PqMsg_CopyInResponse.

Referenced by BeginCopyFrom().

ReceiveCopyBinaryHeader()

void ReceiveCopyBinaryHeader

(

CopyFromState

cstate

)

Definition at line 190 of file copyfromparse.c.

{
    char        readSig[11];
    int32       tmp;
 
    /* Signature */
    if (CopyReadBinaryData(cstate, readSig, 11) != 11 ||
        memcmp(readSig, BinarySignature, 11) != 0)
        ereport(ERROR,
                (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
                 errmsg("COPY file signature not recognized")));
    /* Flags field */
    if (!CopyGetInt32(cstate, &tmp))
        ereport(ERROR,
                (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
                 errmsg("invalid COPY file header (missing flags)")));
    if ((tmp & (1 << 16)) != 0)
        ereport(ERROR,
                (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
                 errmsg("invalid COPY file header (WITH OIDS)")));
    tmp &= ~(1 << 16);
    if ((tmp >> 16) != 0)
        ereport(ERROR,
                (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
                 errmsg("unrecognized critical flags in COPY file header")));
    /* Header extension length */
    if (!CopyGetInt32(cstate, &tmp) ||
        tmp < 0)
        ereport(ERROR,
                (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
                 errmsg("invalid COPY file header (missing length)")));
    /* Skip extension header, if present */
    while (tmp-- > 0)
    {
        if (CopyReadBinaryData(cstate, readSig, 1) != 1)
            ereport(ERROR,
                    (errcode(ERRCODE_BAD_COPY_FILE_FORMAT),
                     errmsg("invalid COPY file header (wrong length)")));
    }
}

References BinarySignature, CopyGetInt32(), CopyReadBinaryData(), ereport, errcode(), errmsg(), and ERROR.

Referenced by BeginCopyFrom().