Usage
To generate an RDBMS Impact report:
- Open your project in Putki.
- Access the RDBMS Impact transform from the transform list.
- Configure the transform to generate the impact report.
- Once configured, execute the transform to generate a detailed report of SQL queries and their impacts on your database schema. Note: You can use the default settings.
Configuration
The RDBMS Impact transform uses various configuration fields to map the relevant details of your pipeline or workflow to the generated report. These fields can be configured through the RDBMS Impact interface in Putki. Below are the configuration fields that are available:
Configuration Fields
Field Name | Description | Default |
Transform Name | Specifies the name of the transform. | RDBMS Impact |
Filename Field | The field in your pipeline or workflow where the connection is used. | filename |
File Type Field | The field where the type of file is stored, such as PIPELINE or WORKFLOW. | type_name |
Item Name Field | The field that contains the name of the item being processed, such as the specific transform or action. | item_name |
Item Type Field | The field that identifies the type of item, for example, whether it's a TableInput or RDBMS Impact action. | item_type |
Connection Name Field | The field where the database connection information is stored, such as the connection string to PostgreSQL or other databases. | connection |
Schema Name Field | The field where the schema name is recorded in the report (if applicable). | schema |
Table Name Field | The field that contains the name of the table being queried or affected in the SQL query. | table |
Column Name Field | The field that specifies the column name(s) being affected or queried by the SQL operation. | column |
SQL Field | The field where the actual SQL query text is recorded. This will contain the SQL query being executed in the pipeline or workflow. | sql |
These fields allow you to map the relevant information from your Putki project to the RDBMS Impact report, providing a detailed view of the SQL queries and their impacts on the database.
Output
The RDBMS Impact transform will generate a detailed report based on the configuration settings. The output will include:
- Filename: The name of the pipeline or workflow.
- File Type: Type of operation (e.g., PIPELINE, WORKFLOW).
- Item Name: Name of the action or transform in the pipeline.
- Item Type: Type of action (e.g., TableInput, RDBMS Impact).
- Connection Name: The database connection being used.
- Schema Name: The schema of the table being affected or queried (if applicable).
- Table Name: The table being impacted by the SQL query.
- Column Name: The column(s) being queried or affected.
- SQL Query: The actual SQL query being executed.
filename | type_name | item_name | item_type | connection | schema | table | column | sql |
example-pipeline | PIPELINE | read-films | TableInput | dev-postgresql-dvdrental | public | film | title, release_year | SELECT public.film.title, public.film.release_year |