many updates

Author: daimor

requirements-iris.txt

@@ -1 +1 @@
-https://github.com/intersystems-community/intersystems-irispython/releases/download/3.7.9/intersystems_iris-3.7.9-py3-none-any.whl
+https://github.com/intersystems-community/intersystems-irispython/releases/download/3.9.1/intersystems_iris-3.9.1-py3-none-any.whl

sqlalchemy_iris/base.py

@@ -653,6 +653,20 @@ def visit_drop_schema(self, drop, **kw):
     def visit_check_constraint(self, constraint, **kw):
         pass
 
+    def create_table_constraints(self, table, **kw):
+        description = ""
+        comment = table.comment
+        if comment:
+            # hack to keep \r, kind of
+            comment = comment.replace('\r', '\n\t')
+            literal = self.sql_compiler.render_literal_value(comment, sqltypes.String())
+            description = "%DESCRIPTION " + literal
+
+        constraints = super().create_table_constraints(table, **kw)
+        if constraints and description:
+            description = ", \n\t" + description
+        return constraints + description
+
     def visit_add_constraint(self, create, **kw):
         if isinstance(create.element, schema.CheckConstraint):
             raise exc.CompileError("Can't add CHECK constraint")
@@ -701,6 +715,7 @@ def get_column_specification(self, column, **kwargs):
 
         comment = column.comment
         if comment is not None:
+            comment = comment.replace('\r', '\n\t')
             literal = self.sql_compiler.render_literal_value(comment, sqltypes.String())
             colspec.append("%DESCRIPTION " + literal)
 
@@ -883,6 +898,12 @@ class IRISDialect(default.DefaultDialect):
     type_compiler = IRISTypeCompiler
     execution_ctx_cls = IRISExecutionContext
 
+    insert_returning = True
+    insert_executemany_returning = True
+    insert_executemany_returning_sort_by_parameter_order = True
+    update_executemany_returning = False
+    delete_executemany_returning = False
+
     construct_arguments = [
         (schema.Index, {"include": None}),
     ]
@@ -1105,6 +1126,38 @@ def get_schema(self, schema=None):
             return "SQLUser"
         return schema
 
+    @reflection.cache
+    def get_table_options(self, connection, table_name, schema=None, **kw):
+        if not self.has_table(connection=connection, table_name=table_name, schema=schema):
+            raise exc.NoSuchTableError(
+                f"{schema}.{table_name}" if schema else table_name
+            ) from None
+        return {}
+
+    @reflection.cache
+    def get_table_comment(self, connection, table_name, schema=None, **kw):
+        if not self.has_table(connection=connection, table_name=table_name, schema=schema):
+            raise exc.NoSuchTableError(
+                f"{schema}.{table_name}" if schema else table_name
+            ) from None
+
+        tables = ischema.tables
+        schema_name = self.get_schema(schema)
+
+        s = sql.select(tables.c.description).where(
+            sql.and_(
+                tables.c.table_schema == str(schema_name),
+                tables.c.table_name == str(table_name),
+            )
+        )
+        comment = connection.execute(s).scalar()
+        if comment:
+            # make it as \r
+            comment = comment.replace(' \t\t\t\t', '\r')
+            # restore \n
+            comment = comment.replace(' \t\t\t', '\n')
+        return {"text": comment}
+
     @reflection.cache
     def get_schema_names(self, connection, **kw):
         s = sql.select(ischema.schemata.c.schema_name).order_by(
@@ -1131,7 +1184,7 @@ def get_table_names(self, connection, schema=None, **kw):
         return table_names
 
     @reflection.cache
-    def get_temp_table_names(self, connection, dblink=None, **kw):
+    def get_temp_table_names(self, connection, **kw):
         tables = ischema.tables
         s = (
             sql.select(tables.c.table_name)
@@ -1598,6 +1651,7 @@ def get_multi_columns(
                 columns.c.column_default,
                 columns.c.collation_name,
                 columns.c.auto_increment,
+                columns.c.description,
             )
             .select_from(columns)
             .where(
@@ -1650,7 +1704,12 @@ def get_multi_columns(
                 sqlComputeCode = row[property.c.SqlComputeCode]
                 calculated = row[property.c.Calculated]
                 transient = row[property.c.Transient]
-            # description = row[columns.c.description]
+            comment = row[columns.c.description]
+            if comment:
+                # make it as \r
+                comment = comment.replace(' \t\t\t\t', '\r')
+                # restore \n
+                comment = comment.replace(' \t\t\t', '\n')
 
             coltype = self.ischema_names.get(type_, None)
 
@@ -1696,7 +1755,7 @@ def get_multi_columns(
                 "nullable": nullable,
                 "default": default,
                 "autoincrement": autoincrement,
-                # "comment": description,
+                "comment": comment,
             }
             if sqlComputeCode and "set {*} = " in sqlComputeCode.lower():
                 sqltext = sqlComputeCode

sqlalchemy_iris/information_schema.py

@@ -44,6 +44,7 @@ def process_result_value(self, value, dialect):
     Column("TABLE_NAME", String, key="table_name"),
     Column("TABLE_TYPE", String, key="table_type"),
     Column("CLASSNAME", String, key="classname"),
+    Column("DESCRIPTION", String, key="description"),
     schema="INFORMATION_SCHEMA",
 )
 
@@ -69,7 +70,7 @@ def process_result_value(self, value, dialect):
     Column("AUTO_INCREMENT", YESNO, key="auto_increment"),
     Column("UNIQUE_COLUMN", YESNO, key="unique_column"),
     Column("PRIMARY_KEY", YESNO, key="primary_key"),
-    Column("DESCIPTION", String, key="desciption"),
+    Column("DESCRIPTION", String, key="description"),
     schema="INFORMATION_SCHEMA",
 )
 property_definition = Table(

sqlalchemy_iris/requirements.py

@@ -58,6 +58,22 @@ def datetime_historic(self):
 
         return exclusions.open()
 
+    @property
+    def reflect_table_options(self):
+        return exclusions.open()
+
+    @property
+    def comment_reflection(self):
+        return exclusions.open()
+
+    @property
+    def insert_returning(self):
+        return exclusions.open()
+
+    @property
+    def unusual_column_name_characters(self):
+        return exclusions.open()
+
     @property
     def computed_columns(self):
         "Supports computed columns"

tests/conftest.py

@@ -1,6 +1,7 @@
 from sqlalchemy.dialects import registry
 import pytest
 import time
+import os
 
 from sqlalchemy.testing.plugin.plugin_base import pre
 
@@ -46,6 +47,7 @@ def start_container(opt, file_config):
         username="sqlalchemy",
         password="sqlalchemy",
         namespace="TEST",
+        license_key=os.path.expanduser("~/iris.key") if "community" not in opt.container else None,
     )
     iris.start()
     print("dburi:", iris.get_connection_url())
@@ -54,6 +56,6 @@ def start_container(opt, file_config):
 
 def pytest_unconfigure(config):
     global iris
-    if iris:
-        print("Stopping IRIS container")
+    if iris and iris._container:
+        print("Stopping IRIS container", iris)
         iris.stop()

tests/test_alembic.py

@@ -70,7 +70,9 @@ def tables(self, connection):
             self.meta.drop_all(connection)
 
         def test_drop_col_with_fk(self, ops_context, connection, tables):
-            ops_context.drop_column("round_trip_table", "oid_fk", schema=self.meta.schema)
+            ops_context.drop_column(
+                "round_trip_table", "oid_fk", schema=self.meta.schema
+            )
             insp = inspect(connection)
             eq_(insp.get_foreign_keys("round_trip_table", schema=self.meta.schema), [])
 
@@ -112,9 +114,9 @@ def test_str_to_blob(self, connection, ops_context):
 
             result = connection.execute(text("select col from tab")).all()
             assert result == [
-                (bytearray(b"'some data 1'"),),
-                (bytearray(b"'some data 2'"),),
-                (bytearray(b"'some data 3'"),),
+                (b"some data 1",),
+                (b"some data 2",),
+                (b"some data 3",),
             ]
 
             insp = inspect(connection)

tests/test_suite.py

@@ -2,6 +2,8 @@
 
 from sqlalchemy.testing.suite import FetchLimitOffsetTest as _FetchLimitOffsetTest
 from sqlalchemy.testing.suite import CompoundSelectTest as _CompoundSelectTest
+from sqlalchemy.testing.suite import TableDDLTest as _TableDDLTest
+from sqlalchemy.testing.suite import FutureTableDDLTest as _FutureTableDDLTest
 from sqlalchemy.testing.suite import CTETest as _CTETest
 from sqlalchemy.testing.suite import DifficultParametersTest as _DifficultParametersTest
 from sqlalchemy.testing import fixtures
@@ -63,9 +65,19 @@ def test_select_recursive_round_trip(self):
         pass
 
 
-@pytest.mark.skip()
 class DifficultParametersTest(_DifficultParametersTest):
-    pass
+
+    tough_parameters = _DifficultParametersTest.tough_parameters
+
+    @tough_parameters
+    def test_round_trip_same_named_column(
+        self, paramname, connection, metadata
+    ):
+        if paramname == 'dot.s':
+            # not supported
+            pytest.skip()
+            return
+        super().test_round_trip_same_named_column(paramname, connection, metadata)
 
 
 class FetchLimitOffsetTest(_FetchLimitOffsetTest):
@@ -486,3 +498,21 @@ def test_concat_func(self):
                 ("sometestdata",),
             ],
         )
+
+
+class TableDDLTest(_TableDDLTest):
+    # IRIS does not want to update comments on the fly
+    def test_add_table_comment(self, connection):
+        pass
+
+    def test_drop_table_comment(self, connection):
+        pass
+
+
+class FutureTableDDLTest(_FutureTableDDLTest):
+    # IRIS does not want to update comments on the fly
+    def test_add_table_comment(self, connection):
+        pass
+
+    def test_drop_table_comment(self, connection):
+        pass