Pgmonkey

This hotfix addresses an installation issue with `PyYAML` in version 1.1.2. We've pinned `PyYAML` to a compatible version to prevent build errors during installation. Users should now experience a smooth installation without additional dependencies.

To upgrade, run:

bash
pip install pgmonkey --upgrade


Thank you for your patience and understanding.

This release of pgmonkey focuses on dependency updates, code and documentation enhancements, and a refined approach to version compatibility for smoother future updates. Version 1.1.2 brings improved flexibility, addressing potential conflicts with newer dependency versions, and introduces minor code updates to support easier connection management.

---

🔧 Improvements:

- **Dependency Version Compatibility**:
- Updated version specifications for key dependencies to maintain flexibility with the latest releases, reducing the risk of version conflicts while ensuring compatibility with future updates.
- This change allows users to stay current with dependency updates within stable major versions without manual updates, enhancing pgmonkey’s long-term reliability.

- **Connection Context Management Documentation**:
- Expanded documentation on managing database connections with context managers (`async with` and `with`) to support both synchronous and asynchronous operations. This update provides clearer guidance and example usage, making it easier for users to manage resources effectively and handle errors smoothly.

- **Requirements File Standardization**:
- Consolidated and standardized dependency requirements across `requirements.txt` and internal dependency configurations, ensuring consistent package management and simplifying project setup.

---

📚 Documentation Updates:

- **Release Notes and Versioning**:
- Added detailed release notes to guide users through new version features and changes. This documentation update includes example code and usage recommendations, making it easier for users to adopt the latest changes quickly.

---

💡 How to Upgrade:

To upgrade to the latest version, run:

bash
pip install pgmonkey --upgrade


Thank you for using pgmonkey! We value your feedback and contributions. If you encounter issues or have suggestions, please feel free to open an issue on our GitHub page.

This release introduces key improvements for `pgmonkey`'s import and export functionality, along with important bug fixes and documentation updates. The focus of this release is on standardizing input argument styles for a more consistent user experience and addressing a few quality-of-life fixes.

🔧 Improvements:
- **Standardized Argument Input Style for `pgimport` and `pgexport`**:
- The input style for `pgimport` and `pgexport` commands has been updated to be consistent. The `--import_file` and `--export_file` options are now used in both commands for specifying file paths, providing a more intuitive and uniform command-line experience.
- This change simplifies usage, making it easier for users to remember command structures and reducing potential confusion.

📚 Documentation Updates:
- **Updated Quick Reference for `pgimport` and `pgexport`**:
- Added missing entries for `pgimport` and `pgexport` in the Quick Reference section of the documentation, ensuring users have easy access to examples and usage tips for these commands.
- Updated the example usage and option descriptions to reflect the new standardized argument style for `pgimport` and `pgexport`.

🐛 Bug Fixes:
- **Progress Bar and Blank Line Handling**:
- Fixed an issue with the progress bar during data import where blank lines were being counted towards the total, leading to inaccurate progress reporting.
- Implemented a fix to skip over blank lines during data import, ensuring that only valid data rows are processed. This improves efficiency and accuracy when importing CSV and text files.
- **Header Blank Line Fix**:
- Corrected a bug that caused blank lines in headers to be mishandled during imports, leading to better parsing of CSV headers.


💡 How to Upgrade:
To upgrade to the latest version, run:
bash
pip install pgmonkey --upgrade


Thank you for using `pgmonkey`! We appreciate your feedback and contributions. If you encounter any issues or have suggestions, please feel free to open an issue on our [GitHub page](https://github.com/RexBytes/pgmonkey).

🚀 New Features and Enhancements:

**Enhanced Data Export and Import:**

- **Custom Delimiters Now Fully Supported:**
Users can specify custom delimiters, including tab (`\t`) and pipe (`|`) characters, directly in their configuration files. The export functionality has been updated to respect these settings, making it easier to work with a variety of data formats.

- **Improved Handling of Blank Lines in CSV Imports:**
The import process has been made more robust by automatically skipping blank lines within CSV files. This ensures smoother data ingestion without errors due to unexpected empty rows, allowing for cleaner data processing.

- **Client Encoding Respect:**
Improved alignment between database client encoding settings and output file encoding during data export, ensuring that data is exported in the correct format. This enhances compatibility when working with diverse character sets and encoding needs.

**Performance Optimizations:**

- **Optimized Binary Mode Data Handling:**
Export operations now leverage binary mode for data output, resulting in faster file writing. This choice balances speed with flexibility, particularly for large datasets, making pgmonkey a better choice for high-volume data tasks.

- **Refined Async and Sync Import Logic:**
The importer’s logic for handling async and sync connections has been refined, ensuring consistent performance across various environments. This streamlines the experience for developers switching between connection types, offering more predictable behavior.

**Better Error Handling and Debugging:**

- **Clearer Error Messages for Invalid Configurations:**
Configuration parsing has been improved to provide more informative feedback when settings are incorrect, such as when an unsupported delimiter is used. This reduces troubleshooting time and helps users correct issues faster.

- **Enhanced Logging for Import/Export Processes:**
The import and export methods now include detailed logging of steps and progress, making it easier to diagnose issues and track the status of long-running operations.

♻️ Backward Compatibility:

- All core functionalities from version 1.0.11 remain intact, with enhancements designed to augment existing workflows rather than replace them.
- Previous configuration files continue to work without modification. New options for delimiter and encoding provide additional flexibility for users without breaking legacy setups.

🐛 Bug Fixes:

- **Resolved:** Fixed an issue where blank lines in CSV data files caused import failures, ensuring that blank lines are skipped.
- **Improved:** Corrected a problem with the COPY command where the specified delimiter was not respected, particularly for tab-delimited files.
- **Refined:** Adjusted the handling of database encoding settings during exports to prevent mismatches between the database and file output encoding.

⚙️ Migration Notes:

- Users are encouraged to review their configuration files to take advantage of the new delimiter options, especially if dealing with data formats that require non-standard separators.
- For optimal performance, consider enabling the use of binary mode for data exports, especially when working with large files.
- No mandatory changes are required for existing setups. Existing YAML configuration files will continue to work seamlessly, while users can benefit from the improved robustness and flexibility of this release.

**What This Means for pgmonkey Moving to 1.1.0:**

Version 1.1.0 marks a significant step forward in pgmonkey’s evolution as a robust database utility tool. This release focuses on improving data handling and performance, making it a reliable choice for both routine and high-volume data tasks. The addition of more precise control over CSV formats and better error handling positions pgmonkey as a more flexible and user-friendly solution for database export and import operations.

As pgmonkey moves to version 1.1.0, developers can expect a smoother experience with fewer edge-case errors, faster processing, and enhanced compatibility with various data formats. This release underscores pgmonkey's commitment to delivering a seamless and efficient data management tool that meets the needs of modern database workflows. Happy coding with pgmonkey! 🐒🚀

---

🚀 New Features and Enhancements:

**Improved Connection Management:**
- Enhanced support for **asynchronous transactions** and **connection pooling**.
- Added `transaction` methods for both `PGAsyncConnection` and `PGPoolConnection` classes, allowing easier management of transactions with `async with` and `with` statements.
- This improvement standardizes transaction handling across different connection types, making it simpler to work with pooled and async connections.

**Context Management for Cursors:**
- Now supports the use of `async with connection.cursor()` for `PGAsyncConnection` and `PGAsyncPoolConnection`.
- Synchronous cursor handling for `PGPoolConnection` and `PGNormalConnection` has been streamlined, ensuring consistent behavior across different connection types.
- This enhancement allows for better resource management and automatically closes cursors when they are no longer needed.

**Detailed Connection Testing:**
- Updated connection tests to include more comprehensive validation of connection pooling behavior.
- For example, `test_connection()` now verifies the acquisition of multiple connections in `PGAsyncPoolConnection` and `PGPoolConnection` to ensure pools are correctly managing connection limits.
- This improvement provides more robust testing to identify potential issues with pool configurations before they impact production.

---

♻️ Backward Compatibility:

- All previous connection methods remain available. The new transaction handling and cursor management features are **additive**, providing more options without breaking existing workflows.
- Legacy connection configuration options like `pool_settings` and `async_settings` are still supported, though users are encouraged to leverage the new streamlined transaction methods for improved efficiency.

---

🐛 Bug Fixes:

- **Resolved**: Fixed issues with connection pooling where connections were not being correctly returned to the pool under certain conditions.
- **Improved**: Error handling during connection setup and teardown has been refined, ensuring more informative error messages when connection or transaction issues occur.
- **Corrected**: Addressed an issue where the `PGAsyncConnection` class raised an error when using `command_timeout`, making settings validation more accurate.

---

⚙️ Migration Notes:

- Users are encouraged to update their testing scripts to use the new `transaction()` methods for managing database transactions in both async and sync environments. This makes it easier to leverage automatic commit/rollback behaviors.
- No major configuration changes are required. Existing YAML configuration files will continue to work as before, but users can now take advantage of more robust transaction handling.

This release focuses on enhancing developer productivity and reliability with better transaction handling, more intuitive cursor management, and thorough testing capabilities. Happy coding with pgmonkey! 🐒🚀

🚀 New Features and Enhancements:
Alias Support for --connconfig:
🆕 You can now use --connconfig as an alias for --filepath across all pgconfig CLI commands. This update provides a more descriptive option when specifying configuration file paths.

Examples:
✅ pgmonkey pgconfig test --connconfig /path/to/config.yaml
Works the same as:
✅ pgmonkey pgconfig test --filepath /path/to/config.yaml

This improves clarity while keeping things flexible for users who prefer either option. 🎉

♻️ Backward Compatibility:
🔄 The --filepath argument remains fully supported. This addition is non-breaking, so previous workflows will continue as normal! 👍
🐛 Bug Fixes:
None in this release.
This release enhances usability by making command arguments clearer and more intuitive without breaking existing functionality.