PostgreSQL Source Code  git master
file_fdw.c File Reference
#include "postgres.h"
#include <sys/stat.h>
#include <unistd.h>
#include "access/htup_details.h"
#include "access/reloptions.h"
#include "access/sysattr.h"
#include "access/table.h"
#include "catalog/pg_authid.h"
#include "catalog/pg_foreign_table.h"
#include "commands/copy.h"
#include "commands/defrem.h"
#include "commands/explain.h"
#include "commands/vacuum.h"
#include "foreign/fdwapi.h"
#include "foreign/foreign.h"
#include "miscadmin.h"
#include "nodes/makefuncs.h"
#include "optimizer/optimizer.h"
#include "optimizer/pathnode.h"
#include "optimizer/planmain.h"
#include "optimizer/restrictinfo.h"
#include "utils/memutils.h"
#include "utils/rel.h"
#include "utils/sampling.h"
Include dependency graph for file_fdw.c:

Go to the source code of this file.

Data Structures

struct  FileFdwOption
 
struct  FileFdwPlanState
 
struct  FileFdwExecutionState
 

Typedefs

typedef struct FileFdwPlanState FileFdwPlanState
 
typedef struct FileFdwExecutionState FileFdwExecutionState
 

Functions

 PG_FUNCTION_INFO_V1 (file_fdw_handler)
 
 PG_FUNCTION_INFO_V1 (file_fdw_validator)
 
static void fileGetForeignRelSize (PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid)
 
static void fileGetForeignPaths (PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid)
 
static ForeignScanfileGetForeignPlan (PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid, ForeignPath *best_path, List *tlist, List *scan_clauses, Plan *outer_plan)
 
static void fileExplainForeignScan (ForeignScanState *node, ExplainState *es)
 
static void fileBeginForeignScan (ForeignScanState *node, int eflags)
 
static TupleTableSlotfileIterateForeignScan (ForeignScanState *node)
 
static void fileReScanForeignScan (ForeignScanState *node)
 
static void fileEndForeignScan (ForeignScanState *node)
 
static bool fileAnalyzeForeignTable (Relation relation, AcquireSampleRowsFunc *func, BlockNumber *totalpages)
 
static bool fileIsForeignScanParallelSafe (PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
 
static bool is_valid_option (const char *option, Oid context)
 
static void fileGetOptions (Oid foreigntableid, char **filename, bool *is_program, List **other_options)
 
static Listget_file_fdw_attribute_options (Oid relid)
 
static bool check_selective_binary_conversion (RelOptInfo *baserel, Oid foreigntableid, List **columns)
 
static void estimate_size (PlannerInfo *root, RelOptInfo *baserel, FileFdwPlanState *fdw_private)
 
static void estimate_costs (PlannerInfo *root, RelOptInfo *baserel, FileFdwPlanState *fdw_private, Cost *startup_cost, Cost *total_cost)
 
static int file_acquire_sample_rows (Relation onerel, int elevel, HeapTuple *rows, int targrows, double *totalrows, double *totaldeadrows)
 
Datum file_fdw_handler (PG_FUNCTION_ARGS)
 
Datum file_fdw_validator (PG_FUNCTION_ARGS)
 

Variables

 PG_MODULE_MAGIC
 
static const struct FileFdwOption valid_options []
 

Typedef Documentation

◆ FileFdwExecutionState

◆ FileFdwPlanState

Function Documentation

◆ check_selective_binary_conversion()

static bool check_selective_binary_conversion ( RelOptInfo baserel,
Oid  foreigntableid,
List **  columns 
)
static

Definition at line 847 of file file_fdw.c.

References AccessShareLock, attname, attnum, RelOptInfo::baserestrictinfo, bms_first_member(), RestrictInfo::clause, defGetString(), DefElem::defname, PathTarget::exprs, FirstLowInvalidHeapAttributeNumber, format, GetForeignTable(), i, lappend(), lfirst, list_length(), makeString(), NameStr, TupleDescData::natts, NIL, ForeignTable::options, pstrdup(), pull_varattnos(), RelationGetDescr, RelOptInfo::relid, RelOptInfo::reltarget, table_close(), table_open(), and TupleDescAttr.

Referenced by fileGetForeignPaths().

850 {
851  ForeignTable *table;
852  ListCell *lc;
853  Relation rel;
854  TupleDesc tupleDesc;
856  Bitmapset *attrs_used = NULL;
857  bool has_wholerow = false;
858  int numattrs;
859  int i;
860 
861  *columns = NIL; /* default result */
862 
863  /*
864  * Check format of the file. If binary format, this is irrelevant.
865  */
866  table = GetForeignTable(foreigntableid);
867  foreach(lc, table->options)
868  {
869  DefElem *def = (DefElem *) lfirst(lc);
870 
871  if (strcmp(def->defname, "format") == 0)
872  {
873  char *format = defGetString(def);
874 
875  if (strcmp(format, "binary") == 0)
876  return false;
877  break;
878  }
879  }
880 
881  /* Collect all the attributes needed for joins or final output. */
882  pull_varattnos((Node *) baserel->reltarget->exprs, baserel->relid,
883  &attrs_used);
884 
885  /* Add all the attributes used by restriction clauses. */
886  foreach(lc, baserel->baserestrictinfo)
887  {
888  RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
889 
890  pull_varattnos((Node *) rinfo->clause, baserel->relid,
891  &attrs_used);
892  }
893 
894  /* Convert attribute numbers to column names. */
895  rel = table_open(foreigntableid, AccessShareLock);
896  tupleDesc = RelationGetDescr(rel);
897 
898  while ((attnum = bms_first_member(attrs_used)) >= 0)
899  {
900  /* Adjust for system attributes. */
902 
903  if (attnum == 0)
904  {
905  has_wholerow = true;
906  break;
907  }
908 
909  /* Ignore system attributes. */
910  if (attnum < 0)
911  continue;
912 
913  /* Get user attributes. */
914  if (attnum > 0)
915  {
916  Form_pg_attribute attr = TupleDescAttr(tupleDesc, attnum - 1);
917  char *attname = NameStr(attr->attname);
918 
919  /* Skip dropped attributes (probably shouldn't see any here). */
920  if (attr->attisdropped)
921  continue;
922 
923  /*
924  * Skip generated columns (COPY won't accept them in the column
925  * list)
926  */
927  if (attr->attgenerated)
928  continue;
929  *columns = lappend(*columns, makeString(pstrdup(attname)));
930  }
931  }
932 
933  /* Count non-dropped user attributes while we have the tupdesc. */
934  numattrs = 0;
935  for (i = 0; i < tupleDesc->natts; i++)
936  {
937  Form_pg_attribute attr = TupleDescAttr(tupleDesc, i);
938 
939  if (attr->attisdropped)
940  continue;
941  numattrs++;
942  }
943 
945 
946  /* If there's a whole-row reference, fail: we need all the columns. */
947  if (has_wholerow)
948  {
949  *columns = NIL;
950  return false;
951  }
952 
953  /* If all the user attributes are needed, fail. */
954  if (numattrs == list_length(*columns))
955  {
956  *columns = NIL;
957  return false;
958  }
959 
960  return true;
961 }
Value * makeString(char *str)
Definition: value.c:53
#define NIL
Definition: pg_list.h:65
int bms_first_member(Bitmapset *a)
Definition: bitmapset.c:996
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define RelationGetDescr(relation)
Definition: rel.h:445
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
char * pstrdup(const char *in)
Definition: mcxt.c:1186
List * baserestrictinfo
Definition: pathnodes.h:703
#define AccessShareLock
Definition: lockdefs.h:36
Definition: nodes.h:525
ForeignTable * GetForeignTable(Oid relid)
Definition: foreign.c:248
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
void pull_varattnos(Node *node, Index varno, Bitmapset **varattnos)
Definition: var.c:219
NameData attname
Definition: pg_attribute.h:40
char * defGetString(DefElem *def)
Definition: define.c:49
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200
Index relid
Definition: pathnodes.h:669
List * lappend(List *list, void *datum)
Definition: list.c:322
Expr * clause
Definition: pathnodes.h:1943
List * exprs
Definition: pathnodes.h:1044
int16 attnum
Definition: pg_attribute.h:79
#define lfirst(lc)
Definition: pg_list.h:190
static int list_length(const List *l)
Definition: pg_list.h:169
List * options
Definition: foreign.h:57
int i
#define NameStr(name)
Definition: c.h:609
char * defname
Definition: parsenodes.h:730
static char format
Definition: pg_basebackup.c:85
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
struct PathTarget * reltarget
Definition: pathnodes.h:652
int16 AttrNumber
Definition: attnum.h:21

◆ estimate_costs()

static void estimate_costs ( PlannerInfo root,
RelOptInfo baserel,
FileFdwPlanState fdw_private,
Cost startup_cost,
Cost total_cost 
)
static

Definition at line 1052 of file file_fdw.c.

References RelOptInfo::baserestrictcost, cpu_tuple_cost, FileFdwPlanState::ntuples, FileFdwPlanState::pages, QualCost::per_tuple, seq_page_cost, and QualCost::startup.

Referenced by fileGetForeignPaths().

1055 {
1056  BlockNumber pages = fdw_private->pages;
1057  double ntuples = fdw_private->ntuples;
1058  Cost run_cost = 0;
1059  Cost cpu_per_tuple;
1060 
1061  /*
1062  * We estimate costs almost the same way as cost_seqscan(), thus assuming
1063  * that I/O costs are equivalent to a regular table file of the same size.
1064  * However, we take per-tuple CPU costs as 10x of a seqscan, to account
1065  * for the cost of parsing records.
1066  *
1067  * In the case of a program source, this calculation is even more divorced
1068  * from reality, but we have no good alternative; and it's not clear that
1069  * the numbers we produce here matter much anyway, since there's only one
1070  * access path for the rel.
1071  */
1072  run_cost += seq_page_cost * pages;
1073 
1074  *startup_cost = baserel->baserestrictcost.startup;
1075  cpu_per_tuple = cpu_tuple_cost * 10 + baserel->baserestrictcost.per_tuple;
1076  run_cost += cpu_per_tuple * ntuples;
1077  *total_cost = *startup_cost + run_cost;
1078 }
BlockNumber pages
Definition: file_fdw.c:94
uint32 BlockNumber
Definition: block.h:31
Cost startup
Definition: pathnodes.h:45
double ntuples
Definition: file_fdw.c:95
Cost per_tuple
Definition: pathnodes.h:46
double cpu_tuple_cost
Definition: costsize.c:112
double seq_page_cost
Definition: costsize.c:110
QualCost baserestrictcost
Definition: pathnodes.h:704
double Cost
Definition: nodes.h:659

◆ estimate_size()

static void estimate_size ( PlannerInfo root,
RelOptInfo baserel,
FileFdwPlanState fdw_private 
)
static

Definition at line 971 of file file_fdw.c.

References RelOptInfo::baserestrictinfo, clamp_row_est(), clauselist_selectivity(), FileFdwPlanState::filename, FileFdwPlanState::is_program, JOIN_INNER, MAXALIGN, FileFdwPlanState::ntuples, FileFdwPlanState::pages, RelOptInfo::pages, RelOptInfo::reltarget, RelOptInfo::rows, SizeofHeapTupleHeader, stat, RelOptInfo::tuples, and PathTarget::width.

Referenced by fileGetForeignRelSize().

973 {
974  struct stat stat_buf;
975  BlockNumber pages;
976  double ntuples;
977  double nrows;
978 
979  /*
980  * Get size of the file. It might not be there at plan time, though, in
981  * which case we have to use a default estimate. We also have to fall
982  * back to the default if using a program as the input.
983  */
984  if (fdw_private->is_program || stat(fdw_private->filename, &stat_buf) < 0)
985  stat_buf.st_size = 10 * BLCKSZ;
986 
987  /*
988  * Convert size to pages for use in I/O cost estimate later.
989  */
990  pages = (stat_buf.st_size + (BLCKSZ - 1)) / BLCKSZ;
991  if (pages < 1)
992  pages = 1;
993  fdw_private->pages = pages;
994 
995  /*
996  * Estimate the number of tuples in the file.
997  */
998  if (baserel->pages > 0)
999  {
1000  /*
1001  * We have # of pages and # of tuples from pg_class (that is, from a
1002  * previous ANALYZE), so compute a tuples-per-page estimate and scale
1003  * that by the current file size.
1004  */
1005  double density;
1006 
1007  density = baserel->tuples / (double) baserel->pages;
1008  ntuples = clamp_row_est(density * (double) pages);
1009  }
1010  else
1011  {
1012  /*
1013  * Otherwise we have to fake it. We back into this estimate using the
1014  * planner's idea of the relation width; which is bogus if not all
1015  * columns are being read, not to mention that the text representation
1016  * of a row probably isn't the same size as its internal
1017  * representation. Possibly we could do something better, but the
1018  * real answer to anyone who complains is "ANALYZE" ...
1019  */
1020  int tuple_width;
1021 
1022  tuple_width = MAXALIGN(baserel->reltarget->width) +
1024  ntuples = clamp_row_est((double) stat_buf.st_size /
1025  (double) tuple_width);
1026  }
1027  fdw_private->ntuples = ntuples;
1028 
1029  /*
1030  * Now estimate the number of rows returned by the scan after applying the
1031  * baserestrictinfo quals.
1032  */
1033  nrows = ntuples *
1035  baserel->baserestrictinfo,
1036  0,
1037  JOIN_INNER,
1038  NULL);
1039 
1040  nrows = clamp_row_est(nrows);
1041 
1042  /* Save the output-rows estimate for the planner */
1043  baserel->rows = nrows;
1044 }
#define SizeofHeapTupleHeader
Definition: htup_details.h:184
BlockNumber pages
Definition: file_fdw.c:94
double tuples
Definition: pathnodes.h:681
List * baserestrictinfo
Definition: pathnodes.h:703
uint32 BlockNumber
Definition: block.h:31
double ntuples
Definition: file_fdw.c:95
struct stat stat_buf
Definition: pg_standby.c:101
char * filename
Definition: file_fdw.c:90
#define stat(a, b)
Definition: win32_port.h:255
double rows
Definition: pathnodes.h:644
BlockNumber pages
Definition: pathnodes.h:680
#define MAXALIGN(LEN)
Definition: c.h:685
Selectivity clauselist_selectivity(PlannerInfo *root, List *clauses, int varRelid, JoinType jointype, SpecialJoinInfo *sjinfo)
Definition: clausesel.c:70
double clamp_row_est(double nrows)
Definition: costsize.c:187
struct PathTarget * reltarget
Definition: pathnodes.h:652

◆ file_acquire_sample_rows()

static int file_acquire_sample_rows ( Relation  onerel,
int  elevel,
HeapTuple rows,
int  targrows,
double *  totalrows,
double *  totaldeadrows 
)
static

Definition at line 1095 of file file_fdw.c.

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, ErrorContextCallback::arg, Assert, BeginCopyFrom(), ErrorContextCallback::callback, CopyFromErrorCallback(), CurrentMemoryContext, EndCopyFrom(), ereport, errmsg(), error_context_stack, fileGetOptions(), filename, heap_form_tuple(), heap_freetuple(), MemoryContextDelete(), MemoryContextReset(), MemoryContextSwitchTo(), TupleDescData::natts, NextCopyFrom(), NIL, options, palloc(), pfree(), ErrorContextCallback::previous, ReservoirStateData::randstate, RelationGetDescr, RelationGetRelationName, RelationGetRelid, reservoir_get_next_S(), reservoir_init_selection_state(), sampler_random_fract(), vacuum_delay_point(), and values.

Referenced by fileAnalyzeForeignTable().

1098 {
1099  int numrows = 0;
1100  double rowstoskip = -1; /* -1 means not set yet */
1101  ReservoirStateData rstate;
1102  TupleDesc tupDesc;
1103  Datum *values;
1104  bool *nulls;
1105  bool found;
1106  char *filename;
1107  bool is_program;
1108  List *options;
1109  CopyState cstate;
1110  ErrorContextCallback errcallback;
1111  MemoryContext oldcontext = CurrentMemoryContext;
1112  MemoryContext tupcontext;
1113 
1114  Assert(onerel);
1115  Assert(targrows > 0);
1116 
1117  tupDesc = RelationGetDescr(onerel);
1118  values = (Datum *) palloc(tupDesc->natts * sizeof(Datum));
1119  nulls = (bool *) palloc(tupDesc->natts * sizeof(bool));
1120 
1121  /* Fetch options of foreign table */
1122  fileGetOptions(RelationGetRelid(onerel), &filename, &is_program, &options);
1123 
1124  /*
1125  * Create CopyState from FDW options.
1126  */
1127  cstate = BeginCopyFrom(NULL, onerel, filename, is_program, NULL, NIL,
1128  options);
1129 
1130  /*
1131  * Use per-tuple memory context to prevent leak of memory used to read
1132  * rows from the file with Copy routines.
1133  */
1135  "file_fdw temporary context",
1137 
1138  /* Prepare for sampling rows */
1139  reservoir_init_selection_state(&rstate, targrows);
1140 
1141  /* Set up callback to identify error line number. */
1142  errcallback.callback = CopyFromErrorCallback;
1143  errcallback.arg = (void *) cstate;
1144  errcallback.previous = error_context_stack;
1145  error_context_stack = &errcallback;
1146 
1147  *totalrows = 0;
1148  *totaldeadrows = 0;
1149  for (;;)
1150  {
1151  /* Check for user-requested abort or sleep */
1153 
1154  /* Fetch next row */
1155  MemoryContextReset(tupcontext);
1156  MemoryContextSwitchTo(tupcontext);
1157 
1158  found = NextCopyFrom(cstate, NULL, values, nulls);
1159 
1160  MemoryContextSwitchTo(oldcontext);
1161 
1162  if (!found)
1163  break;
1164 
1165  /*
1166  * The first targrows sample rows are simply copied into the
1167  * reservoir. Then we start replacing tuples in the sample until we
1168  * reach the end of the relation. This algorithm is from Jeff Vitter's
1169  * paper (see more info in commands/analyze.c).
1170  */
1171  if (numrows < targrows)
1172  {
1173  rows[numrows++] = heap_form_tuple(tupDesc, values, nulls);
1174  }
1175  else
1176  {
1177  /*
1178  * t in Vitter's paper is the number of records already processed.
1179  * If we need to compute a new S value, we must use the
1180  * not-yet-incremented value of totalrows as t.
1181  */
1182  if (rowstoskip < 0)
1183  rowstoskip = reservoir_get_next_S(&rstate, *totalrows, targrows);
1184 
1185  if (rowstoskip <= 0)
1186  {
1187  /*
1188  * Found a suitable tuple, so save it, replacing one old tuple
1189  * at random
1190  */
1191  int k = (int) (targrows * sampler_random_fract(rstate.randstate));
1192 
1193  Assert(k >= 0 && k < targrows);
1194  heap_freetuple(rows[k]);
1195  rows[k] = heap_form_tuple(tupDesc, values, nulls);
1196  }
1197 
1198  rowstoskip -= 1;
1199  }
1200 
1201  *totalrows += 1;
1202  }
1203 
1204  /* Remove error callback. */
1205  error_context_stack = errcallback.previous;
1206 
1207  /* Clean up. */
1208  MemoryContextDelete(tupcontext);
1209 
1210  EndCopyFrom(cstate);
1211 
1212  pfree(values);
1213  pfree(nulls);
1214 
1215  /*
1216  * Emit some interesting relation info
1217  */
1218  ereport(elevel,
1219  (errmsg("\"%s\": file contains %.0f rows; "
1220  "%d rows in sample",
1221  RelationGetRelationName(onerel),
1222  *totalrows, numrows)));
1223 
1224  return numrows;
1225 }
#define NIL
Definition: pg_list.h:65
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
#define AllocSetContextCreate
Definition: memutils.h:170
void CopyFromErrorCallback(void *arg)
Definition: copy.c:2239
#define RelationGetDescr(relation)
Definition: rel.h:445
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:3387
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
double sampler_random_fract(SamplerRandomState randstate)
Definition: sampling.c:238
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:136
void reservoir_init_selection_state(ReservoirState rs, int n)
Definition: sampling.c:129
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:1020
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
void(* callback)(void *arg)
Definition: elog.h:254
struct ErrorContextCallback * previous
Definition: elog.h:253
ErrorContextCallback * error_context_stack
Definition: elog.c:88
void pfree(void *pointer)
Definition: mcxt.c:1056
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
#define RelationGetRelationName(relation)
Definition: rel.h:453
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
#define ereport(elevel, rest)
Definition: elog.h:141
static void fileGetOptions(Oid foreigntableid, char **filename, bool *is_program, List **other_options)
Definition: file_fdw.c:356
static char ** options
static int elevel
Definition: vacuumlazy.c:143
uintptr_t Datum
Definition: postgres.h:367
void EndCopyFrom(CopyState cstate)
Definition: copy.c:3876
#define Assert(condition)
Definition: c.h:732
bool NextCopyFrom(CopyState cstate, ExprContext *econtext, Datum *values, bool *nulls)
Definition: copy.c:3688
static Datum values[MAXATTR]
Definition: bootstrap.c:167
static char * filename
Definition: pg_dumpall.c:91
void * palloc(Size size)
Definition: mcxt.c:949
int errmsg(const char *fmt,...)
Definition: elog.c:784
void vacuum_delay_point(void)
Definition: vacuum.c:1946
Definition: pg_list.h:50
#define RelationGetRelid(relation)
Definition: rel.h:419
SamplerRandomState randstate
Definition: sampling.h:50
double reservoir_get_next_S(ReservoirState rs, double t, int n)
Definition: sampling.c:142

◆ file_fdw_handler()

Datum file_fdw_handler ( PG_FUNCTION_ARGS  )

Definition at line 170 of file file_fdw.c.

References FdwRoutine::AnalyzeForeignTable, FdwRoutine::BeginForeignScan, FdwRoutine::EndForeignScan, FdwRoutine::ExplainForeignScan, fileAnalyzeForeignTable(), fileBeginForeignScan(), fileEndForeignScan(), fileExplainForeignScan(), fileGetForeignPaths(), fileGetForeignPlan(), fileGetForeignRelSize(), fileIsForeignScanParallelSafe(), fileIterateForeignScan(), fileReScanForeignScan(), FdwRoutine::GetForeignPaths, FdwRoutine::GetForeignPlan, FdwRoutine::GetForeignRelSize, FdwRoutine::IsForeignScanParallelSafe, FdwRoutine::IterateForeignScan, makeNode, PG_RETURN_POINTER, and FdwRoutine::ReScanForeignScan.

171 {
172  FdwRoutine *fdwroutine = makeNode(FdwRoutine);
173 
175  fdwroutine->GetForeignPaths = fileGetForeignPaths;
176  fdwroutine->GetForeignPlan = fileGetForeignPlan;
181  fdwroutine->EndForeignScan = fileEndForeignScan;
184 
185  PG_RETURN_POINTER(fdwroutine);
186 }
GetForeignPlan_function GetForeignPlan
Definition: fdwapi.h:190
BeginForeignScan_function BeginForeignScan
Definition: fdwapi.h:191
#define PG_RETURN_POINTER(x)
Definition: fmgr.h:351
static bool fileIsForeignScanParallelSafe(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
Definition: file_fdw.c:831
static void fileEndForeignScan(ForeignScanState *node)
Definition: file_fdw.c:766
ExplainForeignScan_function ExplainForeignScan
Definition: fdwapi.h:229
AnalyzeForeignTable_function AnalyzeForeignTable
Definition: fdwapi.h:234
IsForeignScanParallelSafe_function IsForeignScanParallelSafe
Definition: fdwapi.h:240
static TupleTableSlot * fileIterateForeignScan(ForeignScanState *node)
Definition: file_fdw.c:704
GetForeignRelSize_function GetForeignRelSize
Definition: fdwapi.h:188
EndForeignScan_function EndForeignScan
Definition: fdwapi.h:194
static bool fileAnalyzeForeignTable(Relation relation, AcquireSampleRowsFunc *func, BlockNumber *totalpages)
Definition: file_fdw.c:780
static void fileBeginForeignScan(ForeignScanState *node, int eflags)
Definition: file_fdw.c:651
GetForeignPaths_function GetForeignPaths
Definition: fdwapi.h:189
static void fileGetForeignPaths(PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid)
Definition: file_fdw.c:531
#define makeNode(_type_)
Definition: nodes.h:573
static void fileGetForeignRelSize(PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid)
Definition: file_fdw.c:500
ReScanForeignScan_function ReScanForeignScan
Definition: fdwapi.h:193
IterateForeignScan_function IterateForeignScan
Definition: fdwapi.h:192
static void fileExplainForeignScan(ForeignScanState *node, ExplainState *es)
Definition: file_fdw.c:619
static void fileReScanForeignScan(ForeignScanState *node)
Definition: file_fdw.c:746
static ForeignScan * fileGetForeignPlan(PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid, ForeignPath *best_path, List *tlist, List *scan_clauses, Plan *outer_plan)
Definition: file_fdw.c:584

◆ file_fdw_validator()

Datum file_fdw_validator ( PG_FUNCTION_ARGS  )

Definition at line 195 of file file_fdw.c.

References appendStringInfo(), buf, StringInfoData::data, defGetBoolean(), defGetString(), DefElem::defname, ereport, errcode(), errhint(), errmsg(), ERROR, filename, GetUserId(), initStringInfo(), is_member_of_role(), is_valid_option(), lappend(), StringInfoData::len, lfirst, NIL, FileFdwOption::optcontext, FileFdwOption::optname, PG_GETARG_DATUM, PG_GETARG_OID, PG_RETURN_VOID, ProcessCopyOptions(), and untransformRelOptions().

196 {
197  List *options_list = untransformRelOptions(PG_GETARG_DATUM(0));
198  Oid catalog = PG_GETARG_OID(1);
199  char *filename = NULL;
200  DefElem *force_not_null = NULL;
201  DefElem *force_null = NULL;
202  List *other_options = NIL;
203  ListCell *cell;
204 
205  /*
206  * Check that only options supported by file_fdw, and allowed for the
207  * current object type, are given.
208  */
209  foreach(cell, options_list)
210  {
211  DefElem *def = (DefElem *) lfirst(cell);
212 
213  if (!is_valid_option(def->defname, catalog))
214  {
215  const struct FileFdwOption *opt;
217 
218  /*
219  * Unknown option specified, complain about it. Provide a hint
220  * with list of valid options for the object.
221  */
222  initStringInfo(&buf);
223  for (opt = valid_options; opt->optname; opt++)
224  {
225  if (catalog == opt->optcontext)
226  appendStringInfo(&buf, "%s%s", (buf.len > 0) ? ", " : "",
227  opt->optname);
228  }
229 
230  ereport(ERROR,
231  (errcode(ERRCODE_FDW_INVALID_OPTION_NAME),
232  errmsg("invalid option \"%s\"", def->defname),
233  buf.len > 0
234  ? errhint("Valid options in this context are: %s",
235  buf.data)
236  : errhint("There are no valid options in this context.")));
237  }
238 
239  /*
240  * Separate out filename, program, and column-specific options, since
241  * ProcessCopyOptions won't accept them.
242  */
243  if (strcmp(def->defname, "filename") == 0 ||
244  strcmp(def->defname, "program") == 0)
245  {
246  if (filename)
247  ereport(ERROR,
248  (errcode(ERRCODE_SYNTAX_ERROR),
249  errmsg("conflicting or redundant options")));
250 
251  /*
252  * Check permissions for changing which file or program is used by
253  * the file_fdw.
254  *
255  * Only members of the role 'pg_read_server_files' are allowed to
256  * set the 'filename' option of a file_fdw foreign table, while
257  * only members of the role 'pg_execute_server_program' are
258  * allowed to set the 'program' option. This is because we don't
259  * want regular users to be able to control which file gets read
260  * or which program gets executed.
261  *
262  * Putting this sort of permissions check in a validator is a bit
263  * of a crock, but there doesn't seem to be any other place that
264  * can enforce the check more cleanly.
265  *
266  * Note that the valid_options[] array disallows setting filename
267  * and program at any options level other than foreign table ---
268  * otherwise there'd still be a security hole.
269  */
270  if (strcmp(def->defname, "filename") == 0 &&
271  !is_member_of_role(GetUserId(), DEFAULT_ROLE_READ_SERVER_FILES))
272  ereport(ERROR,
273  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
274  errmsg("only superuser or a member of the pg_read_server_files role may specify the filename option of a file_fdw foreign table")));
275 
276  if (strcmp(def->defname, "program") == 0 &&
277  !is_member_of_role(GetUserId(), DEFAULT_ROLE_EXECUTE_SERVER_PROGRAM))
278  ereport(ERROR,
279  (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
280  errmsg("only superuser or a member of the pg_execute_server_program role may specify the program option of a file_fdw foreign table")));
281 
282  filename = defGetString(def);
283  }
284 
285  /*
286  * force_not_null is a boolean option; after validation we can discard
287  * it - it will be retrieved later in get_file_fdw_attribute_options()
288  */
289  else if (strcmp(def->defname, "force_not_null") == 0)
290  {
291  if (force_not_null)
292  ereport(ERROR,
293  (errcode(ERRCODE_SYNTAX_ERROR),
294  errmsg("conflicting or redundant options"),
295  errhint("Option \"force_not_null\" supplied more than once for a column.")));
296  force_not_null = def;
297  /* Don't care what the value is, as long as it's a legal boolean */
298  (void) defGetBoolean(def);
299  }
300  /* See comments for force_not_null above */
301  else if (strcmp(def->defname, "force_null") == 0)
302  {
303  if (force_null)
304  ereport(ERROR,
305  (errcode(ERRCODE_SYNTAX_ERROR),
306  errmsg("conflicting or redundant options"),
307  errhint("Option \"force_null\" supplied more than once for a column.")));
308  force_null = def;
309  (void) defGetBoolean(def);
310  }
311  else
312  other_options = lappend(other_options, def);
313  }
314 
315  /*
316  * Now apply the core COPY code's validation logic for more checks.
317  */
318  ProcessCopyOptions(NULL, NULL, true, other_options);
319 
320  /*
321  * Either filename or program option is required for file_fdw foreign
322  * tables.
323  */
324  if (catalog == ForeignTableRelationId && filename == NULL)
325  ereport(ERROR,
326  (errcode(ERRCODE_FDW_DYNAMIC_PARAMETER_VALUE_NEEDED),
327  errmsg("either filename or program is required for file_fdw foreign tables")));
328 
329  PG_RETURN_VOID();
330 }
#define NIL
Definition: pg_list.h:65
Oid optcontext
Definition: file_fdw.c:48
int errhint(const char *fmt,...)
Definition: elog.c:974
static const struct FileFdwOption valid_options[]
Definition: file_fdw.c:60
Oid GetUserId(void)
Definition: miscinit.c:380
#define PG_GETARG_DATUM(n)
Definition: fmgr.h:263
void ProcessCopyOptions(ParseState *pstate, CopyState cstate, bool is_from, List *options)
Definition: copy.c:1110
int errcode(int sqlerrcode)
Definition: elog.c:570
unsigned int Oid
Definition: postgres_ext.h:31
bool defGetBoolean(DefElem *def)
Definition: define.c:111
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:78
#define ERROR
Definition: elog.h:43
char * defGetString(DefElem *def)
Definition: define.c:49
static char * buf
Definition: pg_test_fsync.c:68
#define PG_GETARG_OID(n)
Definition: fmgr.h:270
#define ereport(elevel, rest)
Definition: elog.h:141
List * lappend(List *list, void *datum)
Definition: list.c:322
void initStringInfo(StringInfo str)
Definition: stringinfo.c:46
const char * optname
Definition: file_fdw.c:47
List * untransformRelOptions(Datum options)
Definition: reloptions.c:1030
#define PG_RETURN_VOID()
Definition: fmgr.h:339
bool is_member_of_role(Oid member, Oid role)
Definition: acl.c:4932
#define lfirst(lc)
Definition: pg_list.h:190
static bool is_valid_option(const char *option, Oid context)
Definition: file_fdw.c:337
static char * filename
Definition: pg_dumpall.c:91
int errmsg(const char *fmt,...)
Definition: elog.c:784
char * defname
Definition: parsenodes.h:730
Definition: pg_list.h:50

◆ fileAnalyzeForeignTable()

static bool fileAnalyzeForeignTable ( Relation  relation,
AcquireSampleRowsFunc func,
BlockNumber totalpages 
)
static

Definition at line 780 of file file_fdw.c.

References ereport, errcode_for_file_access(), errmsg(), ERROR, file_acquire_sample_rows(), fileGetOptions(), filename, options, RelationGetRelid, and stat.

Referenced by file_fdw_handler().

783 {
784  char *filename;
785  bool is_program;
786  List *options;
787  struct stat stat_buf;
788 
789  /* Fetch options of foreign table */
790  fileGetOptions(RelationGetRelid(relation), &filename, &is_program, &options);
791 
792  /*
793  * If this is a program instead of a file, just return false to skip
794  * analyzing the table. We could run the program and collect stats on
795  * whatever it currently returns, but it seems likely that in such cases
796  * the output would be too volatile for the stats to be useful. Maybe
797  * there should be an option to enable doing this?
798  */
799  if (is_program)
800  return false;
801 
802  /*
803  * Get size of the file. (XXX if we fail here, would it be better to just
804  * return false to skip analyzing the table?)
805  */
806  if (stat(filename, &stat_buf) < 0)
807  ereport(ERROR,
809  errmsg("could not stat file \"%s\": %m",
810  filename)));
811 
812  /*
813  * Convert size to pages. Must return at least 1 so that we can tell
814  * later on that pg_class.relpages is not default.
815  */
816  *totalpages = (stat_buf.st_size + (BLCKSZ - 1)) / BLCKSZ;
817  if (*totalpages < 1)
818  *totalpages = 1;
819 
820  *func = file_acquire_sample_rows;
821 
822  return true;
823 }
static int file_acquire_sample_rows(Relation onerel, int elevel, HeapTuple *rows, int targrows, double *totalrows, double *totaldeadrows)
Definition: file_fdw.c:1095
#define ERROR
Definition: elog.h:43
struct stat stat_buf
Definition: pg_standby.c:101
int errcode_for_file_access(void)
Definition: elog.c:593
#define ereport(elevel, rest)
Definition: elog.h:141
static void fileGetOptions(Oid foreigntableid, char **filename, bool *is_program, List **other_options)
Definition: file_fdw.c:356
static char ** options
#define stat(a, b)
Definition: win32_port.h:255
static char * filename
Definition: pg_dumpall.c:91
int errmsg(const char *fmt,...)
Definition: elog.c:784
Definition: pg_list.h:50
#define RelationGetRelid(relation)
Definition: rel.h:419

◆ fileBeginForeignScan()

static void fileBeginForeignScan ( ForeignScanState node,
int  eflags 
)
static

Definition at line 651 of file file_fdw.c.

References BeginCopyFrom(), EXEC_FLAG_EXPLAIN_ONLY, ForeignScan::fdw_private, ForeignScanState::fdw_state, fileGetOptions(), filename, list_concat(), NIL, options, palloc(), PlanState::plan, ScanState::ps, RelationGetRelid, ForeignScanState::ss, and ScanState::ss_currentRelation.

Referenced by file_fdw_handler().

652 {
653  ForeignScan *plan = (ForeignScan *) node->ss.ps.plan;
654  char *filename;
655  bool is_program;
656  List *options;
657  CopyState cstate;
658  FileFdwExecutionState *festate;
659 
660  /*
661  * Do nothing in EXPLAIN (no ANALYZE) case. node->fdw_state stays NULL.
662  */
663  if (eflags & EXEC_FLAG_EXPLAIN_ONLY)
664  return;
665 
666  /* Fetch options of foreign table */
668  &filename, &is_program, &options);
669 
670  /* Add any options from the plan (currently only convert_selectively) */
672 
673  /*
674  * Create CopyState from FDW options. We always acquire all columns, so
675  * as to match the expected ScanTupleSlot signature.
676  */
677  cstate = BeginCopyFrom(NULL,
678  node->ss.ss_currentRelation,
679  filename,
680  is_program,
681  NULL,
682  NIL,
683  options);
684 
685  /*
686  * Save state in node->fdw_state. We must save enough information to call
687  * BeginCopyFrom() again.
688  */
689  festate = (FileFdwExecutionState *) palloc(sizeof(FileFdwExecutionState));
690  festate->filename = filename;
691  festate->is_program = is_program;
692  festate->options = options;
693  festate->cstate = cstate;
694 
695  node->fdw_state = (void *) festate;
696 }
#define NIL
Definition: pg_list.h:65
ScanState ss
Definition: execnodes.h:1785
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:3387
List * fdw_private
Definition: plannodes.h:614
List * list_concat(List *list1, const List *list2)
Definition: list.c:516
Relation ss_currentRelation
Definition: execnodes.h:1332
PlanState ps
Definition: execnodes.h:1331
static void fileGetOptions(Oid foreigntableid, char **filename, bool *is_program, List **other_options)
Definition: file_fdw.c:356
static char ** options
Plan * plan
Definition: execnodes.h:940
static char * filename
Definition: pg_dumpall.c:91
void * palloc(Size size)
Definition: mcxt.c:949
Definition: pg_list.h:50
#define EXEC_FLAG_EXPLAIN_ONLY
Definition: executor.h:56
#define RelationGetRelid(relation)
Definition: rel.h:419

◆ fileEndForeignScan()

static void fileEndForeignScan ( ForeignScanState node)
static

Definition at line 766 of file file_fdw.c.

References FileFdwExecutionState::cstate, EndCopyFrom(), and ForeignScanState::fdw_state.

Referenced by file_fdw_handler().

767 {
769 
770  /* if festate is NULL, we are in EXPLAIN; nothing to do */
771  if (festate)
772  EndCopyFrom(festate->cstate);
773 }
void EndCopyFrom(CopyState cstate)
Definition: copy.c:3876

◆ fileExplainForeignScan()

static void fileExplainForeignScan ( ForeignScanState node,
ExplainState es 
)
static

Definition at line 619 of file file_fdw.c.

References ExplainState::costs, ExplainPropertyInteger(), ExplainPropertyText(), fileGetOptions(), filename, options, RelationGetRelid, ForeignScanState::ss, ScanState::ss_currentRelation, and stat.

Referenced by file_fdw_handler().

620 {
621  char *filename;
622  bool is_program;
623  List *options;
624 
625  /* Fetch options --- we only need filename and is_program at this point */
627  &filename, &is_program, &options);
628 
629  if (is_program)
630  ExplainPropertyText("Foreign Program", filename, es);
631  else
632  ExplainPropertyText("Foreign File", filename, es);
633 
634  /* Suppress file size if we're not showing cost details */
635  if (es->costs)
636  {
637  struct stat stat_buf;
638 
639  if (!is_program &&
640  stat(filename, &stat_buf) == 0)
641  ExplainPropertyInteger("Foreign File Size", "b",
642  (int64) stat_buf.st_size, es);
643  }
644 }
ScanState ss
Definition: execnodes.h:1785
void ExplainPropertyInteger(const char *qlabel, const char *unit, int64 value, ExplainState *es)
Definition: explain.c:3584
Relation ss_currentRelation
Definition: execnodes.h:1332
bool costs
Definition: explain.h:34
void ExplainPropertyText(const char *qlabel, const char *value, ExplainState *es)
Definition: explain.c:3575
struct stat stat_buf
Definition: pg_standby.c:101
static void fileGetOptions(Oid foreigntableid, char **filename, bool *is_program, List **other_options)
Definition: file_fdw.c:356
static char ** options
#define stat(a, b)
Definition: win32_port.h:255
static char * filename
Definition: pg_dumpall.c:91
Definition: pg_list.h:50
#define RelationGetRelid(relation)
Definition: rel.h:419

◆ fileGetForeignPaths()

static void fileGetForeignPaths ( PlannerInfo root,
RelOptInfo baserel,
Oid  foreigntableid 
)
static

Definition at line 531 of file file_fdw.c.

References add_path(), check_selective_binary_conversion(), create_foreignscan_path(), estimate_costs(), RelOptInfo::fdw_private, RelOptInfo::lateral_relids, list_make1, makeDefElem(), NIL, and RelOptInfo::rows.

Referenced by file_fdw_handler().

534 {
535  FileFdwPlanState *fdw_private = (FileFdwPlanState *) baserel->fdw_private;
536  Cost startup_cost;
537  Cost total_cost;
538  List *columns;
539  List *coptions = NIL;
540 
541  /* Decide whether to selectively perform binary conversion */
543  foreigntableid,
544  &columns))
545  coptions = list_make1(makeDefElem("convert_selectively",
546  (Node *) columns, -1));
547 
548  /* Estimate costs */
549  estimate_costs(root, baserel, fdw_private,
550  &startup_cost, &total_cost);
551 
552  /*
553  * Create a ForeignPath node and add it as only possible path. We use the
554  * fdw_private list of the path to carry the convert_selectively option;
555  * it will be propagated into the fdw_private list of the Plan node.
556  *
557  * We don't support pushing join clauses into the quals of this path, but
558  * it could still have required parameterization due to LATERAL refs in
559  * its tlist.
560  */
561  add_path(baserel, (Path *)
562  create_foreignscan_path(root, baserel,
563  NULL, /* default pathtarget */
564  baserel->rows,
565  startup_cost,
566  total_cost,
567  NIL, /* no pathkeys */
568  baserel->lateral_relids,
569  NULL, /* no extra plan */
570  coptions));
571 
572  /*
573  * If data file was sorted, and we knew it somehow, we could insert
574  * appropriate pathkeys into the ForeignPath node to tell the planner
575  * that.
576  */
577 }
#define NIL
Definition: pg_list.h:65
void add_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:423
Definition: nodes.h:525
DefElem * makeDefElem(char *name, Node *arg, int location)
Definition: makefuncs.c:544
#define list_make1(x1)
Definition: pg_list.h:227
Relids lateral_relids
Definition: pathnodes.h:666
ForeignPath * create_foreignscan_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, double rows, Cost startup_cost, Cost total_cost, List *pathkeys, Relids required_outer, Path *fdw_outerpath, List *fdw_private)
Definition: pathnode.c:2100
double rows
Definition: pathnodes.h:644
void * fdw_private
Definition: pathnodes.h:695
static bool check_selective_binary_conversion(RelOptInfo *baserel, Oid foreigntableid, List **columns)
Definition: file_fdw.c:847
static void estimate_costs(PlannerInfo *root, RelOptInfo *baserel, FileFdwPlanState *fdw_private, Cost *startup_cost, Cost *total_cost)
Definition: file_fdw.c:1052
Definition: pg_list.h:50
double Cost
Definition: nodes.h:659

◆ fileGetForeignPlan()

static ForeignScan * fileGetForeignPlan ( PlannerInfo root,
RelOptInfo baserel,
Oid  foreigntableid,
ForeignPath best_path,
List tlist,
List scan_clauses,
Plan outer_plan 
)
static

Definition at line 584 of file file_fdw.c.

References extract_actual_clauses(), ForeignPath::fdw_private, make_foreignscan(), NIL, and RelOptInfo::relid.

Referenced by file_fdw_handler().

591 {
592  Index scan_relid = baserel->relid;
593 
594  /*
595  * We have no native ability to evaluate restriction clauses, so we just
596  * put all the scan_clauses into the plan node's qual list for the
597  * executor to check. So all we have to do here is strip RestrictInfo
598  * nodes from the clauses and ignore pseudoconstants (which will be
599  * handled elsewhere).
600  */
601  scan_clauses = extract_actual_clauses(scan_clauses, false);
602 
603  /* Create the ForeignScan node */
604  return make_foreignscan(tlist,
605  scan_clauses,
606  scan_relid,
607  NIL, /* no expressions to evaluate */
608  best_path->fdw_private,
609  NIL, /* no custom tlist */
610  NIL, /* no remote quals */
611  outer_plan);
612 }
#define NIL
Definition: pg_list.h:65
Index relid
Definition: pathnodes.h:669
unsigned int Index
Definition: c.h:475
List * extract_actual_clauses(List *restrictinfo_list, bool pseudoconstant)
Definition: restrictinfo.c:422
ForeignScan * make_foreignscan(List *qptlist, List *qpqual, Index scanrelid, List *fdw_exprs, List *fdw_private, List *fdw_scan_tlist, List *fdw_recheck_quals, Plan *outer_plan)
Definition: createplan.c:5429
List * fdw_private
Definition: pathnodes.h:1320

◆ fileGetForeignRelSize()

static void fileGetForeignRelSize ( PlannerInfo root,
RelOptInfo baserel,
Oid  foreigntableid 
)
static

Definition at line 500 of file file_fdw.c.

References estimate_size(), RelOptInfo::fdw_private, fileGetOptions(), FileFdwPlanState::filename, FileFdwPlanState::is_program, FileFdwPlanState::options, and palloc().

Referenced by file_fdw_handler().

503 {
504  FileFdwPlanState *fdw_private;
505 
506  /*
507  * Fetch options. We only need filename (or program) at this point, but
508  * we might as well get everything and not need to re-fetch it later in
509  * planning.
510  */
511  fdw_private = (FileFdwPlanState *) palloc(sizeof(FileFdwPlanState));
512  fileGetOptions(foreigntableid,
513  &fdw_private->filename,
514  &fdw_private->is_program,
515  &fdw_private->options);
516  baserel->fdw_private = (void *) fdw_private;
517 
518  /* Estimate relation size */
519  estimate_size(root, baserel, fdw_private);
520 }
List * options
Definition: file_fdw.c:92
static void estimate_size(PlannerInfo *root, RelOptInfo *baserel, FileFdwPlanState *fdw_private)
Definition: file_fdw.c:971
char * filename
Definition: file_fdw.c:90
static void fileGetOptions(Oid foreigntableid, char **filename, bool *is_program, List **other_options)
Definition: file_fdw.c:356
void * fdw_private
Definition: pathnodes.h:695
void * palloc(Size size)
Definition: mcxt.c:949

◆ fileGetOptions()

static void fileGetOptions ( Oid  foreigntableid,
char **  filename,
bool is_program,
List **  other_options 
)
static

Definition at line 356 of file file_fdw.c.

References defGetString(), DefElem::defname, elog, ERROR, ForeignServer::fdwid, foreach_delete_current, get_file_fdw_attribute_options(), GetForeignDataWrapper(), GetForeignServer(), GetForeignTable(), lfirst, list_concat(), NIL, ForeignDataWrapper::options, ForeignServer::options, options, ForeignTable::options, and ForeignTable::serverid.

Referenced by file_acquire_sample_rows(), fileAnalyzeForeignTable(), fileBeginForeignScan(), fileExplainForeignScan(), and fileGetForeignRelSize().

358 {
359  ForeignTable *table;
360  ForeignServer *server;
361  ForeignDataWrapper *wrapper;
362  List *options;
363  ListCell *lc;
364 
365  /*
366  * Extract options from FDW objects. We ignore user mappings because
367  * file_fdw doesn't have any options that can be specified there.
368  *
369  * (XXX Actually, given the current contents of valid_options[], there's
370  * no point in examining anything except the foreign table's own options.
371  * Simplify?)
372  */
373  table = GetForeignTable(foreigntableid);
374  server = GetForeignServer(table->serverid);
375  wrapper = GetForeignDataWrapper(server->fdwid);
376 
377  options = NIL;
378  options = list_concat(options, wrapper->options);
379  options = list_concat(options, server->options);
380  options = list_concat(options, table->options);
381  options = list_concat(options, get_file_fdw_attribute_options(foreigntableid));
382 
383  /*
384  * Separate out the filename or program option (we assume there is only
385  * one).
386  */
387  *filename = NULL;
388  *is_program = false;
389  foreach(lc, options)
390  {
391  DefElem *def = (DefElem *) lfirst(lc);
392 
393  if (strcmp(def->defname, "filename") == 0)
394  {
395  *filename = defGetString(def);
396  options = foreach_delete_current(options, lc);
397  break;
398  }
399  else if (strcmp(def->defname, "program") == 0)
400  {
401  *filename = defGetString(def);
402  *is_program = true;
403  options = foreach_delete_current(options, lc);
404  break;
405  }
406  }
407 
408  /*
409  * The validator should have checked that filename or program was included
410  * in the options, but check again, just in case.
411  */
412  if (*filename == NULL)
413  elog(ERROR, "either filename or program is required for file_fdw foreign tables");
414 
415  *other_options = options;
416 }
#define NIL
Definition: pg_list.h:65
static List * get_file_fdw_attribute_options(Oid relid)
Definition: file_fdw.c:427
List * list_concat(List *list1, const List *list2)
Definition: list.c:516
ForeignTable * GetForeignTable(Oid relid)
Definition: foreign.c:248
#define foreach_delete_current(lst, cell)
Definition: pg_list.h:368
ForeignDataWrapper * GetForeignDataWrapper(Oid fdwid)
Definition: foreign.c:35
#define ERROR
Definition: elog.h:43
char * defGetString(DefElem *def)
Definition: define.c:49
static char ** options
List * options
Definition: foreign.h:31
ForeignServer * GetForeignServer(Oid serverid)
Definition: foreign.c:109
#define lfirst(lc)
Definition: pg_list.h:190
Oid serverid
Definition: foreign.h:56
List * options
Definition: foreign.h:57
static char * filename
Definition: pg_dumpall.c:91
#define elog(elevel,...)
Definition: elog.h:226
char * defname
Definition: parsenodes.h:730
Definition: pg_list.h:50
List * options
Definition: foreign.h:42

◆ fileIsForeignScanParallelSafe()

static bool fileIsForeignScanParallelSafe ( PlannerInfo root,
RelOptInfo rel,
RangeTblEntry rte 
)
static

Definition at line 831 of file file_fdw.c.

Referenced by file_fdw_handler().

833 {
834  return true;
835 }

◆ fileIterateForeignScan()

static TupleTableSlot * fileIterateForeignScan ( ForeignScanState node)
static

Definition at line 704 of file file_fdw.c.

References ErrorContextCallback::callback, CopyFromErrorCallback(), FileFdwExecutionState::cstate, error_context_stack, ExecClearTuple(), ExecStoreVirtualTuple(), ForeignScanState::fdw_state, NextCopyFrom(), ErrorContextCallback::previous, ForeignScanState::ss, and ScanState::ss_ScanTupleSlot.

Referenced by file_fdw_handler().

705 {
707  TupleTableSlot *slot = node->ss.ss_ScanTupleSlot;
708  bool found;
709  ErrorContextCallback errcallback;
710 
711  /* Set up callback to identify error line number. */
712  errcallback.callback = CopyFromErrorCallback;
713  errcallback.arg = (void *) festate->cstate;
714  errcallback.previous = error_context_stack;
715  error_context_stack = &errcallback;
716 
717  /*
718  * The protocol for loading a virtual tuple into a slot is first
719  * ExecClearTuple, then fill the values/isnull arrays, then
720  * ExecStoreVirtualTuple. If we don't find another row in the file, we
721  * just skip the last step, leaving the slot empty as required.
722  *
723  * We can pass ExprContext = NULL because we read all columns from the
724  * file, so no need to evaluate default expressions.
725  *
726  * We can also pass tupleOid = NULL because we don't allow oids for
727  * foreign tables.
728  */
729  ExecClearTuple(slot);
730  found = NextCopyFrom(festate->cstate, NULL,
731  slot->tts_values, slot->tts_isnull);
732  if (found)
733  ExecStoreVirtualTuple(slot);
734 
735  /* Remove error callback. */
736  error_context_stack = errcallback.previous;
737 
738  return slot;
739 }
ScanState ss
Definition: execnodes.h:1785
void CopyFromErrorCallback(void *arg)
Definition: copy.c:2239
static TupleTableSlot * ExecClearTuple(TupleTableSlot *slot)
Definition: tuptable.h:426
TupleTableSlot * ss_ScanTupleSlot
Definition: execnodes.h:1334
void(* callback)(void *arg)
Definition: elog.h:254
struct ErrorContextCallback * previous
Definition: elog.h:253
ErrorContextCallback * error_context_stack
Definition: elog.c:88
bool NextCopyFrom(CopyState cstate, ExprContext *econtext, Datum *values, bool *nulls)
Definition: copy.c:3688
TupleTableSlot * ExecStoreVirtualTuple(TupleTableSlot *slot)
Definition: execTuples.c:1517

◆ fileReScanForeignScan()

static void fileReScanForeignScan ( ForeignScanState node)
static

Definition at line 746 of file file_fdw.c.

References BeginCopyFrom(), FileFdwExecutionState::cstate, EndCopyFrom(), ForeignScanState::fdw_state, FileFdwExecutionState::filename, FileFdwExecutionState::is_program, NIL, FileFdwExecutionState::options, ForeignScanState::ss, and ScanState::ss_currentRelation.

Referenced by file_fdw_handler().

747 {
749 
750  EndCopyFrom(festate->cstate);
751 
752  festate->cstate = BeginCopyFrom(NULL,
753  node->ss.ss_currentRelation,
754  festate->filename,
755  festate->is_program,
756  NULL,
757  NIL,
758  festate->options);
759 }
#define NIL
Definition: pg_list.h:65
ScanState ss
Definition: execnodes.h:1785
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:3387
Relation ss_currentRelation
Definition: execnodes.h:1332
void EndCopyFrom(CopyState cstate)
Definition: copy.c:3876

◆ get_file_fdw_attribute_options()

static List * get_file_fdw_attribute_options ( Oid  relid)
static

Definition at line 427 of file file_fdw.c.

References AccessShareLock, attname, attnum, defGetBoolean(), DefElem::defname, GetForeignColumnOptions(), lappend(), lfirst, makeDefElem(), makeString(), NameStr, TupleDescData::natts, NIL, options, pstrdup(), RelationGetDescr, table_close(), table_open(), and TupleDescAttr.

Referenced by fileGetOptions().

428 {
429  Relation rel;
430  TupleDesc tupleDesc;
431  AttrNumber natts;
433  List *fnncolumns = NIL;
434  List *fncolumns = NIL;
435 
436  List *options = NIL;
437 
438  rel = table_open(relid, AccessShareLock);
439  tupleDesc = RelationGetDescr(rel);
440  natts = tupleDesc->natts;
441 
442  /* Retrieve FDW options for all user-defined attributes. */
443  for (attnum = 1; attnum <= natts; attnum++)
444  {
445  Form_pg_attribute attr = TupleDescAttr(tupleDesc, attnum - 1);
446  List *options;
447  ListCell *lc;
448 
449  /* Skip dropped attributes. */
450  if (attr->attisdropped)
451  continue;
452 
453  options = GetForeignColumnOptions(relid, attnum);
454  foreach(lc, options)
455  {
456  DefElem *def = (DefElem *) lfirst(lc);
457 
458  if (strcmp(def->defname, "force_not_null") == 0)
459  {
460  if (defGetBoolean(def))
461  {
462  char *attname = pstrdup(NameStr(attr->attname));
463 
464  fnncolumns = lappend(fnncolumns, makeString(attname));
465  }
466  }
467  else if (strcmp(def->defname, "force_null") == 0)
468  {
469  if (defGetBoolean(def))
470  {
471  char *attname = pstrdup(NameStr(attr->attname));
472 
473  fncolumns = lappend(fncolumns, makeString(attname));
474  }
475  }
476  /* maybe in future handle other options here */
477  }
478  }
479 
481 
482  /*
483  * Return DefElem only when some column(s) have force_not_null /
484  * force_null options set
485  */
486  if (fnncolumns != NIL)
487  options = lappend(options, makeDefElem("force_not_null", (Node *) fnncolumns, -1));
488 
489  if (fncolumns != NIL)
490  options = lappend(options, makeDefElem("force_null", (Node *) fncolumns, -1));
491 
492  return options;
493 }
Value * makeString(char *str)
Definition: value.c:53
#define NIL
Definition: pg_list.h:65
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:133
#define RelationGetDescr(relation)
Definition: rel.h:445
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
char * pstrdup(const char *in)
Definition: mcxt.c:1186
#define AccessShareLock
Definition: lockdefs.h:36
Definition: nodes.h:525
DefElem * makeDefElem(char *name, Node *arg, int location)
Definition: makefuncs.c:544
bool defGetBoolean(DefElem *def)
Definition: define.c:111
List * GetForeignColumnOptions(Oid relid, AttrNumber attnum)
Definition: foreign.c:286
NameData attname
Definition: pg_attribute.h:40
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200
List * lappend(List *list, void *datum)
Definition: list.c:322
static char ** options
int16 attnum
Definition: pg_attribute.h:79
#define lfirst(lc)
Definition: pg_list.h:190
#define NameStr(name)
Definition: c.h:609
char * defname
Definition: parsenodes.h:730
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
Definition: pg_list.h:50
int16 AttrNumber
Definition: attnum.h:21

◆ is_valid_option()

static bool is_valid_option ( const char *  option,
Oid  context 
)
static

Definition at line 337 of file file_fdw.c.

References FileFdwOption::optcontext, and FileFdwOption::optname.

Referenced by file_fdw_validator().

338 {
339  const struct FileFdwOption *opt;
340 
341  for (opt = valid_options; opt->optname; opt++)
342  {
343  if (context == opt->optcontext && strcmp(opt->optname, option) == 0)
344  return true;
345  }
346  return false;
347 }
Oid optcontext
Definition: file_fdw.c:48
static const struct FileFdwOption valid_options[]
Definition: file_fdw.c:60
const char * optname
Definition: file_fdw.c:47

◆ PG_FUNCTION_INFO_V1() [1/2]

PG_FUNCTION_INFO_V1 ( file_fdw_handler  )

◆ PG_FUNCTION_INFO_V1() [2/2]

PG_FUNCTION_INFO_V1 ( file_fdw_validator  )

Variable Documentation

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 40 of file file_fdw.c.

◆ valid_options

const struct FileFdwOption valid_options[]
static
Initial value:
= {
{"filename", ForeignTableRelationId},
{"program", ForeignTableRelationId},
{"format", ForeignTableRelationId},
{"header", ForeignTableRelationId},
{"delimiter", ForeignTableRelationId},
{"quote", ForeignTableRelationId},
{"escape", ForeignTableRelationId},
{"null", ForeignTableRelationId},
{"encoding", ForeignTableRelationId},
{"force_not_null", AttributeRelationId},
{"force_null", AttributeRelationId},
{NULL, InvalidOid}
}
#define InvalidOid
Definition: postgres_ext.h:36

Definition at line 60 of file file_fdw.c.