src/include/foreign/foreign.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * foreign.h
   4  *        support for foreign-data wrappers, servers and user mappings.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
   8  *
   9  * $PostgreSQL$
  10  *
  11  *-------------------------------------------------------------------------
  12  */
  13 #ifndef FOREIGN_H
  14 #define FOREIGN_H
  15
  16 #include "nodes/parsenodes.h"
  17
  18
  19 /* Helper for obtaining username for user mapping */
  20 #define MappingUserName(userid) \
  21         (OidIsValid(userid) ? GetUserNameFromId(userid) : "public")
  22
  23
  24 /*
  25  * Generic option types for validation.
  26  * NB! Thes are treated as flags, so use only powers of two here.
  27  */
  28 typedef enum
  29 {
  30         ServerOpt = 1,                          /* options applicable to SERVER */
  31         UserMappingOpt = 2,                     /* options for USER MAPPING */
  32         FdwOpt = 4                                      /* options for FOREIGN DATA WRAPPER */
  33 } GenericOptionFlags;
  34
  35 typedef struct ForeignDataWrapper
  36 {
  37         Oid                     fdwid;                  /* FDW Oid */
  38         Oid                     owner;                  /* FDW owner user Oid */
  39         char       *fdwname;            /* Name of the FDW */
  40         Oid                     fdwvalidator;
  41         List       *options;            /* fdwoptions as DefElem list */
  42 } ForeignDataWrapper;
  43
  44 typedef struct ForeignServer
  45 {
  46         Oid                     serverid;               /* server Oid */
  47         Oid                     fdwid;                  /* foreign-data wrapper */
  48         Oid                     owner;                  /* server owner user Oid */
  49         char       *servername;         /* name of the server */
  50         char       *servertype;         /* server type, optional */
  51         char       *serverversion;      /* server version, optional */
  52         List       *options;            /* srvoptions as DefElem list */
  53 } ForeignServer;
  54
  55 typedef struct UserMapping
  56 {
  57         Oid                     userid;                 /* local user Oid */
  58         Oid                     serverid;               /* server Oid */
  59         List       *options;            /* useoptions as DefElem list */
  60 } UserMapping;
  61
  62
  63 extern ForeignServer *GetForeignServer(Oid serverid);
  64 extern ForeignServer *GetForeignServerByName(const char *name, bool missing_ok);
  65 extern Oid      GetForeignServerOidByName(const char *name, bool missing_ok);
  66 extern UserMapping *GetUserMapping(Oid userid, Oid serverid);
  67 extern ForeignDataWrapper *GetForeignDataWrapper(Oid fdwid);
  68 extern ForeignDataWrapper *GetForeignDataWrapperByName(const char *name,
  69                                                         bool missing_ok);
  70 extern Oid      GetForeignDataWrapperOidByName(const char *name, bool missing_ok);
  71
  72 #endif   /* FOREIGN_H */