copyto.c File Reference

#include "postgres.h"
#include <ctype.h>
#include <unistd.h>
#include <sys/stat.h>
#include "access/table.h"
#include "access/tableam.h"
#include "access/tupconvert.h"
#include "catalog/pg_inherits.h"
#include "commands/copyapi.h"
#include "commands/progress.h"
#include "executor/execdesc.h"
#include "executor/executor.h"
#include "executor/tuptable.h"
#include "funcapi.h"
#include "libpq/libpq.h"
#include "libpq/pqformat.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "pgstat.h"
#include "storage/fd.h"
#include "tcop/tcopprot.h"
#include "utils/json.h"
#include "utils/lsyscache.h"
#include "utils/memutils.h"
#include "utils/rel.h"
#include "utils/snapmgr.h"
#include "utils/wait_event.h"

Include dependency graph for copyto.c:

Go to the source code of this file.

Data Structures
struct	CopyToStateData
struct	DR_copy

Macros
#define	DUMPSOFAR()

Typedefs
typedef enum CopyDest	CopyDest
typedef struct CopyToStateData	CopyToStateData

Enumerations
enum	CopyDest { COPY_FILE , COPY_FRONTEND , COPY_CALLBACK }

Functions
static void	EndCopy (CopyToState cstate)
static void	ClosePipeToProgram (CopyToState cstate)
static void	CopyOneRowTo (CopyToState cstate, TupleTableSlot *slot)
static void	CopyAttributeOutText (CopyToState cstate, const char *string)
static void	CopyAttributeOutCSV (CopyToState cstate, const char *string, bool use_quote)
static void	CopyRelationTo (CopyToState cstate, Relation rel, Relation root_rel, uint64 *processed)
static void	CopyToTextLikeStart (CopyToState cstate, TupleDesc tupDesc)
static void	CopyToTextLikeOutFunc (CopyToState cstate, Oid atttypid, FmgrInfo *finfo)
static void	CopyToTextOneRow (CopyToState cstate, TupleTableSlot *slot)
static void	CopyToCSVOneRow (CopyToState cstate, TupleTableSlot *slot)
static void	CopyToTextLikeOneRow (CopyToState cstate, TupleTableSlot *slot, bool is_csv)
static void	CopyToTextLikeEnd (CopyToState cstate)
static void	CopyToJsonOneRow (CopyToState cstate, TupleTableSlot *slot)
static void	CopyToJsonEnd (CopyToState cstate)
static void	CopyToBinaryStart (CopyToState cstate, TupleDesc tupDesc)
static void	CopyToBinaryOutFunc (CopyToState cstate, Oid atttypid, FmgrInfo *finfo)
static void	CopyToBinaryOneRow (CopyToState cstate, TupleTableSlot *slot)
static void	CopyToBinaryEnd (CopyToState cstate)
static void	SendCopyBegin (CopyToState cstate)
static void	SendCopyEnd (CopyToState cstate)
static void	CopySendData (CopyToState cstate, const void *databuf, int datasize)
static void	CopySendString (CopyToState cstate, const char *str)
static void	CopySendChar (CopyToState cstate, char c)
static void	CopySendEndOfRow (CopyToState cstate)
static void	CopySendTextLikeEndOfRow (CopyToState cstate)
static void	CopySendInt32 (CopyToState cstate, int32 val)
static void	CopySendInt16 (CopyToState cstate, int16 val)
static const CopyToRoutine *	CopyToGetRoutine (const CopyFormatOptions *opts)
CopyToState	BeginCopyTo (ParseState *pstate, Relation rel, RawStmt *raw_query, Oid queryRelId, const char *filename, bool is_program, copy_data_dest_cb data_dest_cb, List *attnamelist, List *options)
void	EndCopyTo (CopyToState cstate)
uint64	DoCopyTo (CopyToState cstate)
static void	copy_dest_startup (DestReceiver *self, int operation, TupleDesc typeinfo)
static bool	copy_dest_receive (TupleTableSlot *slot, DestReceiver *self)
static void	copy_dest_shutdown (DestReceiver *self)
static void	copy_dest_destroy (DestReceiver *self)
DestReceiver *	CreateCopyDestReceiver (void)

Variables
static const char	BinarySignature [11] = "PGCOPY\n\377\r\n\0"
static const CopyToRoutine	CopyToRoutineText
static const CopyToRoutine	CopyToRoutineCSV
static const CopyToRoutine	CopyToRoutineJson
static const CopyToRoutine	CopyToRoutineBinary

Macro Definition Documentation

DUMPSOFAR

#define DUMPSOFAR

(

)

Value:

    do { \
		if (ptr > start) \
			CopySendData(cstate, start, ptr - start); \
    } while (0)

Definition at line 1414 of file copyto.c.

       { \
		if (ptr > start) \
			CopySendData(cstate, start, ptr - start); \
    } while (0)

Typedef Documentation

CopyDest

typedef enum CopyDest CopyDest

CopyToStateData

typedef struct CopyToStateData CopyToStateData

Enumeration Type Documentation

CopyDest

enum CopyDest

Enumerator
COPY_FILE
COPY_FRONTEND
COPY_CALLBACK

Definition at line 49 of file copyto.c.

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

Function Documentation

BeginCopyTo()

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

Definition at line 769 of file copyto.c.

{
    CopyToState cstate;
    bool        pipe = (filename == NULL && data_dest_cb == NULL);
    TupleDesc   tupDesc;
    int         num_phys_attrs;
    MemoryContext oldcontext;
    const int   progress_cols[] = {
        PROGRESS_COPY_COMMAND,
        PROGRESS_COPY_TYPE
    };
    int64       progress_vals[] = {
        PROGRESS_COPY_COMMAND_TO,
        0
    };
    List       *children = NIL;
 
    if (rel != NULL && rel->rd_rel->relkind != RELKIND_RELATION)
    {
        if (rel->rd_rel->relkind == RELKIND_VIEW)
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("cannot copy from view \"%s\"",
                            RelationGetRelationName(rel)),
                     errhint("Try the COPY (SELECT ...) TO variant.")));
        else if (rel->rd_rel->relkind == RELKIND_MATVIEW)
        {
            if (!RelationIsPopulated(rel))
                ereport(ERROR,
                        errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                        errmsg("cannot copy from unpopulated materialized view \"%s\"",
                               RelationGetRelationName(rel)),
                        errhint("Use the REFRESH MATERIALIZED VIEW command."));
        }
        else if (rel->rd_rel->relkind == RELKIND_FOREIGN_TABLE)
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("cannot copy from foreign table \"%s\"",
                            RelationGetRelationName(rel)),
                     errhint("Try the COPY (SELECT ...) TO variant.")));
        else if (rel->rd_rel->relkind == RELKIND_SEQUENCE)
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("cannot copy from sequence \"%s\"",
                            RelationGetRelationName(rel))));
        else if (rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
        {
            /*
             * Collect OIDs of relation containing data, so that later
             * DoCopyTo can copy the data from them.
             */
            children = find_all_inheritors(RelationGetRelid(rel), AccessShareLock, NULL);
 
            foreach_oid(child, children)
            {
                char        relkind = get_rel_relkind(child);
 
                if (relkind == RELKIND_FOREIGN_TABLE)
                {
                    char       *relation_name = get_rel_name(child);
 
                    ereport(ERROR,
                            errcode(ERRCODE_WRONG_OBJECT_TYPE),
                            errmsg("cannot copy from foreign table \"%s\"", relation_name),
                            errdetail("Partition \"%s\" is a foreign table in partitioned table \"%s\"",
                                      relation_name, RelationGetRelationName(rel)),
                            errhint("Try the COPY (SELECT ...) TO variant."));
                }
 
                /* Exclude tables with no data */
                if (RELKIND_HAS_PARTITIONS(relkind))
                    children = foreach_delete_current(children, child);
            }
        }
        else
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("cannot copy from non-table relation \"%s\"",
                            RelationGetRelationName(rel))));
    }
 
 
    /* Allocate workspace and zero all fields */
    cstate = palloc0_object(CopyToStateData);
 
    /*
     * We allocate everything used by a cstate in a new memory context. This
     * avoids memory leaks during repeated use of COPY in a query.
     */
    cstate->copycontext = AllocSetContextCreate(CurrentMemoryContext,
                                                "COPY",
                                                ALLOCSET_DEFAULT_SIZES);
 
    oldcontext = MemoryContextSwitchTo(cstate->copycontext);
 
    /* Extract options from the statement node tree */
    ProcessCopyOptions(pstate, &cstate->opts, false /* is_from */ , options);
 
    /* Set format routine */
    cstate->routine = CopyToGetRoutine(&cstate->opts);
 
    /* Process the source/target relation or query */
    if (rel)
    {
        Assert(!raw_query);
 
        cstate->rel = rel;
 
        tupDesc = RelationGetDescr(cstate->rel);
        cstate->partitions = children;
        cstate->tupDesc = tupDesc;
    }
    else
    {
        List       *rewritten;
        Query      *query;
        PlannedStmt *plan;
        DestReceiver *dest;
 
        cstate->rel = NULL;
        cstate->partitions = NIL;
 
        /*
         * Run parse analysis and rewrite.  Note this also acquires sufficient
         * locks on the source table(s).
         */
        rewritten = pg_analyze_and_rewrite_fixedparams(raw_query,
                                                       pstate->p_sourcetext, NULL, 0,
                                                       NULL);
 
        /* check that we got back something we can work with */
        if (rewritten == NIL)
        {
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("DO INSTEAD NOTHING rules are not supported for COPY")));
        }
        else if (list_length(rewritten) > 1)
        {
            ListCell   *lc;
 
            /* examine queries to determine which error message to issue */
            foreach(lc, rewritten)
            {
                Query      *q = lfirst_node(Query, lc);
 
                if (q->querySource == QSRC_QUAL_INSTEAD_RULE)
                    ereport(ERROR,
                            (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                             errmsg("conditional DO INSTEAD rules are not supported for COPY")));
                if (q->querySource == QSRC_NON_INSTEAD_RULE)
                    ereport(ERROR,
                            (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                             errmsg("DO ALSO rules are not supported for COPY")));
            }
 
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("multi-statement DO INSTEAD rules are not supported for COPY")));
        }
 
        query = linitial_node(Query, rewritten);
 
        /* The grammar allows SELECT INTO, but we don't support that */
        if (query->utilityStmt != NULL &&
            IsA(query->utilityStmt, CreateTableAsStmt))
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("COPY (SELECT INTO) is not supported")));
 
        /* The only other utility command we could see is NOTIFY */
        if (query->utilityStmt != NULL)
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("COPY query must not be a utility command")));
 
        /*
         * Similarly the grammar doesn't enforce the presence of a RETURNING
         * clause, but this is required here.
         */
        if (query->commandType != CMD_SELECT &&
            query->returningList == NIL)
        {
            Assert(query->commandType == CMD_INSERT ||
                   query->commandType == CMD_UPDATE ||
                   query->commandType == CMD_DELETE ||
                   query->commandType == CMD_MERGE);
 
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("COPY query must have a RETURNING clause")));
        }
 
        /* plan the query */
        plan = pg_plan_query(query, pstate->p_sourcetext,
                             CURSOR_OPT_PARALLEL_OK, NULL, NULL);
 
        /*
         * With row-level security and a user using "COPY relation TO", we
         * have to convert the "COPY relation TO" to a query-based COPY (eg:
         * "COPY (SELECT * FROM ONLY relation) TO"), to allow the rewriter to
         * add in any RLS clauses.
         *
         * When this happens, we are passed in the relid of the originally
         * found relation (which we have locked).  As the planner will look up
         * the relation again, we double-check here to make sure it found the
         * same one that we have locked.
         */
        if (queryRelId != InvalidOid)
        {
            /*
             * Note that with RLS involved there may be multiple relations,
             * and while the one we need is almost certainly first, we don't
             * make any guarantees of that in the planner, so check the whole
             * list and make sure we find the original relation.
             */
            if (!list_member_oid(plan->relationOids, queryRelId))
                ereport(ERROR,
                        (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                         errmsg("relation referenced by COPY statement has changed")));
        }
 
        /*
         * Use a snapshot with an updated command ID to ensure this query sees
         * results of any previously executed queries.
         */
        PushCopiedSnapshot(GetActiveSnapshot());
        UpdateActiveSnapshotCommandId();
 
        /* Create dest receiver for COPY OUT */
        dest = CreateDestReceiver(DestCopyOut);
        ((DR_copy *) dest)->cstate = cstate;
 
        /* Create a QueryDesc requesting no output */
        cstate->queryDesc = CreateQueryDesc(plan, pstate->p_sourcetext,
                                            GetActiveSnapshot(),
                                            InvalidSnapshot,
                                            dest, NULL, NULL, 0);
 
        /*
         * Call ExecutorStart to prepare the plan for execution.
         *
         * ExecutorStart computes a result tupdesc for us
         */
        ExecutorStart(cstate->queryDesc, 0);
 
        tupDesc = cstate->queryDesc->tupDesc;
        tupDesc = BlessTupleDesc(tupDesc);
        cstate->tupDesc = tupDesc;
    }
 
    /* Generate or convert list of attributes to process */
    cstate->attnumlist = CopyGetAttnums(tupDesc, cstate->rel, attnamelist);
 
    /* Set up JSON-specific state */
    if (cstate->opts.format == COPY_FORMAT_JSON)
    {
        cstate->json_buf = makeStringInfo();
 
        if (attnamelist != NIL && rel)
        {
            int         natts = list_length(cstate->attnumlist);
            TupleDesc   resultDesc;
 
            /*
             * Build a TupleDesc describing only the selected columns so that
             * composite_to_json() emits the right column names and types.
             */
            resultDesc = CreateTemplateTupleDesc(natts);
 
            foreach_int(attnum, cstate->attnumlist)
            {
                Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
 
                TupleDescInitEntry(resultDesc,
                                   foreach_current_index(attnum) + 1,
                                   NameStr(attr->attname),
                                   attr->atttypid,
                                   attr->atttypmod,
                                   attr->attndims);
            }
 
            TupleDescFinalize(resultDesc);
            cstate->tupDesc = BlessTupleDesc(resultDesc);
 
            /*
             * Pre-allocate arrays for projecting selected column values into
             * sequential positions matching the custom TupleDesc.
             */
            cstate->json_projvalues = palloc_array(Datum, natts);
            cstate->json_projnulls = palloc_array(bool, natts);
        }
    }
 
    num_phys_attrs = tupDesc->natts;
 
    /* Convert FORCE_QUOTE name list to per-column flags, check validity */
    cstate->opts.force_quote_flags = (bool *) palloc0(num_phys_attrs * sizeof(bool));
    if (cstate->opts.force_quote_all)
    {
        MemSet(cstate->opts.force_quote_flags, true, num_phys_attrs * sizeof(bool));
    }
    else if (cstate->opts.force_quote)
    {
        List       *attnums;
        ListCell   *cur;
 
        attnums = CopyGetAttnums(tupDesc, cstate->rel, cstate->opts.force_quote);
 
        foreach(cur, attnums)
        {
            int         attnum = lfirst_int(cur);
            Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
 
            if (!list_member_int(cstate->attnumlist, attnum))
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_COLUMN_REFERENCE),
                /*- translator: %s is the name of a COPY option, e.g. FORCE_NOT_NULL */
                         errmsg("%s column \"%s\" not referenced by COPY",
                                "FORCE_QUOTE", NameStr(attr->attname))));
            cstate->opts.force_quote_flags[attnum - 1] = true;
        }
    }
 
    /* Use client encoding when ENCODING option is not specified. */
    if (cstate->opts.file_encoding < 0)
        cstate->file_encoding = pg_get_client_encoding();
    else
        cstate->file_encoding = cstate->opts.file_encoding;
 
    /*
     * Set up encoding conversion info if the file and server encodings differ
     * (see also pg_server_to_any).
     */
    if (cstate->file_encoding == GetDatabaseEncoding() ||
        cstate->file_encoding == PG_SQL_ASCII)
        cstate->need_transcoding = false;
    else
        cstate->need_transcoding = true;
 
    /* See Multibyte encoding comment above */
    cstate->encoding_embeds_ascii = PG_ENCODING_IS_CLIENT_ONLY(cstate->file_encoding);
 
    cstate->copy_dest = COPY_FILE;  /* default */
 
    if (data_dest_cb)
    {
        progress_vals[1] = PROGRESS_COPY_TYPE_CALLBACK;
        cstate->copy_dest = COPY_CALLBACK;
        cstate->data_dest_cb = data_dest_cb;
    }
    else if (pipe)
    {
        progress_vals[1] = PROGRESS_COPY_TYPE_PIPE;
 
        Assert(!is_program);    /* the grammar does not allow this */
        if (whereToSendOutput != DestRemote)
            cstate->copy_file = stdout;
    }
    else
    {
        cstate->filename = pstrdup(filename);
        cstate->is_program = is_program;
 
        if (is_program)
        {
            progress_vals[1] = PROGRESS_COPY_TYPE_PROGRAM;
            cstate->copy_file = OpenPipeStream(cstate->filename, PG_BINARY_W);
            if (cstate->copy_file == NULL)
                ereport(ERROR,
                        (errcode_for_file_access(),
                         errmsg("could not execute command \"%s\": %m",
                                cstate->filename)));
        }
        else
        {
            mode_t      oumask; /* Pre-existing umask value */
            struct stat st;
 
            progress_vals[1] = PROGRESS_COPY_TYPE_FILE;
 
            /*
             * Prevent write to relative path ... too easy to shoot oneself in
             * the foot by overwriting a database file ...
             */
            if (!is_absolute_path(filename))
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_NAME),
                         errmsg("relative path not allowed for COPY to file")));
 
            oumask = umask(S_IWGRP | S_IWOTH);
            PG_TRY();
            {
                cstate->copy_file = AllocateFile(cstate->filename, PG_BINARY_W);
            }
            PG_FINALLY();
            {
                umask(oumask);
            }
            PG_END_TRY();
            if (cstate->copy_file == NULL)
            {
                /* copy errno because ereport subfunctions might change it */
                int         save_errno = errno;
 
                ereport(ERROR,
                        (errcode_for_file_access(),
                         errmsg("could not open file \"%s\" for writing: %m",
                                cstate->filename),
                         (save_errno == ENOENT || save_errno == EACCES) ?
                         errhint("COPY TO instructs the PostgreSQL server process to write a file. "
                                 "You may want a client-side facility such as psql's \\copy.") : 0));
            }
 
            if (fstat(fileno(cstate->copy_file), &st))
                ereport(ERROR,
                        (errcode_for_file_access(),
                         errmsg("could not stat file \"%s\": %m",
                                cstate->filename)));
 
            if (S_ISDIR(st.st_mode))
                ereport(ERROR,
                        (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                         errmsg("\"%s\" is a directory", cstate->filename)));
        }
    }
 
    /* initialize progress */
    pgstat_progress_start_command(PROGRESS_COMMAND_COPY,
                                  cstate->rel ? RelationGetRelid(cstate->rel) : InvalidOid);
    pgstat_progress_update_multi_param(2, progress_cols, progress_vals);
 
    cstate->bytes_processed = 0;
 
    MemoryContextSwitchTo(oldcontext);
 
    return cstate;
}

References AccessShareLock, AllocateFile(), ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, attnum, CopyToStateData::attnumlist, BlessTupleDesc(), CopyToStateData::bytes_processed, CMD_DELETE, CMD_INSERT, CMD_MERGE, CMD_SELECT, CMD_UPDATE, Query::commandType, COPY_CALLBACK, CopyToStateData::copy_dest, COPY_FILE, CopyToStateData::copy_file, COPY_FORMAT_JSON, CopyToStateData::copycontext, CopyGetAttnums(), CopyToGetRoutine(), CreateDestReceiver(), CreateQueryDesc(), CreateTemplateTupleDesc(), cur, CurrentMemoryContext, CURSOR_OPT_PARALLEL_OK, CopyToStateData::data_dest_cb, DestCopyOut, DestRemote, CopyToStateData::encoding_embeds_ascii, ereport, errcode(), errcode_for_file_access(), errdetail(), errhint(), errmsg, ERROR, ExecutorStart(), fb(), CopyToStateData::file_encoding, CopyFormatOptions::file_encoding, CopyToStateData::filename, filename, find_all_inheritors(), CopyFormatOptions::force_quote, CopyFormatOptions::force_quote_all, CopyFormatOptions::force_quote_flags, foreach_current_index, foreach_delete_current, foreach_int, foreach_oid, CopyFormatOptions::format, fstat, get_rel_name(), get_rel_relkind(), GetActiveSnapshot(), GetDatabaseEncoding(), InvalidOid, InvalidSnapshot, is_absolute_path, CopyToStateData::is_program, IsA, CopyToStateData::json_buf, CopyToStateData::json_projnulls, CopyToStateData::json_projvalues, lfirst_int, lfirst_node, linitial_node, list_length(), list_member_int(), list_member_oid(), makeStringInfo(), MemoryContextSwitchTo(), MemSet, NameStr, TupleDescData::natts, CopyToStateData::need_transcoding, NIL, OpenPipeStream(), CopyToStateData::opts, ParseState::p_sourcetext, palloc0(), palloc0_object, palloc_array, CopyToStateData::partitions, pg_analyze_and_rewrite_fixedparams(), PG_BINARY_W, PG_ENCODING_IS_CLIENT_ONLY, PG_END_TRY, PG_FINALLY, pg_get_client_encoding(), pg_plan_query(), PG_SQL_ASCII, PG_TRY, pgstat_progress_start_command(), pgstat_progress_update_multi_param(), plan, ProcessCopyOptions(), PROGRESS_COMMAND_COPY, PROGRESS_COPY_COMMAND, PROGRESS_COPY_COMMAND_TO, PROGRESS_COPY_TYPE, PROGRESS_COPY_TYPE_CALLBACK, PROGRESS_COPY_TYPE_FILE, PROGRESS_COPY_TYPE_PIPE, PROGRESS_COPY_TYPE_PROGRAM, pstrdup(), PushCopiedSnapshot(), QSRC_NON_INSTEAD_RULE, QSRC_QUAL_INSTEAD_RULE, CopyToStateData::queryDesc, RelationData::rd_rel, CopyToStateData::rel, RelationGetDescr, RelationGetRelationName, RelationGetRelid, RelationIsPopulated, Query::returningList, CopyToStateData::routine, S_ISDIR, S_IWGRP, S_IWOTH, stat::st_mode, CopyToStateData::tupDesc, QueryDesc::tupDesc, TupleDescAttr(), TupleDescFinalize(), TupleDescInitEntry(), UpdateActiveSnapshotCommandId(), Query::utilityStmt, and whereToSendOutput.

Referenced by DoCopy(), and test_copy_to_callback().

ClosePipeToProgram()

static void ClosePipeToProgram ( CopyToState  cstate )

static

Definition at line 704 of file copyto.c.

{
    int         pclose_rc;
 
    Assert(cstate->is_program);
 
    pclose_rc = ClosePipeStream(cstate->copy_file);
    if (pclose_rc == -1)
        ereport(ERROR,
                (errcode_for_file_access(),
                 errmsg("could not close pipe to external command: %m")));
    else if (pclose_rc != 0)
    {
        ereport(ERROR,
                (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
                 errmsg("program \"%s\" failed",
                        cstate->filename),
                 errdetail_internal("%s", wait_result_to_str(pclose_rc))));
    }
}

References Assert, ClosePipeStream(), CopyToStateData::copy_file, ereport, errcode(), errcode_for_file_access(), errdetail_internal(), errmsg, ERROR, fb(), CopyToStateData::filename, CopyToStateData::is_program, and wait_result_to_str().

Referenced by CopySendEndOfRow(), and EndCopy().

copy_dest_destroy()

static void copy_dest_destroy ( DestReceiver *  self )

static

Definition at line 1700 of file copyto.c.

{
    pfree(self);
}

References pfree().

Referenced by CreateCopyDestReceiver().

copy_dest_receive()

static bool copy_dest_receive ( TupleTableSlot *  slot, DestReceiver *  self  )

static

Definition at line 1672 of file copyto.c.

{
    DR_copy    *myState = (DR_copy *) self;
    CopyToState cstate = myState->cstate;
 
    /* Send the data */
    CopyOneRowTo(cstate, slot);
 
    /* Increment the number of processed tuples, and report the progress */
    pgstat_progress_update_param(PROGRESS_COPY_TUPLES_PROCESSED,
                                 ++myState->processed);
 
    return true;
}

References CopyOneRowTo(), fb(), pgstat_progress_update_param(), and PROGRESS_COPY_TUPLES_PROCESSED.

Referenced by CreateCopyDestReceiver().

copy_dest_shutdown()

static void copy_dest_shutdown ( DestReceiver *  self )

static

Definition at line 1691 of file copyto.c.

{
    /* no-op */
}

Referenced by CreateCopyDestReceiver().

copy_dest_startup()

static void copy_dest_startup ( DestReceiver *  self, int  operation, TupleDesc  typeinfo  )

static

Definition at line 1663 of file copyto.c.

{
    /* no-op */
}

Referenced by CreateCopyDestReceiver().

CopyAttributeOutCSV()

static void CopyAttributeOutCSV ( CopyToState  cstate, const char *  string, bool  use_quote  )

static

Definition at line 1574 of file copyto.c.

{
    const char *ptr;
    const char *start;
    char        c;
    char        delimc = cstate->opts.delim[0];
    char        quotec = cstate->opts.quote[0];
    char        escapec = cstate->opts.escape[0];
    bool        single_attr = (list_length(cstate->attnumlist) == 1);
 
    /* force quoting if it matches null_print (before conversion!) */
    if (!use_quote && strcmp(string, cstate->opts.null_print) == 0)
        use_quote = true;
 
    if (cstate->need_transcoding)
        ptr = pg_server_to_any(string, strlen(string), cstate->file_encoding);
    else
        ptr = string;
 
    /*
     * Make a preliminary pass to discover if it needs quoting
     */
    if (!use_quote)
    {
        /*
         * Quote '\.' if it appears alone on a line, so that it will not be
         * interpreted as an end-of-data marker.  (PG 18 and up will not
         * interpret '\.' in CSV that way, except in embedded-in-SQL data; but
         * we want the data to be loadable by older versions too.  Also, this
         * avoids breaking clients that are still using PQgetline().)
         */
        if (single_attr && strcmp(ptr, "\\.") == 0)
            use_quote = true;
        else
        {
            const char *tptr = ptr;
 
            while ((c = *tptr) != '\0')
            {
                if (c == delimc || c == quotec || c == '\n' || c == '\r')
                {
                    use_quote = true;
                    break;
                }
                if (IS_HIGHBIT_SET(c) && cstate->encoding_embeds_ascii)
                    tptr += pg_encoding_mblen(cstate->file_encoding, tptr);
                else
                    tptr++;
            }
        }
    }
 
    if (use_quote)
    {
        CopySendChar(cstate, quotec);
 
        /*
         * We adopt the same optimization strategy as in CopyAttributeOutText
         */
        start = ptr;
        while ((c = *ptr) != '\0')
        {
            if (c == quotec || c == escapec)
            {
                DUMPSOFAR();
                CopySendChar(cstate, escapec);
                start = ptr;    /* we include char in next run */
            }
            if (IS_HIGHBIT_SET(c) && cstate->encoding_embeds_ascii)
                ptr += pg_encoding_mblen(cstate->file_encoding, ptr);
            else
                ptr++;
        }
        DUMPSOFAR();
 
        CopySendChar(cstate, quotec);
    }
    else
    {
        /* If it doesn't need quoting, we can just dump it as-is */
        CopySendString(cstate, ptr);
    }
}

References CopyToStateData::attnumlist, CopySendChar(), CopySendString(), CopyFormatOptions::delim, DUMPSOFAR, CopyToStateData::encoding_embeds_ascii, CopyFormatOptions::escape, fb(), CopyToStateData::file_encoding, IS_HIGHBIT_SET, list_length(), CopyToStateData::need_transcoding, CopyFormatOptions::null_print, CopyToStateData::opts, pg_encoding_mblen(), pg_server_to_any(), CopyFormatOptions::quote, and start.

Referenced by CopyToTextLikeOneRow(), and CopyToTextLikeStart().

CopyAttributeOutText()

static void CopyAttributeOutText ( CopyToState  cstate, const char *  string  )

static

Definition at line 1421 of file copyto.c.

{
    const char *ptr;
    const char *start;
    char        c;
    char        delimc = cstate->opts.delim[0];
 
    if (cstate->need_transcoding)
        ptr = pg_server_to_any(string, strlen(string), cstate->file_encoding);
    else
        ptr = string;
 
    /*
     * We have to grovel through the string searching for control characters
     * and instances of the delimiter character.  In most cases, though, these
     * are infrequent.  To avoid overhead from calling CopySendData once per
     * character, we dump out all characters between escaped characters in a
     * single call.  The loop invariant is that the data from "start" to "ptr"
     * can be sent literally, but hasn't yet been.
     *
     * We can skip pg_encoding_mblen() overhead when encoding is safe, because
     * in valid backend encodings, extra bytes of a multibyte character never
     * look like ASCII.  This loop is sufficiently performance-critical that
     * it's worth making two copies of it to get the IS_HIGHBIT_SET() test out
     * of the normal safe-encoding path.
     */
    if (cstate->encoding_embeds_ascii)
    {
        start = ptr;
        while ((c = *ptr) != '\0')
        {
            if ((unsigned char) c < (unsigned char) 0x20)
            {
                /*
                 * \r and \n must be escaped, the others are traditional. We
                 * prefer to dump these using the C-like notation, rather than
                 * a backslash and the literal character, because it makes the
                 * dump file a bit more proof against Microsoftish data
                 * mangling.
                 */
                switch (c)
                {
                    case '\b':
                        c = 'b';
                        break;
                    case '\f':
                        c = 'f';
                        break;
                    case '\n':
                        c = 'n';
                        break;
                    case '\r':
                        c = 'r';
                        break;
                    case '\t':
                        c = 't';
                        break;
                    case '\v':
                        c = 'v';
                        break;
                    default:
                        /* If it's the delimiter, must backslash it */
                        if (c == delimc)
                            break;
                        /* All ASCII control chars are length 1 */
                        ptr++;
                        continue;   /* fall to end of loop */
                }
                /* if we get here, we need to convert the control char */
                DUMPSOFAR();
                CopySendChar(cstate, '\\');
                CopySendChar(cstate, c);
                start = ++ptr;  /* do not include char in next run */
            }
            else if (c == '\\' || c == delimc)
            {
                DUMPSOFAR();
                CopySendChar(cstate, '\\');
                start = ptr++;  /* we include char in next run */
            }
            else if (IS_HIGHBIT_SET(c))
                ptr += pg_encoding_mblen(cstate->file_encoding, ptr);
            else
                ptr++;
        }
    }
    else
    {
        start = ptr;
        while ((c = *ptr) != '\0')
        {
            if ((unsigned char) c < (unsigned char) 0x20)
            {
                /*
                 * \r and \n must be escaped, the others are traditional. We
                 * prefer to dump these using the C-like notation, rather than
                 * a backslash and the literal character, because it makes the
                 * dump file a bit more proof against Microsoftish data
                 * mangling.
                 */
                switch (c)
                {
                    case '\b':
                        c = 'b';
                        break;
                    case '\f':
                        c = 'f';
                        break;
                    case '\n':
                        c = 'n';
                        break;
                    case '\r':
                        c = 'r';
                        break;
                    case '\t':
                        c = 't';
                        break;
                    case '\v':
                        c = 'v';
                        break;
                    default:
                        /* If it's the delimiter, must backslash it */
                        if (c == delimc)
                            break;
                        /* All ASCII control chars are length 1 */
                        ptr++;
                        continue;   /* fall to end of loop */
                }
                /* if we get here, we need to convert the control char */
                DUMPSOFAR();
                CopySendChar(cstate, '\\');
                CopySendChar(cstate, c);
                start = ++ptr;  /* do not include char in next run */
            }
            else if (c == '\\' || c == delimc)
            {
                DUMPSOFAR();
                CopySendChar(cstate, '\\');
                start = ptr++;  /* we include char in next run */
            }
            else
                ptr++;
        }
    }
 
    DUMPSOFAR();
}

References CopySendChar(), CopyFormatOptions::delim, DUMPSOFAR, CopyToStateData::encoding_embeds_ascii, fb(), CopyToStateData::file_encoding, IS_HIGHBIT_SET, CopyToStateData::need_transcoding, CopyToStateData::opts, pg_encoding_mblen(), pg_server_to_any(), and start.

Referenced by CopyToTextLikeOneRow(), and CopyToTextLikeStart().

CopyOneRowTo()

static void CopyOneRowTo ( CopyToState  cstate, TupleTableSlot *  slot  )

inlinestatic

Definition at line 1396 of file copyto.c.

{
    MemoryContext oldcontext;
 
    MemoryContextReset(cstate->rowcontext);
    oldcontext = MemoryContextSwitchTo(cstate->rowcontext);
 
    /* Make sure the tuple is fully deconstructed */
    slot_getallattrs(slot);
 
    cstate->routine->CopyToOneRow(cstate, slot);
 
    MemoryContextSwitchTo(oldcontext);
}

References CopyToRoutine::CopyToOneRow, MemoryContextReset(), MemoryContextSwitchTo(), CopyToStateData::routine, CopyToStateData::rowcontext, and slot_getallattrs().

Referenced by copy_dest_receive(), and CopyRelationTo().

CopyRelationTo()

static void CopyRelationTo ( CopyToState  cstate, Relation  rel, Relation  root_rel, uint64 *  processed  )

static

Definition at line 1332 of file copyto.c.

{
    TupleTableSlot *slot;
    TableScanDesc scandesc;
    AttrMap    *map = NULL;
    TupleTableSlot *root_slot = NULL;
 
    scandesc = table_beginscan(rel, GetActiveSnapshot(), 0, NULL,
                               SO_NONE);
    slot = table_slot_create(rel, NULL);
 
    /*
     * If we are exporting partition data here, we check if converting tuples
     * to the root table's rowtype, because a partition might have column
     * order different than its root table.
     */
    if (root_rel != NULL)
    {
        root_slot = table_slot_create(root_rel, NULL);
        map = build_attrmap_by_name_if_req(RelationGetDescr(root_rel),
                                           RelationGetDescr(rel),
                                           false);
    }
 
    while (table_scan_getnextslot(scandesc, ForwardScanDirection, slot))
    {
        TupleTableSlot *copyslot;
 
        CHECK_FOR_INTERRUPTS();
 
        if (map != NULL)
            copyslot = execute_attr_map_slot(map, slot, root_slot);
        else
        {
            /* Deconstruct the tuple */
            slot_getallattrs(slot);
            copyslot = slot;
        }
 
        /* Format and send the data */
        CopyOneRowTo(cstate, copyslot);
 
        /*
         * Increment the number of processed tuples, and report the progress.
         */
        pgstat_progress_update_param(PROGRESS_COPY_TUPLES_PROCESSED,
                                     ++(*processed));
    }
 
    ExecDropSingleTupleTableSlot(slot);
 
    if (root_slot != NULL)
        ExecDropSingleTupleTableSlot(root_slot);
 
    if (map != NULL)
        free_attrmap(map);
 
    table_endscan(scandesc);
}

References build_attrmap_by_name_if_req(), CHECK_FOR_INTERRUPTS, CopyOneRowTo(), ExecDropSingleTupleTableSlot(), execute_attr_map_slot(), fb(), ForwardScanDirection, free_attrmap(), GetActiveSnapshot(), pgstat_progress_update_param(), PROGRESS_COPY_TUPLES_PROCESSED, RelationGetDescr, slot_getallattrs(), SO_NONE, table_beginscan(), table_endscan(), table_scan_getnextslot(), and table_slot_create().

Referenced by DoCopyTo().

CopySendChar()

static void CopySendChar ( CopyToState  cstate, char  c  )

static

Definition at line 579 of file copyto.c.

{
    appendStringInfoCharMacro(cstate->fe_msgbuf, c);
}

References appendStringInfoCharMacro, and CopyToStateData::fe_msgbuf.

Referenced by CopyAttributeOutCSV(), CopyAttributeOutText(), CopySendTextLikeEndOfRow(), CopyToJsonEnd(), CopyToJsonOneRow(), CopyToTextLikeOneRow(), and CopyToTextLikeStart().

CopySendData()

static void CopySendData ( CopyToState  cstate, const void *  databuf, int  datasize  )

static

Definition at line 567 of file copyto.c.

{
    appendBinaryStringInfo(cstate->fe_msgbuf, databuf, datasize);
}

References appendBinaryStringInfo(), fb(), and CopyToStateData::fe_msgbuf.

Referenced by CopySendInt16(), CopySendInt32(), CopyToBinaryOneRow(), CopyToBinaryStart(), and CopyToJsonOneRow().

CopySendEndOfRow()

static void CopySendEndOfRow ( CopyToState  cstate )

static

Definition at line 585 of file copyto.c.

{
    StringInfo  fe_msgbuf = cstate->fe_msgbuf;
 
    switch (cstate->copy_dest)
    {
        case COPY_FILE:
            pgstat_report_wait_start(WAIT_EVENT_COPY_TO_WRITE);
            if (fwrite(fe_msgbuf->data, fe_msgbuf->len, 1,
                       cstate->copy_file) != 1 ||
                ferror(cstate->copy_file))
            {
                if (cstate->is_program)
                {
                    if (errno == EPIPE)
                    {
                        /*
                         * The pipe will be closed automatically on error at
                         * the end of transaction, but we might get a better
                         * error message from the subprocess' exit code than
                         * just "Broken Pipe"
                         */
                        ClosePipeToProgram(cstate);
 
                        /*
                         * If ClosePipeToProgram() didn't throw an error, the
                         * program terminated normally, but closed the pipe
                         * first. Restore errno, and throw an error.
                         */
                        errno = EPIPE;
                    }
                    ereport(ERROR,
                            (errcode_for_file_access(),
                             errmsg("could not write to COPY program: %m")));
                }
                else
                    ereport(ERROR,
                            (errcode_for_file_access(),
                             errmsg("could not write to COPY file: %m")));
            }
            pgstat_report_wait_end();
            break;
        case COPY_FRONTEND:
            /* Dump the accumulated row as one CopyData message */
            (void) pq_putmessage(PqMsg_CopyData, fe_msgbuf->data, fe_msgbuf->len);
            break;
        case COPY_CALLBACK:
            cstate->data_dest_cb(fe_msgbuf->data, fe_msgbuf->len);
            break;
    }
 
    /* Update the progress */
    cstate->bytes_processed += fe_msgbuf->len;
    pgstat_progress_update_param(PROGRESS_COPY_BYTES_PROCESSED, cstate->bytes_processed);
 
    resetStringInfo(fe_msgbuf);
}

References CopyToStateData::bytes_processed, ClosePipeToProgram(), COPY_CALLBACK, CopyToStateData::copy_dest, COPY_FILE, CopyToStateData::copy_file, COPY_FRONTEND, StringInfoData::data, CopyToStateData::data_dest_cb, ereport, errcode_for_file_access(), errmsg, ERROR, fb(), CopyToStateData::fe_msgbuf, CopyToStateData::is_program, StringInfoData::len, pgstat_progress_update_param(), pgstat_report_wait_end(), pgstat_report_wait_start(), pq_putmessage, PqMsg_CopyData, PROGRESS_COPY_BYTES_PROCESSED, and resetStringInfo().

Referenced by CopySendTextLikeEndOfRow(), CopyToBinaryEnd(), and CopyToBinaryOneRow().

CopySendInt16()

static void CopySendInt16 ( CopyToState  cstate, int16  val  )

inlinestatic

Definition at line 692 of file copyto.c.

{
    uint16      buf;
 
    buf = pg_hton16((uint16) val);
    CopySendData(cstate, &buf, sizeof(buf));
}

References buf, CopySendData(), pg_hton16, and val.

Referenced by CopyToBinaryEnd(), and CopyToBinaryOneRow().

CopySendInt32()

static void CopySendInt32 ( CopyToState  cstate, int32  val  )

inlinestatic

Definition at line 680 of file copyto.c.

{
    uint32      buf;
 
    buf = pg_hton32((uint32) val);
    CopySendData(cstate, &buf, sizeof(buf));
}

References buf, CopySendData(), pg_hton32, and val.

Referenced by CopyToBinaryOneRow(), and CopyToBinaryStart().

CopySendString()

static void CopySendString ( CopyToState  cstate, const char *  str  )

static

Definition at line 573 of file copyto.c.

{
    appendBinaryStringInfo(cstate->fe_msgbuf, str, strlen(str));
}

References appendBinaryStringInfo(), fb(), CopyToStateData::fe_msgbuf, and str.

Referenced by CopyAttributeOutCSV(), CopySendTextLikeEndOfRow(), and CopyToTextLikeOneRow().

CopySendTextLikeEndOfRow()

static void CopySendTextLikeEndOfRow ( CopyToState  cstate )

inlinestatic

Definition at line 648 of file copyto.c.

{
    switch (cstate->copy_dest)
    {
        case COPY_FILE:
            /* Default line termination depends on platform */
#ifndef WIN32
            CopySendChar(cstate, '\n');
#else
            CopySendString(cstate, "\r\n");
#endif
            break;
        case COPY_FRONTEND:
            /* The FE/BE protocol uses \n as newline for all platforms */
            CopySendChar(cstate, '\n');
            break;
        default:
            break;
    }
 
    /* Now take the actions related to the end of a row */
    CopySendEndOfRow(cstate);
}

References CopyToStateData::copy_dest, COPY_FILE, COPY_FRONTEND, CopySendChar(), CopySendEndOfRow(), and CopySendString().

Referenced by CopyToJsonEnd(), CopyToJsonOneRow(), CopyToTextLikeOneRow(), and CopyToTextLikeStart().

CopyToBinaryEnd()

static void CopyToBinaryEnd ( CopyToState  cstate )

static

Definition at line 504 of file copyto.c.

{
    /* Generate trailer for a binary copy */
    CopySendInt16(cstate, -1);
    /* Need to flush out the trailer */
    CopySendEndOfRow(cstate);
}

References CopySendEndOfRow(), and CopySendInt16().

CopyToBinaryOneRow()

static void CopyToBinaryOneRow ( CopyToState  cstate, TupleTableSlot *  slot  )

static

Definition at line 471 of file copyto.c.

{
    FmgrInfo   *out_functions = cstate->out_functions;
 
    /* Binary per-tuple header */
    CopySendInt16(cstate, list_length(cstate->attnumlist));
 
    foreach_int(attnum, cstate->attnumlist)
    {
        Datum       value = slot->tts_values[attnum - 1];
        bool        isnull = slot->tts_isnull[attnum - 1];
 
        if (isnull)
        {
            CopySendInt32(cstate, -1);
        }
        else
        {
            bytea      *outputbytes;
 
            outputbytes = SendFunctionCall(&out_functions[attnum - 1],
                                           value);
            CopySendInt32(cstate, VARSIZE(outputbytes) - VARHDRSZ);
            CopySendData(cstate, VARDATA(outputbytes),
                         VARSIZE(outputbytes) - VARHDRSZ);
        }
    }
 
    CopySendEndOfRow(cstate);
}

References attnum, CopyToStateData::attnumlist, CopySendData(), CopySendEndOfRow(), CopySendInt16(), CopySendInt32(), fb(), foreach_int, list_length(), CopyToStateData::out_functions, SendFunctionCall(), TupleTableSlot::tts_isnull, TupleTableSlot::tts_values, value, VARDATA(), VARHDRSZ, and VARSIZE().

CopyToBinaryOutFunc()

static void CopyToBinaryOutFunc ( CopyToState  cstate, Oid  atttypid, FmgrInfo *  finfo  )

static

Definition at line 459 of file copyto.c.

{
    Oid         func_oid;
    bool        is_varlena;
 
    /* Set output function for an attribute */
    getTypeBinaryOutputInfo(atttypid, &func_oid, &is_varlena);
    fmgr_info(func_oid, finfo);
}

References fb(), fmgr_info(), and getTypeBinaryOutputInfo().

CopyToBinaryStart()

static void CopyToBinaryStart ( CopyToState  cstate, TupleDesc  tupDesc  )

static

Definition at line 440 of file copyto.c.

{
    int32       tmp;
 
    /* Signature */
    CopySendData(cstate, BinarySignature, 11);
    /* Flags field */
    tmp = 0;
    CopySendInt32(cstate, tmp);
    /* No header extension */
    tmp = 0;
    CopySendInt32(cstate, tmp);
}

References BinarySignature, CopySendData(), and CopySendInt32().

CopyToCSVOneRow()

static void CopyToCSVOneRow ( CopyToState  cstate, TupleTableSlot *  slot  )

static

Definition at line 289 of file copyto.c.

{
    CopyToTextLikeOneRow(cstate, slot, true);
}

References CopyToTextLikeOneRow().

CopyToGetRoutine()

static const CopyToRoutine * CopyToGetRoutine ( const CopyFormatOptions *  opts )

static

Definition at line 201 of file copyto.c.

{
    if (opts->format == COPY_FORMAT_CSV)
        return &CopyToRoutineCSV;
    else if (opts->format == COPY_FORMAT_BINARY)
        return &CopyToRoutineBinary;
    else if (opts->format == COPY_FORMAT_JSON)
        return &CopyToRoutineJson;
 
    /* default is text */
    return &CopyToRoutineText;
}

References COPY_FORMAT_BINARY, COPY_FORMAT_CSV, COPY_FORMAT_JSON, CopyToRoutineBinary, CopyToRoutineCSV, CopyToRoutineJson, CopyToRoutineText, and opts.

Referenced by BeginCopyTo().

CopyToJsonEnd()

static void CopyToJsonEnd ( CopyToState  cstate )

static

Definition at line 348 of file copyto.c.

{
    if (cstate->opts.force_array)
    {
        CopySendChar(cstate, ']');
        CopySendTextLikeEndOfRow(cstate);
    }
}

References CopySendChar(), CopySendTextLikeEndOfRow(), CopyFormatOptions::force_array, and CopyToStateData::opts.

CopyToJsonOneRow()

static void CopyToJsonOneRow ( CopyToState  cstate, TupleTableSlot *  slot  )

static

Definition at line 359 of file copyto.c.

{
    Datum       rowdata;
 
    resetStringInfo(cstate->json_buf);
 
    if (cstate->json_projvalues != NULL)
    {
        /*
         * Column list case: project selected column values into sequential
         * positions matching the custom TupleDesc, then form a new tuple.
         */
        HeapTuple   tup;
        int         i = 0;
 
        foreach_int(attnum, cstate->attnumlist)
        {
            cstate->json_projvalues[i] = slot->tts_values[attnum - 1];
            cstate->json_projnulls[i] = slot->tts_isnull[attnum - 1];
            i++;
        }
 
        tup = heap_form_tuple(cstate->tupDesc,
                              cstate->json_projvalues,
                              cstate->json_projnulls);
 
        /*
         * heap_form_tuple already stamps the datum-length, type-id, and
         * type-mod fields on t_data, so we can use it directly as a composite
         * Datum without the extra pallocmemcpy that heap_copy_tuple_as_datum
         * would do.  Any TOAST pointers in the projected values will be
         * detoasted by the per-column output functions called from
         * composite_to_json.
         */
        rowdata = HeapTupleGetDatum(tup);
    }
    else
    {
        /*
         * Full table or query without column list.  For queries, the slot's
         * TupleDesc may carry RECORDOID, which is not registered in the type
         * cache and would cause composite_to_json's lookup_rowtype_tupdesc
         * call to fail.  Build a HeapTuple stamped with the blessed
         * descriptor so the type can be looked up correctly.
         */
        if (!cstate->rel && slot->tts_tupleDescriptor->tdtypeid == RECORDOID)
        {
            HeapTuple   tup = heap_form_tuple(cstate->tupDesc,
                                              slot->tts_values,
                                              slot->tts_isnull);
 
            rowdata = HeapTupleGetDatum(tup);
        }
        else
            rowdata = ExecFetchSlotHeapTupleDatum(slot);
    }
 
    composite_to_json(rowdata, cstate->json_buf, false);
 
    if (cstate->opts.force_array)
    {
        if (cstate->json_row_delim_needed)
            CopySendChar(cstate, ',');
        else
        {
            /* first row needs no delimiter */
            CopySendChar(cstate, ' ');
            cstate->json_row_delim_needed = true;
        }
    }
 
    CopySendData(cstate, cstate->json_buf->data, cstate->json_buf->len);
 
    CopySendTextLikeEndOfRow(cstate);
}

References attnum, CopyToStateData::attnumlist, composite_to_json(), CopySendChar(), CopySendData(), CopySendTextLikeEndOfRow(), StringInfoData::data, ExecFetchSlotHeapTupleDatum(), fb(), CopyFormatOptions::force_array, foreach_int, heap_form_tuple(), HeapTupleGetDatum(), i, CopyToStateData::json_buf, CopyToStateData::json_projnulls, CopyToStateData::json_projvalues, CopyToStateData::json_row_delim_needed, StringInfoData::len, CopyToStateData::opts, CopyToStateData::rel, resetStringInfo(), TupleDescData::tdtypeid, TupleTableSlot::tts_isnull, TupleTableSlot::tts_tupleDescriptor, TupleTableSlot::tts_values, and CopyToStateData::tupDesc.

CopyToTextLikeEnd()

static void CopyToTextLikeEnd ( CopyToState  cstate )

static

Definition at line 341 of file copyto.c.

{
    /* Nothing to do here */
}

CopyToTextLikeOneRow()

static pg_attribute_always_inline void CopyToTextLikeOneRow ( CopyToState  cstate, TupleTableSlot *  slot, bool  is_csv  )

static

Definition at line 301 of file copyto.c.

{
    bool        need_delim = false;
    FmgrInfo   *out_functions = cstate->out_functions;
 
    foreach_int(attnum, cstate->attnumlist)
    {
        Datum       value = slot->tts_values[attnum - 1];
        bool        isnull = slot->tts_isnull[attnum - 1];
 
        if (need_delim)
            CopySendChar(cstate, cstate->opts.delim[0]);
        need_delim = true;
 
        if (isnull)
        {
            CopySendString(cstate, cstate->opts.null_print_client);
        }
        else
        {
            char       *string;
 
            string = OutputFunctionCall(&out_functions[attnum - 1],
                                        value);
 
            if (is_csv)
                CopyAttributeOutCSV(cstate, string,
                                    cstate->opts.force_quote_flags[attnum - 1]);
            else
                CopyAttributeOutText(cstate, string);
        }
    }
 
    CopySendTextLikeEndOfRow(cstate);
}

References attnum, CopyToStateData::attnumlist, CopyAttributeOutCSV(), CopyAttributeOutText(), CopySendChar(), CopySendString(), CopySendTextLikeEndOfRow(), CopyFormatOptions::delim, fb(), CopyFormatOptions::force_quote_flags, foreach_int, CopyFormatOptions::null_print_client, CopyToStateData::opts, CopyToStateData::out_functions, OutputFunctionCall(), TupleTableSlot::tts_isnull, TupleTableSlot::tts_values, and value.

Referenced by CopyToCSVOneRow(), and CopyToTextOneRow().

CopyToTextLikeOutFunc()

static void CopyToTextLikeOutFunc ( CopyToState  cstate, Oid  atttypid, FmgrInfo *  finfo  )

static

Definition at line 270 of file copyto.c.

{
    Oid         func_oid;
    bool        is_varlena;
 
    /* Set output function for an attribute */
    getTypeOutputInfo(atttypid, &func_oid, &is_varlena);
    fmgr_info(func_oid, finfo);
}

References fb(), fmgr_info(), and getTypeOutputInfo().

CopyToTextLikeStart()

static void CopyToTextLikeStart ( CopyToState  cstate, TupleDesc  tupDesc  )

static

Definition at line 216 of file copyto.c.

{
    /*
     * For non-binary copy, we need to convert null_print to file encoding,
     * because it will be sent directly with CopySendString.
     */
    if (cstate->need_transcoding)
        cstate->opts.null_print_client = pg_server_to_any(cstate->opts.null_print,
                                                          cstate->opts.null_print_len,
                                                          cstate->file_encoding);
 
    /* if a header has been requested send the line */
    if (cstate->opts.header_line == COPY_HEADER_TRUE)
    {
        ListCell   *cur;
        bool        hdr_delim = false;
 
        Assert(cstate->opts.format != COPY_FORMAT_JSON);
 
        foreach(cur, cstate->attnumlist)
        {
            int         attnum = lfirst_int(cur);
            char       *colname;
 
            if (hdr_delim)
                CopySendChar(cstate, cstate->opts.delim[0]);
            hdr_delim = true;
 
            colname = NameStr(TupleDescAttr(tupDesc, attnum - 1)->attname);
 
            if (cstate->opts.format == COPY_FORMAT_CSV)
                CopyAttributeOutCSV(cstate, colname, false);
            else
                CopyAttributeOutText(cstate, colname);
        }
 
        CopySendTextLikeEndOfRow(cstate);
    }
 
    /*
     * If FORCE_ARRAY has been specified, send the opening bracket.
     */
    if (cstate->opts.format == COPY_FORMAT_JSON && cstate->opts.force_array)
    {
        CopySendChar(cstate, '[');
        CopySendTextLikeEndOfRow(cstate);
    }
}

References Assert, attname, attnum, CopyToStateData::attnumlist, COPY_FORMAT_CSV, COPY_FORMAT_JSON, COPY_HEADER_TRUE, CopyAttributeOutCSV(), CopyAttributeOutText(), CopySendChar(), CopySendTextLikeEndOfRow(), cur, CopyFormatOptions::delim, fb(), CopyToStateData::file_encoding, CopyFormatOptions::force_array, CopyFormatOptions::format, CopyFormatOptions::header_line, lfirst_int, NameStr, CopyToStateData::need_transcoding, CopyFormatOptions::null_print, CopyFormatOptions::null_print_client, CopyFormatOptions::null_print_len, CopyToStateData::opts, pg_server_to_any(), and TupleDescAttr().

CopyToTextOneRow()

static void CopyToTextOneRow ( CopyToState  cstate, TupleTableSlot *  slot  )

static

Definition at line 282 of file copyto.c.

{
    CopyToTextLikeOneRow(cstate, slot, false);
}

References CopyToTextLikeOneRow().

CreateCopyDestReceiver()

DestReceiver * CreateCopyDestReceiver

(

void

)

Definition at line 1709 of file copyto.c.

{
    DR_copy    *self = palloc_object(DR_copy);
 
    self->pub.receiveSlot = copy_dest_receive;
    self->pub.rStartup = copy_dest_startup;
    self->pub.rShutdown = copy_dest_shutdown;
    self->pub.rDestroy = copy_dest_destroy;
    self->pub.mydest = DestCopyOut;
 
    self->cstate = NULL;        /* will be set later */
    self->processed = 0;
 
    return (DestReceiver *) self;
}

References copy_dest_destroy(), copy_dest_receive(), copy_dest_shutdown(), copy_dest_startup(), DR_copy::cstate, DestCopyOut, fb(), _DestReceiver::mydest, palloc_object, DR_copy::processed, DR_copy::pub, _DestReceiver::rDestroy, _DestReceiver::receiveSlot, _DestReceiver::rShutdown, and _DestReceiver::rStartup.

Referenced by CreateDestReceiver().

DoCopyTo()

uint64 DoCopyTo

(

CopyToState

cstate

)

Definition at line 1241 of file copyto.c.

{
    bool        pipe = (cstate->filename == NULL && cstate->data_dest_cb == NULL);
    bool        fe_copy = (pipe && whereToSendOutput == DestRemote);
    TupleDesc   tupDesc;
    int         num_phys_attrs;
    ListCell   *cur;
    uint64      processed = 0;
 
    if (fe_copy)
        SendCopyBegin(cstate);
 
    if (cstate->rel)
        tupDesc = RelationGetDescr(cstate->rel);
    else
        tupDesc = cstate->queryDesc->tupDesc;
    num_phys_attrs = tupDesc->natts;
    cstate->opts.null_print_client = cstate->opts.null_print;   /* default */
 
    /* We use fe_msgbuf as a per-row buffer regardless of copy_dest */
    cstate->fe_msgbuf = makeStringInfo();
 
    /* Get info about the columns we need to process. */
    cstate->out_functions = (FmgrInfo *) palloc(num_phys_attrs * sizeof(FmgrInfo));
    foreach(cur, cstate->attnumlist)
    {
        int         attnum = lfirst_int(cur);
        Form_pg_attribute attr = TupleDescAttr(tupDesc, attnum - 1);
 
        cstate->routine->CopyToOutFunc(cstate, attr->atttypid,
                                       &cstate->out_functions[attnum - 1]);
    }
 
    /*
     * Create a temporary memory context that we can reset once per row to
     * recover palloc'd memory.  This avoids any problems with leaks inside
     * datatype output routines, and should be faster than retail pfree's
     * anyway.  (We don't need a whole econtext as CopyFrom does.)
     */
    cstate->rowcontext = AllocSetContextCreate(CurrentMemoryContext,
                                               "COPY TO",
                                               ALLOCSET_DEFAULT_SIZES);
 
    cstate->routine->CopyToStart(cstate, tupDesc);
 
    if (cstate->rel)
    {
        /*
         * If COPY TO source table is a partitioned table, then open each
         * partition and process each individual partition.
         */
        if (cstate->rel->rd_rel->relkind == RELKIND_PARTITIONED_TABLE)
        {
            foreach_oid(child, cstate->partitions)
            {
                Relation    scan_rel;
 
                /* We already got the lock in BeginCopyTo */
                scan_rel = table_open(child, NoLock);
                CopyRelationTo(cstate, scan_rel, cstate->rel, &processed);
                table_close(scan_rel, NoLock);
            }
        }
        else
            CopyRelationTo(cstate, cstate->rel, NULL, &processed);
    }
    else
    {
        /* run the plan --- the dest receiver will send tuples */
        ExecutorRun(cstate->queryDesc, ForwardScanDirection, 0);
        processed = ((DR_copy *) cstate->queryDesc->dest)->processed;
    }
 
    cstate->routine->CopyToEnd(cstate);
 
    MemoryContextDelete(cstate->rowcontext);
 
    if (fe_copy)
        SendCopyEnd(cstate);
 
    return processed;
}

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, attnum, CopyToStateData::attnumlist, CopyRelationTo(), CopyToRoutine::CopyToEnd, CopyToRoutine::CopyToOutFunc, CopyToRoutine::CopyToStart, cur, CurrentMemoryContext, CopyToStateData::data_dest_cb, QueryDesc::dest, DestRemote, ExecutorRun(), fb(), CopyToStateData::fe_msgbuf, CopyToStateData::filename, foreach_oid, ForwardScanDirection, lfirst_int, makeStringInfo(), MemoryContextDelete(), TupleDescData::natts, NoLock, CopyFormatOptions::null_print, CopyFormatOptions::null_print_client, CopyToStateData::opts, CopyToStateData::out_functions, palloc(), CopyToStateData::partitions, CopyToStateData::queryDesc, RelationData::rd_rel, CopyToStateData::rel, RelationGetDescr, CopyToStateData::routine, CopyToStateData::rowcontext, SendCopyBegin(), SendCopyEnd(), table_close(), table_open(), QueryDesc::tupDesc, TupleDescAttr(), and whereToSendOutput.

Referenced by DoCopy(), and test_copy_to_callback().

EndCopy()

static void EndCopy ( CopyToState  cstate )

static

Definition at line 729 of file copyto.c.

{
    if (cstate->is_program)
    {
        ClosePipeToProgram(cstate);
    }
    else
    {
        if (cstate->filename != NULL && FreeFile(cstate->copy_file))
            ereport(ERROR,
                    (errcode_for_file_access(),
                     errmsg("could not close file \"%s\": %m",
                            cstate->filename)));
    }
 
    pgstat_progress_end_command();
 
    MemoryContextDelete(cstate->copycontext);
 
    if (cstate->partitions)
        list_free(cstate->partitions);
 
    pfree(cstate);
}

References ClosePipeToProgram(), CopyToStateData::copy_file, CopyToStateData::copycontext, ereport, errcode_for_file_access(), errmsg, ERROR, fb(), CopyToStateData::filename, FreeFile(), CopyToStateData::is_program, list_free(), MemoryContextDelete(), CopyToStateData::partitions, pfree(), and pgstat_progress_end_command().

Referenced by EndCopyTo().

EndCopyTo()

void EndCopyTo

(

CopyToState

cstate

)

Definition at line 1220 of file copyto.c.

{
    if (cstate->queryDesc != NULL)
    {
        /* Close down the query and free resources. */
        ExecutorFinish(cstate->queryDesc);
        ExecutorEnd(cstate->queryDesc);
        FreeQueryDesc(cstate->queryDesc);
        PopActiveSnapshot();
    }
 
    /* Clean up storage */
    EndCopy(cstate);
}

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

Referenced by DoCopy(), and test_copy_to_callback().

SendCopyBegin()

static void SendCopyBegin ( CopyToState  cstate )

static

Definition at line 517 of file copyto.c.

{
    StringInfoData buf;
    int         natts = list_length(cstate->attnumlist);
    int16       format = (cstate->opts.format == COPY_FORMAT_BINARY ? 1 : 0);
    int         i;
 
    pq_beginmessage(&buf, PqMsg_CopyOutResponse);
    pq_sendbyte(&buf, format);  /* overall format */
    if (cstate->opts.format != COPY_FORMAT_JSON)
    {
        pq_sendint16(&buf, natts);
        for (i = 0; i < natts; i++)
            pq_sendint16(&buf, format); /* per-column formats */
    }
    else
    {
        /*
         * For JSON format, report one text-format column.  Each CopyData
         * message contains one complete JSON object, not individual column
         * values, so the per-column count is always 1.
         */
        pq_sendint16(&buf, 1);
        pq_sendint16(&buf, 0);
    }
 
    pq_endmessage(&buf);
    cstate->copy_dest = COPY_FRONTEND;
}

References CopyToStateData::attnumlist, buf, CopyToStateData::copy_dest, COPY_FORMAT_BINARY, COPY_FORMAT_JSON, COPY_FRONTEND, format, CopyFormatOptions::format, i, list_length(), CopyToStateData::opts, pq_beginmessage(), pq_endmessage(), pq_sendbyte(), pq_sendint16(), and PqMsg_CopyOutResponse.

Referenced by DoCopyTo().

SendCopyEnd()

static void SendCopyEnd ( CopyToState  cstate )

static

Definition at line 548 of file copyto.c.

{
    /* Shouldn't have any unsent data */
    Assert(cstate->fe_msgbuf->len == 0);
    /* Send Copy Done message */
    pq_putemptymessage(PqMsg_CopyDone);
}

References Assert, CopyToStateData::fe_msgbuf, StringInfoData::len, pq_putemptymessage(), and PqMsg_CopyDone.

Referenced by DoCopyTo().

Variable Documentation

BinarySignature

const char BinarySignature[11] = "PGCOPY\n\377\r\n\0"

static

Definition at line 124 of file copyto.c.

Referenced by CopyToBinaryStart().

CopyToRoutineBinary

const CopyToRoutine CopyToRoutineBinary

static

Initial value:

= {
    .CopyToStart = CopyToBinaryStart,
    .CopyToOutFunc = CopyToBinaryOutFunc,
    .CopyToOneRow = CopyToBinaryOneRow,
    .CopyToEnd = CopyToBinaryEnd,
}

Definition at line 192 of file copyto.c.

                                                 {
    .CopyToStart = CopyToBinaryStart,
    .CopyToOutFunc = CopyToBinaryOutFunc,
    .CopyToOneRow = CopyToBinaryOneRow,
    .CopyToEnd = CopyToBinaryEnd,
};

Referenced by CopyToGetRoutine().

CopyToRoutineCSV

const CopyToRoutine CopyToRoutineCSV

static

Initial value:

= {
    .CopyToStart = CopyToTextLikeStart,
    .CopyToOutFunc = CopyToTextLikeOutFunc,
    .CopyToOneRow = CopyToCSVOneRow,
    .CopyToEnd = CopyToTextLikeEnd,
}

Definition at line 176 of file copyto.c.

                                              {
    .CopyToStart = CopyToTextLikeStart,
    .CopyToOutFunc = CopyToTextLikeOutFunc,
    .CopyToOneRow = CopyToCSVOneRow,
    .CopyToEnd = CopyToTextLikeEnd,
};

Referenced by CopyToGetRoutine().

CopyToRoutineJson

const CopyToRoutine CopyToRoutineJson

static

Initial value:

= {
    .CopyToStart = CopyToTextLikeStart,
    .CopyToOutFunc = CopyToTextLikeOutFunc,
    .CopyToOneRow = CopyToJsonOneRow,
    .CopyToEnd = CopyToJsonEnd,
}

Definition at line 184 of file copyto.c.

                                               {
    .CopyToStart = CopyToTextLikeStart,
    .CopyToOutFunc = CopyToTextLikeOutFunc,
    .CopyToOneRow = CopyToJsonOneRow,
    .CopyToEnd = CopyToJsonEnd,
};

Referenced by CopyToGetRoutine().

CopyToRoutineText

const CopyToRoutine CopyToRoutineText

static

Initial value:

= {
    .CopyToStart = CopyToTextLikeStart,
    .CopyToOutFunc = CopyToTextLikeOutFunc,
    .CopyToOneRow = CopyToTextOneRow,
    .CopyToEnd = CopyToTextLikeEnd,
}

Definition at line 168 of file copyto.c.

                                               {
    .CopyToStart = CopyToTextLikeStart,
    .CopyToOutFunc = CopyToTextLikeOutFunc,
    .CopyToOneRow = CopyToTextOneRow,
    .CopyToEnd = CopyToTextLikeEnd,
};

Referenced by CopyToGetRoutine().