sqlmeta.objects.foreign_server

Foreign Server SQL model class (PostgreSQL-specific).

Classes

ForeignServer(name, fdw_name[, host, port, ...])

Represents a foreign server (PostgreSQL-specific).
class sqlmeta.objects.foreign_server.ForeignServer(name: str, fdw_name: str, host: str | None = None, port: int | None = None, dbname: str | None = None, options: Dict[str, str] | None = None, schema: str | None = None, dialect: str | None = None)[source]

Represents a foreign server (PostgreSQL-specific).

Foreign Servers define connection parameters for specific remote data sources accessed through Foreign Data Wrappers. Multiple foreign tables can reference the same foreign server.

__init__(name: str, fdw_name: str, host: str | None = None, port: int | None = None, dbname: str | None = None, options: Dict[str, str] | None = None, schema: str | None = None, dialect: str | None = None)[source]

Initialize a foreign server.

Parameters:

  • name – Foreign server name

  • fdw_name – Name of the foreign data wrapper to use

  • host – Remote host address (optional)

  • port – Remote port number (optional)

  • dbname – Remote database name (optional)

  • options – Server-specific options as key-value pairs (optional)

  • schema – Schema (typically ‘public’)

  • dialect – SQL dialect (typically ‘postgresql’)

property create_statement: str

Generate CREATE SERVER statement.

Returns:

PostgreSQL CREATE SERVER statement

property drop_statement: str

Generate DROP SERVER statement.

Returns:

PostgreSQL DROP SERVER statement

__str__() → str[source]

Return string representation of the foreign server.

__eq__(other: Any) → bool[source]

Check if two foreign servers are equal.

__hash__() → int[source]

Return hash of the foreign server.