Class ForeignDataManager

Manages Foreign Data Wrapper objects (servers, user mappings, foreign tables) for a Prorm instance.

All operations delegate SQL generation to the underlying dialect so that non-PostgreSQL dialects can throw meaningful errors at a single point.

Index

Constructors

Methods

createServer alterServer dropServer getServers serverExists createUserMapping alterUserMapping dropUserMapping createForeignTable dropForeignTable importForeignSchema

Constructors

constructor

new ForeignDataManager(prorm: any): ForeignDataManager
Parameters
- prorm: any
Returns ForeignDataManager
- Defined in foreign-data.ts:132

Methods

createServer

createServer(name: string, opts: ForeignServerOptions): Promise<void>
CREATE FOREIGN SERVER
Parameters
- name: string
- opts: ForeignServerOptions
Returns Promise<void>
- Defined in foreign-data.ts:141

alterServer

alterServer(name: string, opts: AlterForeignServerOptions): Promise<void>
ALTER FOREIGN SERVER
Parameters
- name: string
- opts: AlterForeignServerOptions
Returns Promise<void>
- Defined in foreign-data.ts:149

dropServer

dropServer(
name: string,
opts?: { ifExists?: boolean; cascade?: boolean },
): Promise<void>
DROP FOREIGN SERVER
Parameters
- name: string
- Optionalopts: { ifExists?: boolean; cascade?: boolean }
Returns Promise<void>
- Defined in foreign-data.ts:157

getServers

getServers(): Promise<ServerInfo[]>
List all foreign servers visible in the current database.

Returns Promise<ServerInfo[]>
- Defined in foreign-data.ts:165

serverExists

serverExists(name: string): Promise<boolean>
Return true if a foreign server with the given name exists.
Parameters
- name: string
Returns Promise<boolean>
- Defined in foreign-data.ts:178

createUserMapping

createUserMapping(opts: UserMappingOptions): Promise<void>
CREATE USER MAPPING
Parameters
- opts: UserMappingOptions
Returns Promise<void>
- Defined in foreign-data.ts:190

alterUserMapping

alterUserMapping(opts: UserMappingOptions): Promise<void>
ALTER USER MAPPING (re-uses the same SQL builder as CREATE with altered keywords)
Parameters
- opts: UserMappingOptions
Returns Promise<void>
- Defined in foreign-data.ts:198

dropUserMapping

dropUserMapping(
    serverName: string,
    user?: string,
    opts?: { ifExists?: boolean },
): Promise<void>
DROP USER MAPPING
Parameters
- serverName: string
- user: string = 'CURRENT_USER'
- Optionalopts: { ifExists?: boolean }
Returns Promise<void>
- Defined in foreign-data.ts:206

createForeignTable

createForeignTable(tableName: string, opts: ForeignTableOptions): Promise<void>
CREATE FOREIGN TABLE
Parameters
- tableName: string
- opts: ForeignTableOptions
Returns Promise<void>
- Defined in foreign-data.ts:222

dropForeignTable

dropForeignTable(
tableName: string,
opts?: { ifExists?: boolean; cascade?: boolean },
): Promise<void>
DROP FOREIGN TABLE
Parameters
- tableName: string
- Optionalopts: { ifExists?: boolean; cascade?: boolean }
Returns Promise<void>
- Defined in foreign-data.ts:230

importForeignSchema

importForeignSchema(
    remoteSchema: string,
    serverName: string,
    opts?: ImportForeignSchemaOptions,
): Promise<void>
IMPORT FOREIGN SCHEMA
Parameters
- remoteSchema: string
- serverName: string
- Optionalopts: ImportForeignSchemaOptions
Returns Promise<void>
- Defined in foreign-data.ts:241