FEAT: Bulk Copy Options #106
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances bulk copy capabilities in the mssql_python library by extending option classes, tightening validations, adding logging, and introducing comprehensive unit tests.
- Extended
BCPOptionsandColumnFormatwith new fields (query,terminator_len,user_data_type,row_terminator) and default values. - Added stricter validation with detailed log messages and extracted constants for allowed directions and modes.
- Introduced a new
BCPControlOptionsenum and a full test suite covering valid/invalid cases for bulk copy operations.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| tests/test_007_bulkOptions.py | New tests for BCPOptions and ColumnFormat, covering invalid and edge cases. |
| mssql_python/constants.py | Added BCPControlOptions enum for BCP control string constants. |
| mssql_python/bcp_options.py | Refactored classes with new fields, logging, validation logic, and constants. |
Comments suppressed due to low confidence (3)
mssql_python/bcp_options.py:14
- [nitpick] The constant name ALLOWED_FILE_MODES may be misleading since it controls bulk_mode. Consider renaming it to ALLOWED_BULK_MODES for clarity.
ALLOWED_FILE_MODES = ("native", "char", "unicode")
mssql_python/bcp_options.py:1
- The module and class docstrings should be updated to document the new fields (
terminator_len,user_data_type,query,row_terminator) and their purpose for better API clarity.
"""
tests/test_007_bulkOptions.py:297
- Add tests for the 'queryout' direction to verify that supplying a
queryis enforced and that other options behave correctly. Also consider tests forrow_terminatorbehavior.
)
github-actions
bot
added
pr-size: large
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ADO Work Item Reference
Summary
This pull request introduces significant updates to the
mssql_pythonlibrary, focusing on enhancing theBCPOptionsandColumnFormatclasses, improving error handling, and adding comprehensive unit tests. The changes include refactoring the code for better maintainability, adding logging for debugging, and introducing new features and validations for bulk copy operations.Enhancements to
BCPOptionsandColumnFormat:BCPOptions(query,row_terminator,bulk_mode) andColumnFormat(user_data_type,terminator_len) to support additional BCP features. Updated default values for some fields. [1] [2] [3]columnsvs.format_file). Logging has been added for detailed error messages. [1] [2]Refactoring and Code Simplification:
row_terminatorfromColumnFormatandwrite_format_filefromBCPOptions) to streamline the codebase. [1] [2]directionandbulk_modeinto constants for better maintainability. [1] [2]New Constants for BCP Options:
BCPControlOptionsenum inconstants.pyto define string representations of BCP control options, improving clarity and consistency.Unit Tests for Bulk Copy Operations:
tests/test_007_bulkOptions.py) with unit tests forBCPOptionsandColumnFormat. Tests cover valid instantiations, invalid values, and edge cases such as conflicts betweencolumnsandformat_file.