Escaping objects for log based replication, adding conn_properties and enable_tds_logging

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.5.0
+current_version = 2.6.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

CHANGELOG.md

@@ -1,3 +1,10 @@
+# tap-mssql 2.6.0 2024-09-02
+* Resolving issue LOG_BASED tables with special characters. Escaping the object
+  names with double quotes. Issue #74
+* Providing more flexibility with database connections to support newer
+  SQL Server instances like PDW via option conn_properties config. Issue #28
+* Provides the ability to dump TDS logs via new enable_tds_logging config.
+
 # tap-mssql 2.5.0 2024-08-26
 
 * removing tox-poetry-install - Not well supported.

README.md

@@ -134,6 +134,37 @@ The characterset for the database / source system. The default is `utf8`, howeve
 }
 ```
 
+Optional:
+
+The `"conn_properties"` allows specific tweaking of database settings via SQL set statements to send to the database instance upon connection establishment. Can be a string or another kind of iterable of strings.
+
+The default values set if this [settings](https://pymssql.readthedocs.io/en/stable/ref/_mssql.html) is not defined are:
+
+```json
+"SET ARITHABORT ON; SET CONCAT_NULL_YIELDS_NULL ON; SET ANSI_NULLS ON; SET ANSI_NULL_DFLT_ON ON; SET ANSI_PADDING ON; SET ANSI_WARNINGS ON; SET ANSI_NULL_DFLT_ON ON; SET CURSOR_CLOSE_ON_COMMIT ON; SET QUOTED_IDENTIFIER ON; SET TEXTSIZE 2147483647;"
+```
+
+Example: override the built-in session properties supplied by pymssql by default, because one of the default settings (CURSOR_CLOSE_ON_COMMIT) is not available on PDW
+
+
+```json
+{
+  "conn_properties": "SET ARITHABORT ON; SET CONCAT_NULL_YIELDS_NULL ON; SET ANSI_NULLS ON; SET ANSI_NULL_DFLT_ON ON; SET ANSI_PADDING ON; SET ANSI_WARNINGS ON; SET ANSI_NULL_DFLT_ON ON; SET QUOTED_IDENTIFIER ON; SET TEXTSIZE 2147483647;"
+}
+```
+
+Optional:
+
+The `"enable_tds_logging"` When set it will dump out the underlying TDS driver logs. Useful for diagnosing issues if you are having connection issues to SQL Server databases. WARNING! this
+does dump a lot of information and may log secure data, should be only used in Development
+environments.
+
+```json
+{
+  "enable_tds_logging": true
+}
+```
+
 These are the same basic configuration properties used by the mssql command-line
 client (`mssql`).
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tap-mssql"
-version = "2.5.0"
+version = "2.6.0"
 description = "A pipelinewise compatible tap for connecting Microsoft SQL Server"
 authors = ["Rob Winters <[email protected]>"]
 license = "GNU Affero"