#include "nodes/parsenodes.h"

Include dependency graph for foreign.h:

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

Data Structures
struct	ForeignDataWrapper

struct	ForeignServer

struct	UserMapping

struct	ForeignTable

Macros
#define	MappingUserName(userid) (OidIsValid(userid) ? GetUserNameFromId(userid, false) : "public")

#define	FSV_MISSING_OK 0x01

#define	FDW_MISSING_OK 0x01

Typedefs
typedef struct ForeignDataWrapper	ForeignDataWrapper

typedef struct ForeignServer	ForeignServer

typedef struct UserMapping	UserMapping

typedef struct ForeignTable	ForeignTable

Functions
ForeignServer *	GetForeignServer (Oid serverid)

ForeignServer *	GetForeignServerExtended (Oid serverid, bits16 flags)

ForeignServer *	GetForeignServerByName (const char *srvname, bool missing_ok)

UserMapping *	GetUserMapping (Oid userid, Oid serverid)

ForeignDataWrapper *	GetForeignDataWrapper (Oid fdwid)

ForeignDataWrapper *	GetForeignDataWrapperExtended (Oid fdwid, bits16 flags)

ForeignDataWrapper *	GetForeignDataWrapperByName (const char *fdwname, bool missing_ok)

ForeignTable *	GetForeignTable (Oid relid)

List *	GetForeignColumnOptions (Oid relid, AttrNumber attnum)

Oid	get_foreign_data_wrapper_oid (const char *fdwname, bool missing_ok)

Oid	get_foreign_server_oid (const char *servername, bool missing_ok)

Macro Definition Documentation

◆ FDW_MISSING_OK

#define FDW_MISSING_OK 0x01

Definition at line 64 of file foreign.h.

◆ FSV_MISSING_OK

#define FSV_MISSING_OK 0x01

Definition at line 61 of file foreign.h.

◆ MappingUserName

#define MappingUserName ( userid ) (OidIsValid(userid) ? GetUserNameFromId(userid, false) : "public")

Definition at line 20 of file foreign.h.

Typedef Documentation

◆ ForeignDataWrapper

typedef struct ForeignDataWrapper ForeignDataWrapper

◆ ForeignServer

typedef struct ForeignServer ForeignServer

◆ ForeignTable

typedef struct ForeignTable ForeignTable

◆ UserMapping

typedef struct UserMapping UserMapping

Function Documentation

◆ get_foreign_data_wrapper_oid()

Oid get_foreign_data_wrapper_oid	(	const char *	fdwname,
		bool	missing_ok
	)

Definition at line 681 of file foreign.c.

 {
     Oid         oid;
  
     oid = GetSysCacheOid1(FOREIGNDATAWRAPPERNAME,
                           Anum_pg_foreign_data_wrapper_oid,
                           CStringGetDatum(fdwname));
     if (!OidIsValid(oid) && !missing_ok)
         ereport(ERROR,
                 (errcode(ERRCODE_UNDEFINED_OBJECT),
                  errmsg("foreign-data wrapper \"%s\" does not exist",
                         fdwname)));
     return oid;
 }

References CStringGetDatum(), ereport, errcode(), errmsg(), ERROR, GetSysCacheOid1, and OidIsValid.

Referenced by convert_foreign_data_wrapper_name(), get_object_address_unqualified(), and GetForeignDataWrapperByName().

◆ get_foreign_server_oid()

Oid get_foreign_server_oid	(	const char *	servername,
		bool	missing_ok
	)

Definition at line 704 of file foreign.c.

 {
     Oid         oid;
  
     oid = GetSysCacheOid1(FOREIGNSERVERNAME, Anum_pg_foreign_server_oid,
                           CStringGetDatum(servername));
     if (!OidIsValid(oid) && !missing_ok)
         ereport(ERROR,
                 (errcode(ERRCODE_UNDEFINED_OBJECT),
                  errmsg("server \"%s\" does not exist", servername)));
     return oid;
 }

References CStringGetDatum(), ereport, errcode(), errmsg(), ERROR, GetSysCacheOid1, and OidIsValid.

Referenced by convert_server_name(), CreateForeignServer(), get_object_address_unqualified(), and GetForeignServerByName().

◆ GetForeignColumnOptions()

List* GetForeignColumnOptions	(	Oid	relid,
		AttrNumber	attnum
	)

Definition at line 292 of file foreign.c.

 {
     List       *options;
     HeapTuple   tp;
     Datum       datum;
     bool        isnull;
  
     tp = SearchSysCache2(ATTNUM,
                          ObjectIdGetDatum(relid),
                          Int16GetDatum(attnum));
     if (!HeapTupleIsValid(tp))
         elog(ERROR, "cache lookup failed for attribute %d of relation %u",
              attnum, relid);
     datum = SysCacheGetAttr(ATTNUM,
                             tp,
                             Anum_pg_attribute_attfdwoptions,
                             &isnull);
     if (isnull)
         options = NIL;
     else
         options = untransformRelOptions(datum);
  
     ReleaseSysCache(tp);
  
     return options;
 }

References attnum, elog, ERROR, HeapTupleIsValid, Int16GetDatum(), NIL, ObjectIdGetDatum(), options, ReleaseSysCache(), SearchSysCache2(), SysCacheGetAttr(), and untransformRelOptions().

Referenced by deparseAnalyzeSql(), deparseColumnRef(), and get_file_fdw_attribute_options().

◆ GetForeignDataWrapper()

ForeignDataWrapper* GetForeignDataWrapper ( Oid fdwid )

Definition at line 37 of file foreign.c.

 {
     return GetForeignDataWrapperExtended(fdwid, 0);
 }

References GetForeignDataWrapperExtended().

Referenced by AlterForeignServer(), AlterForeignServerOwner_internal(), AlterUserMapping(), ATExecAlterColumnGenericOptions(), ATExecGenericOptions(), CreateForeignTable(), CreateUserMapping(), fileGetOptions(), get_connect_string(), GetForeignDataWrapperByName(), and ImportForeignSchema().

◆ GetForeignDataWrapperByName()

ForeignDataWrapper* GetForeignDataWrapperByName	(	const char *	fdwname,
		bool	missing_ok
	)

Definition at line 96 of file foreign.c.

 {
     Oid         fdwId = get_foreign_data_wrapper_oid(fdwname, missing_ok);
  
     if (!OidIsValid(fdwId))
         return NULL;
  
     return GetForeignDataWrapper(fdwId);
 }

References get_foreign_data_wrapper_oid(), GetForeignDataWrapper(), and OidIsValid.

Referenced by CreateForeignDataWrapper(), and CreateForeignServer().

◆ GetForeignDataWrapperExtended()

ForeignDataWrapper* GetForeignDataWrapperExtended	(	Oid	fdwid,
		bits16	flags
	)

Definition at line 49 of file foreign.c.

 {
     Form_pg_foreign_data_wrapper fdwform;
     ForeignDataWrapper *fdw;
     Datum       datum;
     HeapTuple   tp;
     bool        isnull;
  
     tp = SearchSysCache1(FOREIGNDATAWRAPPEROID, ObjectIdGetDatum(fdwid));
  
     if (!HeapTupleIsValid(tp))
     {
         if ((flags & FDW_MISSING_OK) == 0)
             elog(ERROR, "cache lookup failed for foreign-data wrapper %u", fdwid);
         return NULL;
     }
  
     fdwform = (Form_pg_foreign_data_wrapper) GETSTRUCT(tp);
  
     fdw = (ForeignDataWrapper *) palloc(sizeof(ForeignDataWrapper));
     fdw->fdwid = fdwid;
     fdw->owner = fdwform->fdwowner;
     fdw->fdwname = pstrdup(NameStr(fdwform->fdwname));
     fdw->fdwhandler = fdwform->fdwhandler;
     fdw->fdwvalidator = fdwform->fdwvalidator;
  
     /* Extract the fdwoptions */
     datum = SysCacheGetAttr(FOREIGNDATAWRAPPEROID,
                             tp,
                             Anum_pg_foreign_data_wrapper_fdwoptions,
                             &isnull);
     if (isnull)
         fdw->options = NIL;
     else
         fdw->options = untransformRelOptions(datum);
  
     ReleaseSysCache(tp);
  
     return fdw;
 }

References elog, ERROR, FDW_MISSING_OK, ForeignDataWrapper::fdwhandler, ForeignDataWrapper::fdwid, ForeignDataWrapper::fdwname, ForeignDataWrapper::fdwvalidator, GETSTRUCT, HeapTupleIsValid, NameStr, NIL, ObjectIdGetDatum(), ForeignDataWrapper::options, ForeignDataWrapper::owner, palloc(), pstrdup(), ReleaseSysCache(), SearchSysCache1(), SysCacheGetAttr(), and untransformRelOptions().

Referenced by GetForeignDataWrapper(), getObjectDescription(), and getObjectIdentityParts().

◆ GetForeignServer()

ForeignServer* GetForeignServer ( Oid serverid )

Definition at line 111 of file foreign.c.

 {
     return GetForeignServerExtended(serverid, 0);
 }

References GetForeignServerExtended().

Referenced by ATExecAlterColumnGenericOptions(), ATExecGenericOptions(), fileGetOptions(), get_batch_size_option(), GetForeignServerByName(), getObjectDescription(), getObjectIdentityParts(), GetUserMapping(), make_new_connection(), pgfdw_reject_incomplete_xact_state_change(), postgresAcquireSampleRowsFunc(), postgresExecForeignTruncate(), postgresGetForeignRelSize(), postgresImportForeignSchema(), and postgresIsForeignRelUpdatable().

◆ GetForeignServerByName()

ForeignServer* GetForeignServerByName	(	const char *	srvname,
		bool	missing_ok
	)

Definition at line 182 of file foreign.c.

 {
     Oid         serverid = get_foreign_server_oid(srvname, missing_ok);
  
     if (!OidIsValid(serverid))
         return NULL;
  
     return GetForeignServer(serverid);
 }

References get_foreign_server_oid(), GetForeignServer(), and OidIsValid.

Referenced by AlterUserMapping(), CreateForeignTable(), CreateUserMapping(), get_connect_string(), get_object_address_usermapping(), ImportForeignSchema(), postgres_fdw_disconnect(), and RemoveUserMapping().

◆ GetForeignServerExtended()

ForeignServer* GetForeignServerExtended	(	Oid	serverid,
		bits16	flags
	)

Definition at line 123 of file foreign.c.

 {
     Form_pg_foreign_server serverform;
     ForeignServer *server;
     HeapTuple   tp;
     Datum       datum;
     bool        isnull;
  
     tp = SearchSysCache1(FOREIGNSERVEROID, ObjectIdGetDatum(serverid));
  
     if (!HeapTupleIsValid(tp))
     {
         if ((flags & FSV_MISSING_OK) == 0)
             elog(ERROR, "cache lookup failed for foreign server %u", serverid);
         return NULL;
     }
  
     serverform = (Form_pg_foreign_server) GETSTRUCT(tp);
  
     server = (ForeignServer *) palloc(sizeof(ForeignServer));
     server->serverid = serverid;
     server->servername = pstrdup(NameStr(serverform->srvname));
     server->owner = serverform->srvowner;
     server->fdwid = serverform->srvfdw;
  
     /* Extract server type */
     datum = SysCacheGetAttr(FOREIGNSERVEROID,
                             tp,
                             Anum_pg_foreign_server_srvtype,
                             &isnull);
     server->servertype = isnull ? NULL : TextDatumGetCString(datum);
  
     /* Extract server version */
     datum = SysCacheGetAttr(FOREIGNSERVEROID,
                             tp,
                             Anum_pg_foreign_server_srvversion,
                             &isnull);
     server->serverversion = isnull ? NULL : TextDatumGetCString(datum);
  
     /* Extract the srvoptions */
     datum = SysCacheGetAttr(FOREIGNSERVEROID,
                             tp,
                             Anum_pg_foreign_server_srvoptions,
                             &isnull);
     if (isnull)
         server->options = NIL;
     else
         server->options = untransformRelOptions(datum);
  
     ReleaseSysCache(tp);
  
     return server;
 }

References elog, ERROR, ForeignServer::fdwid, FSV_MISSING_OK, GETSTRUCT, HeapTupleIsValid, NameStr, NIL, ObjectIdGetDatum(), ForeignServer::options, ForeignServer::owner, palloc(), pstrdup(), ReleaseSysCache(), SearchSysCache1(), ForeignServer::serverid, ForeignServer::servername, ForeignServer::servertype, ForeignServer::serverversion, SysCacheGetAttr(), TextDatumGetCString, and untransformRelOptions().

Referenced by disconnect_cached_connections(), GetForeignServer(), getObjectDescription(), getObjectIdentityParts(), and postgres_fdw_get_connections_internal().

◆ GetForeignTable()

ForeignTable* GetForeignTable ( Oid relid )

Definition at line 254 of file foreign.c.

 {
     Form_pg_foreign_table tableform;
     ForeignTable *ft;
     HeapTuple   tp;
     Datum       datum;
     bool        isnull;
  
     tp = SearchSysCache1(FOREIGNTABLEREL, ObjectIdGetDatum(relid));
     if (!HeapTupleIsValid(tp))
         elog(ERROR, "cache lookup failed for foreign table %u", relid);
     tableform = (Form_pg_foreign_table) GETSTRUCT(tp);
  
     ft = (ForeignTable *) palloc(sizeof(ForeignTable));
     ft->relid = relid;
     ft->serverid = tableform->ftserver;
  
     /* Extract the ftoptions */
     datum = SysCacheGetAttr(FOREIGNTABLEREL,
                             tp,
                             Anum_pg_foreign_table_ftoptions,
                             &isnull);
     if (isnull)
         ft->options = NIL;
     else
         ft->options = untransformRelOptions(datum);
  
     ReleaseSysCache(tp);
  
     return ft;
 }

References elog, ERROR, GETSTRUCT, HeapTupleIsValid, NIL, ObjectIdGetDatum(), ForeignTable::options, palloc(), ReleaseSysCache(), ForeignTable::relid, SearchSysCache1(), ForeignTable::serverid, SysCacheGetAttr(), and untransformRelOptions().

Referenced by check_selective_binary_conversion(), create_foreign_modify(), deparseRelation(), fileGetOptions(), get_batch_size_option(), postgresAcquireSampleRowsFunc(), postgresAnalyzeForeignTable(), postgresBeginDirectModify(), postgresBeginForeignScan(), postgresExecForeignTruncate(), postgresGetAnalyzeInfoForForeignTable(), postgresGetForeignRelSize(), and postgresIsForeignRelUpdatable().

◆ GetUserMapping()

UserMapping* GetUserMapping	(	Oid	userid,
		Oid	serverid
	)

Definition at line 200 of file foreign.c.

 {
     Datum       datum;
     HeapTuple   tp;
     bool        isnull;
     UserMapping *um;
  
     tp = SearchSysCache2(USERMAPPINGUSERSERVER,
                          ObjectIdGetDatum(userid),
                          ObjectIdGetDatum(serverid));
  
     if (!HeapTupleIsValid(tp))
     {
         /* Not found for the specific user -- try PUBLIC */
         tp = SearchSysCache2(USERMAPPINGUSERSERVER,
                              ObjectIdGetDatum(InvalidOid),
                              ObjectIdGetDatum(serverid));
     }
  
     if (!HeapTupleIsValid(tp))
     {
         ForeignServer *server = GetForeignServer(serverid);
  
         ereport(ERROR,
                 (errcode(ERRCODE_UNDEFINED_OBJECT),
                  errmsg("user mapping not found for user \"%s\", server \"%s\"",
                         MappingUserName(userid), server->servername)));
     }
  
     um = (UserMapping *) palloc(sizeof(UserMapping));
     um->umid = ((Form_pg_user_mapping) GETSTRUCT(tp))->oid;
     um->userid = userid;
     um->serverid = serverid;
  
     /* Extract the umoptions */
     datum = SysCacheGetAttr(USERMAPPINGUSERSERVER,
                             tp,
                             Anum_pg_user_mapping_umoptions,
                             &isnull);
     if (isnull)
         um->options = NIL;
     else
         um->options = untransformRelOptions(datum);
  
     ReleaseSysCache(tp);
  
     return um;
 }

References ereport, errcode(), errmsg(), ERROR, GetForeignServer(), GETSTRUCT, HeapTupleIsValid, InvalidOid, MappingUserName, NIL, ObjectIdGetDatum(), UserMapping::options, palloc(), ReleaseSysCache(), SearchSysCache2(), UserMapping::serverid, ForeignServer::servername, SysCacheGetAttr(), UserMapping::umid, untransformRelOptions(), and UserMapping::userid.

Referenced by create_foreign_modify(), get_connect_string(), postgresAcquireSampleRowsFunc(), postgresAnalyzeForeignTable(), postgresBeginDirectModify(), postgresBeginForeignScan(), postgresExecForeignTruncate(), postgresGetAnalyzeInfoForForeignTable(), postgresGetForeignRelSize(), and postgresImportForeignSchema().

Data Structures

Macros

Typedefs

Functions