foreign.h File Reference

#include "nodes/parsenodes.h"

Include dependency graph for foreign.h:

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

Go to the source code of 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)
char *	ForeignServerName (Oid serverid)
ForeignServer *	GetForeignServerExtended (Oid serverid, bits16 flags)
ForeignServer *	GetForeignServerByName (const char *srvname, bool missing_ok)
char *	ForeignServerConnectionString (Oid userid, Oid serverid)
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 65 of file foreign.h.

FSV_MISSING_OK

#define FSV_MISSING_OK   0x01

Definition at line 62 of file foreign.h.

MappingUserName

#define MappingUserName

(

userid

)

(OidIsValid(userid) ? GetUserNameFromId(userid, false) : "public")

Definition at line 20 of file foreign.h.

                                                           : "public")

Typedef Documentation

ForeignDataWrapper

typedef struct ForeignDataWrapper ForeignDataWrapper

ForeignServer

typedef struct ForeignServer ForeignServer

ForeignTable

typedef struct ForeignTable ForeignTable

UserMapping

typedef struct UserMapping UserMapping

Function Documentation

ForeignServerConnectionString()

char * ForeignServerConnectionString ( Oid  userid, Oid  serverid  )

extern

Definition at line 224 of file foreign.c.

{
    MemoryContext tempContext;
    MemoryContext oldcxt;
    text       *volatile connection_text = NULL;
    char       *result = NULL;
 
    /*
     * GetForeignServer, GetForeignDataWrapper, and the connection function
     * itself all leak memory into CurrentMemoryContext. Switch to a temporary
     * context for easy cleanup.
     */
    tempContext = AllocSetContextCreate(CurrentMemoryContext,
                                        "FDWConnectionContext",
                                        ALLOCSET_SMALL_SIZES);
 
    oldcxt = MemoryContextSwitchTo(tempContext);
 
    PG_TRY();
    {
        ForeignServer *server;
        ForeignDataWrapper *fdw;
        Datum       connection_datum;
 
        server = GetForeignServer(serverid);
        fdw = GetForeignDataWrapper(server->fdwid);
 
        if (!OidIsValid(fdw->fdwconnection))
            ereport(ERROR,
                    (errmsg("foreign data wrapper \"%s\" does not support subscription connections",
                            fdw->fdwname),
                     errdetail("Foreign data wrapper must be defined with CONNECTION specified.")));
 
 
        connection_datum = OidFunctionCall3(fdw->fdwconnection,
                                            ObjectIdGetDatum(userid),
                                            ObjectIdGetDatum(serverid),
                                            PointerGetDatum(NULL));
 
        connection_text = DatumGetTextPP(connection_datum);
    }
    PG_FINALLY();
    {
        MemoryContextSwitchTo(oldcxt);
 
        if (connection_text)
            result = text_to_cstring((text *) connection_text);
 
        MemoryContextDelete(tempContext);
    }
    PG_END_TRY();
 
    return result;
}

References ALLOCSET_SMALL_SIZES, AllocSetContextCreate, CurrentMemoryContext, DatumGetTextPP, ereport, errdetail(), errmsg, ERROR, fb(), ForeignServer::fdwid, GetForeignDataWrapper(), GetForeignServer(), MemoryContextDelete(), MemoryContextSwitchTo(), ObjectIdGetDatum(), OidFunctionCall3, OidIsValid, PG_END_TRY, PG_FINALLY, PG_TRY, PointerGetDatum(), and text_to_cstring().

Referenced by AlterSubscription(), CreateSubscription(), DropSubscription(), and GetSubscription().

ForeignServerName()

char * ForeignServerName ( Oid  serverid )

extern

Definition at line 184 of file foreign.c.

{
    Form_pg_foreign_server serverform;
    char       *servername;
    HeapTuple   tp;
 
    tp = SearchSysCache1(FOREIGNSERVEROID, ObjectIdGetDatum(serverid));
 
    if (!HeapTupleIsValid(tp))
        elog(ERROR, "cache lookup failed for foreign server %u", serverid);
 
    serverform = (Form_pg_foreign_server) GETSTRUCT(tp);
 
    servername = pstrdup(NameStr(serverform->srvname));
 
    ReleaseSysCache(tp);
 
    return servername;
}

References elog, ERROR, fb(), Form_pg_foreign_server, GETSTRUCT(), HeapTupleIsValid, NameStr, ObjectIdGetDatum(), pstrdup(), ReleaseSysCache(), and SearchSysCache1().

Referenced by AlterSubscription(), AlterSubscriptionOwner_internal(), DropSubscription(), and GetSubscription().

get_foreign_data_wrapper_oid()

Oid get_foreign_data_wrapper_oid ( const char *  fdwname, bool  missing_ok  )

extern

Definition at line 768 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, fb(), 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  )

extern

Definition at line 791 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, fb(), GetSysCacheOid1, and OidIsValid.

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

GetForeignColumnOptions()

List * GetForeignColumnOptions ( Oid  relid, AttrNumber  attnum  )

extern

Definition at line 379 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, fb(), HeapTupleIsValid, Int16GetDatum(), NIL, ObjectIdGetDatum(), ReleaseSysCache(), SearchSysCache2(), SysCacheGetAttr(), and untransformRelOptions().

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

GetForeignDataWrapper()

ForeignDataWrapper * GetForeignDataWrapper ( Oid  fdwid )

extern

Definition at line 38 of file foreign.c.

{
    return GetForeignDataWrapperExtended(fdwid, 0);
}

References GetForeignDataWrapperExtended().

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

GetForeignDataWrapperByName()

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

extern

Definition at line 98 of file foreign.c.

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

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

Referenced by CreateForeignDataWrapper(), and CreateForeignServer().

GetForeignDataWrapperExtended()

ForeignDataWrapper * GetForeignDataWrapperExtended ( Oid  fdwid, bits16  flags  )

extern

Definition at line 50 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 = palloc_object(ForeignDataWrapper);
    fdw->fdwid = fdwid;
    fdw->owner = fdwform->fdwowner;
    fdw->fdwname = pstrdup(NameStr(fdwform->fdwname));
    fdw->fdwhandler = fdwform->fdwhandler;
    fdw->fdwvalidator = fdwform->fdwvalidator;
    fdw->fdwconnection = fdwform->fdwconnection;
 
    /* 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, fb(), FDW_MISSING_OK, Form_pg_foreign_data_wrapper, GETSTRUCT(), HeapTupleIsValid, NameStr, NIL, ObjectIdGetDatum(), palloc_object, pstrdup(), ReleaseSysCache(), SearchSysCache1(), SysCacheGetAttr(), and untransformRelOptions().

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

GetForeignServer()

ForeignServer * GetForeignServer ( Oid  serverid )

extern

Definition at line 113 of file foreign.c.

{
    return GetForeignServerExtended(serverid, 0);
}

References GetForeignServerExtended().

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

GetForeignServerByName()

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

extern

Definition at line 209 of file foreign.c.

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

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

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

GetForeignServerExtended()

ForeignServer * GetForeignServerExtended ( Oid  serverid, bits16  flags  )

extern

Definition at line 125 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 = palloc_object(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, fb(), ForeignServer::fdwid, Form_pg_foreign_server, FSV_MISSING_OK, GETSTRUCT(), HeapTupleIsValid, NameStr, NIL, ObjectIdGetDatum(), ForeignServer::options, ForeignServer::owner, palloc_object, 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 )

extern

Definition at line 341 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 = palloc_object(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, fb(), Form_pg_foreign_table, GETSTRUCT(), HeapTupleIsValid, NIL, ObjectIdGetDatum(), palloc_object, ReleaseSysCache(), SearchSysCache1(), 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  )

extern

Definition at line 287 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 = palloc_object(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, fb(), Form_pg_user_mapping, GetForeignServer(), GETSTRUCT(), HeapTupleIsValid, InvalidOid, MappingUserName, NIL, ObjectIdGetDatum(), palloc_object, ReleaseSysCache(), SearchSysCache2(), ForeignServer::servername, SysCacheGetAttr(), and untransformRelOptions().

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