PostgresIntegration Objects

class PostgresIntegration(GraiIntegrationImplementation)

A class for extracting Grai compliant metadata from Postgres


  • connector - The connector responsible for communicating with postgres.


def __init__(source: SourceV1,
             version: Optional[str] = None,
             dbname: Optional[str] = None,
             user: Optional[str] = None,
             password: Optional[str] = None,
             host: Optional[str] = None,
             port: Optional[Union[str, int]] = None,
             namespace: Optional[str] = None)

Initializes the Postgres integration.


  • source - The Grai data source to associate with output from the integration. More information about source objects is available in the grai_schemas library.
  • version - The Grai data version to associate with output from the integration
  • namespace - The Grai namespace to associate with output from the integration
  • dbname - The Postgres database to connect to.
  • user - The username to use when connecting to Postgres.
  • password - The password to use when connecting to Postgres.
  • host - The Postgres host address.
  • port - The Postgres port.


def get_nodes_and_edges() -> Tuple[List[SourcedNode], List[SourcedEdge]]

Returns a tuple of lists of SourcedNode and SourcedEdge objects


def ready() -> bool

Returns True if the integration is ready to run


def nodes() -> List[SourcedNode]

Returns a list of SourcedNode objects


def edges() -> List[SourcedEdge]

Returns a list of SourcedEdge objects