MySQLDestination

classView source ↗

class MySQLDestination(
    uri: str,
    destination_table: List[str] | str,
    credentials: dict | UserPasswordCredentials = None,
    if_table_exists: Literal['append', 'replace'] = 'append',
)

Bases: Output

Categories: destination

Class for managing the configuration of MySQL-based data outputs.

Attributes: credentials (UserPasswordCredentials): The credentials required to access the MySQL database. destination_table (str | List[str]): The table(s) to create. If multiple tables are provided, they must be provided as a list. if_table_exists ({'append', 'replace'}): The strategy to follow when the table already exists.

• ‘replace’ will create a new database table, overwriting an existing one.
• ‘append’ will append to an existing table. uri (str): The URI of the database where the data is going to be stored.

Methods: to_dict(): Converts the MySQLDestination object to a dictionary

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

Parameters

parameter

uristr

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

parameter

destination_tableList[str] | str

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

parameter

credentialsdict | UserPasswordCredentials, optional

The credentials required to access the MySQL database. Can be a dictionary or a UserPasswordCredentials object.

Raises

OutputConfigurationError

Properties

property

credentialsUserPasswordCredentials

The credentials required to access the MySQLDatabase.

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_existsLiteral['append', 'replace']

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 ↗

to_dict

def to_dict() -> dict

Converts the MySQLDestination object to a dictionary with all the relevant information.

Returns:

dict: A dictionary with the relevant information of the MySQLDestination object.