Skip to main content
Version: 1.9.1

PostgresDestination

classView source ↗
class PostgresDestination(
    uri: str,
    destination_table: List[str] | str,
    credentials: UserPasswordCredentials = None,
    if_table_exists: IfTableExistStrategySpec = 'append',
)

Bases: DestinationPlugin

Categories: destination

Postgres-based data outputs.

Initializes the PostgresDestination with the given URI and destination table, and optionally connection credentials.

Parameters​

parameter
uri

The URI of the database where the data is going to be stored.

parameter
destination_table

The tables to create. If multiple tables are provided, they must be provided as a list.

parameter
credentials

The credentials required to access the Postgres database. Must be a UserPasswordCredentials object.

Raises​

OutputConfigurationError

Properties​

property
credentialsUserPasswordCredentials

The credentials required to access the Postgres database.

property
destination_tablestr | List[str]

The table(s) to create. If multiple tables are provided, they must be provided as a list.

property
if_table_existsIfTableExistStrategySpec

str: The strategy to follow when the table already exists.

property
uristr

The URI of the database where the data is going to be stored.

Methods​

method
View source ↗
chunk
def chunk(working_dir: str, *results: LazyFrame | None) -> list[str | None]

Store the results in the SQL destination.

Parameters:

parameter
working_dirstr

The working directory where the results will be stored.

parameter
resultslist[pl.LazyFrame | None]

The results to store in the SQL destination.

method
View source ↗
write
def write(files: list[str | None])

Given a file or a list of files, write to the desired destination. Note: this method might materialize the data in the files it receives, so chunks should be of an appropriate size.

Parameters:

parameter
filesstr

The file or files to be stored in the final destination.