googleapis · sharoonthomas · Oct 26, 2023 · Nov 9, 2023 · Nov 2, 2023 · Nov 2, 2023
@@ -19,6 +19,7 @@ Maksym Voitko
 Maxim Zudilov (mxmzdlv)
 Maxime Beauchemin (mistercrunch)
 Romain Rigaux
+Sharoon Thomas (sharoonthomas)
 Sumedh Sakdeo
 Tim Swast (tswast)
 Vince Broz

@@ -35,7 +35,8 @@ In order to use this library, you first need to go through the following steps:
 .. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 .. note::
-   This library is only compatible with SQLAlchemy versions < 2.0.0
+   This library is a prerelease to gauge compatiblity with SQLAlchemy
+   versions >= 1.4.16 and < 2.1
 
 Installation
 ------------
@@ -108,7 +109,8 @@ SQLAlchemy
     from sqlalchemy.schema import *
     engine = create_engine('bigquery://project')
     table = Table('dataset.table', MetaData(bind=engine), autoload=True)
-    print(select([func.count('*')], from_obj=table).scalar())
+    print(select([func.count('*')], from_obj=table().scalar())
+
 
 Project
 ^^^^^^^
@@ -281,7 +283,7 @@ If you need additional control, you can supply a BigQuery client of your own:
 
     engine = create_engine(
         'bigquery://some-project/some-dataset?user_supplied_client=True',
-	connect_args={'client': custom_bq_client},
+	    connect_args={'client': custom_bq_client},
     )
 
 

@@ -369,7 +369,7 @@ def compliance(session):
         session.skip("Compliance tests were not found")
 
     session.install("--pre", "grpcio")
-    session.install("--pre", "--no-deps", "--upgrade", "sqlalchemy<2.0.0")
+    session.install("--pre", "--no-deps", "--upgrade", "sqlalchemy>=1.4.16,<2.1")
     session.install(
         "mock",
         "pytest",
@@ -543,7 +543,7 @@ def prerelease_deps(session):
 
     prerel_deps = [
         "protobuf",
-        "sqlalchemy<2.0.0",
+        "sqlalchemy>=1.4.16,<2.1",
         # dependency of grpc
         "six",
         "googleapis-common-protos",

@@ -42,14 +42,17 @@
     system_test_extras=extras,
     system_test_extras_by_python=extras_by_python,
 )
-s.move(templated_files, excludes=[
-    # sqlalchemy-bigquery was originally licensed MIT
-    "LICENSE", 
-    "docs/multiprocessing.rst",
-    # exclude gh actions as credentials are needed for tests
-    ".github/workflows",
-    "README.rst",
-])
+s.move(
+    templated_files,
+    excludes=[
+        # sqlalchemy-bigquery was originally licensed MIT
+        "LICENSE",
+        "docs/multiprocessing.rst",
+        # exclude gh actions as credentials are needed for tests
+        ".github/workflows",
+        "README.rst",
+    ],
+)
 
 # ----------------------------------------------------------------------------
 # Fixup files
@@ -59,7 +62,7 @@
     [".coveragerc"],
     "google/cloud/__init__.py",
     "sqlalchemy_bigquery/requirements.py",
-    )
+)
 
 s.replace(
     ["noxfile.py"],
@@ -75,48 +78,49 @@
 
 
 s.replace(
-    ["noxfile.py"], "--cov=google", "--cov=sqlalchemy_bigquery",
+    ["noxfile.py"],
+    "--cov=google",
+    "--cov=sqlalchemy_bigquery",
 )
 
 
 s.replace(
-    ["noxfile.py"], 
+    ["noxfile.py"],
     "\+ SYSTEM_TEST_EXTRAS",
     "",
 )
 
 
 s.replace(
     ["noxfile.py"],
-    '''"protobuf",
-        # dependency of grpc''',
-    '''"protobuf",
-        "sqlalchemy<2.0.0",
-        # dependency of grpc''',
+    """"protobuf",
+        # dependency of grpc""",
+    """"protobuf",
+        "sqlalchemy>=1.4.16,<2.1",
+        # dependency of grpc""",
 )
 
 
 s.replace(
     ["noxfile.py"],
     r"def default\(session\)",
-    "def default(session, install_extras=True)",    
+    "def default(session, install_extras=True)",
 )
 
 
-
-
 def place_before(path, text, *before_text, escape=None):
     replacement = "\n".join(before_text) + "\n" + text
     if escape:
         for c in escape:
-            text = text.replace(c, '\\' + c)
+            text = text.replace(c, "\\" + c)
     s.replace([path], text, replacement)
 
+
 place_before(
     "noxfile.py",
     "SYSTEM_TEST_PYTHON_VERSIONS=",
     "",
-    "# We're using two Python versions to test with sqlalchemy 1.3 and 1.4.",
+    "# We're using two Python versions to test with sqlalchemy>=1.4.16",
 )
 
 place_before(
@@ -126,15 +130,15 @@ def place_before(path, text, *before_text, escape=None):
 )
 
 
-install_logic = '''
+install_logic = """
     if install_extras and session.python in ["3.11", "3.12"]:
         install_target = ".[geography,alembic,tests,bqstorage]"
     elif install_extras:
         install_target = ".[all]"
     else:
         install_target = "."
     session.install("-e", install_target, "-c", constraints_path)
-'''
+"""
 
 place_before(
     "noxfile.py",
@@ -163,7 +167,7 @@ def compliance(session):
         session.skip("Compliance tests were not found")
 
     session.install("--pre", "grpcio")
-    session.install("--pre", "--no-deps", "--upgrade", "sqlalchemy<2.0.0") 
+    session.install("--pre", "--no-deps", "--upgrade", "sqlalchemy>=1.4.16,<2.1") 
     session.install(
         "mock",
         "pytest",
@@ -206,12 +210,11 @@ def compliance(session):
 '''
 
 place_before(
-     "noxfile.py",
-     "@nox.session(python=DEFAULT_PYTHON_VERSION)\n"
-     "def cover(session):",
-     compliance,
-     escape="()",
-     )
+    "noxfile.py",
+    "@nox.session(python=DEFAULT_PYTHON_VERSION)\n" "def cover(session):",
+    compliance,
+    escape="()",
+)
 
 s.replace(["noxfile.py"], '"alabaster"', '"alabaster", "geoalchemy2", "shapely"')
 
@@ -267,11 +270,10 @@ def system_noextras(session):
 
 place_before(
     "noxfile.py",
-    "@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS[-1])\n"
-    "def compliance(session):", 
+    "@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS[-1])\n" "def compliance(session):",
     system_noextras,
     escape="()[]",
-    )
+)
 
 
 # Add DB config for SQLAlchemy dialect test suite.
@@ -288,7 +290,7 @@ def system_noextras(session):
 [tool:pytest]
 addopts= --tb native -v -r fxX -p no:warnings
 python_files=tests/*test_*.py
-"""
+""",
 )
 
 # ----------------------------------------------------------------------------
@@ -299,7 +301,7 @@ def system_noextras(session):
 python.py_samples(skip_readmes=True)
 
 s.replace(
-    ["./samples/snippets/noxfile.py"], 
+    ["./samples/snippets/noxfile.py"],
     """session.install\("-e", _get_repo_root\(\)\)""",
     """session.install("-e", _get_repo_root())
     else:

@@ -28,6 +28,6 @@ requests==2.31.0
 rsa==4.9
 shapely==2.0.2
 six==1.16.0
-sqlalchemy===1.4.27
+sqlalchemy==1.4.16
 typing-extensions==4.9.0
 urllib3==2.1.0
@@ -99,9 +99,9 @@ def readme():
         # Until this issue is closed
         # https://github.com/googleapis/google-cloud-python/issues/10566
         "google-auth>=1.25.0,<3.0.0dev",  # Work around pip wack.
-        "google-cloud-bigquery>=2.25.2,<4.0.0dev",
+        "google-cloud-bigquery>=3.3.6,<4.0.0dev",
         "packaging",
-        "sqlalchemy>=1.2.0,<2.0.0dev",
+        "sqlalchemy>=1.4.16,<2.1",
     ],
     extras_require=extras,
     python_requires=">=3.8, <3.13",

@@ -103,6 +103,8 @@ def _setup_getitem(self, name):
         def __getattr__(self, name):
             if name.lower() in self.expr.type._STRUCT_byname:
                 return self[name]
+            else:
+                raise AttributeError(name)
 
     comparator_factory = Comparator
 

@@ -219,7 +219,7 @@ def visit_table_valued_alias(self, element, **kw):
         # For example, given SQLAlchemy code:
         #
         #   print(
-        #      select([func.unnest(foo.c.objects).alias('foo_objects').column])
+        #      select(func.unnest(foo.c.objects).alias('foo_objects').column)
         #      .compile(engine))
         #
         # Left to it's own devices, SQLAlchemy would outout:
@@ -388,7 +388,7 @@ def visit_in_op_binary(self, binary, operator_, **kw):
             self._generate_generic_binary(binary, " IN ", **kw)
         )
 
-    def visit_empty_set_expr(self, element_types):
+    def visit_empty_set_expr(self, element_types, **kw):
         return ""
 
     def visit_not_in_op_binary(self, binary, operator, **kw):
@@ -644,15 +644,15 @@ class BigQueryDDLCompiler(DDLCompiler):
     }
 
     # BigQuery has no support for foreign keys.
-    def visit_foreign_key_constraint(self, constraint):
+    def visit_foreign_key_constraint(self, constraint, **kw):
         return None
 
     # BigQuery has no support for primary keys.
-    def visit_primary_key_constraint(self, constraint):
+    def visit_primary_key_constraint(self, constraint, **kw):
         return None
 
     # BigQuery has no support for unique constraints.
-    def visit_unique_constraint(self, constraint):
+    def visit_unique_constraint(self, constraint, **kw):
         return None
 
     def get_column_specification(self, column, **kwargs):
@@ -760,14 +760,14 @@ def post_create_table(self, table):
 
         return " " + "\n".join(clauses)
 
-    def visit_set_table_comment(self, create):
+    def visit_set_table_comment(self, create, **kw):
         table_name = self.preparer.format_table(create.element)
         description = self.sql_compiler.render_literal_value(
             create.element.comment, sqlalchemy.sql.sqltypes.String()
         )
         return f"ALTER TABLE {table_name} SET OPTIONS(description={description})"
 
-    def visit_drop_table_comment(self, drop):
+    def visit_drop_table_comment(self, drop, **kw):
         table_name = self.preparer.format_table(drop.element)
         return f"ALTER TABLE {table_name} SET OPTIONS(description=null)"
 
@@ -1030,6 +1030,14 @@ def __init__(
 
     @classmethod
     def dbapi(cls):
+        """
+        Use `import_dbapi()` instead.
+        Maintained for backward compatibility.
+        """
+        return dbapi
+
+    @classmethod
+    def import_dbapi(cls):
         return dbapi
 
     @staticmethod
@@ -1202,7 +1210,21 @@ def _get_table(self, connection, table_name, schema=None):
             raise NoSuchTableError(table_name)
         return table
 
-    def has_table(self, connection, table_name, schema=None):
+    def has_table(self, connection, table_name, schema=None, **kw):
+        """Checks whether a table exists in BigQuery.
+
+        Args:
+            connection (google.cloud.bigquery.client.Client): The client
+                object used to interact with BigQuery.
+            table_name (str): The name of the table to check for.
+            schema (str, optional): The name of the schema to which the table
+                belongs. Defaults to the default schema.
+            **kw (dict): Any extra keyword arguments will be ignored.
+
+        Returns:
+            bool: True if the table exists, False otherwise.
+
+        """
         try:
             self._get_table(connection, table_name, schema)
             return True
@@ -1279,7 +1301,13 @@ def __init__(self, *args, **kwargs):
             raise TypeError("The unnest function requires a single argument.")
         arg = args[0]
         if isinstance(arg, sqlalchemy.sql.expression.ColumnElement):
-            if not isinstance(arg.type, sqlalchemy.sql.sqltypes.ARRAY):
+            if not (
+                isinstance(arg.type, sqlalchemy.sql.sqltypes.ARRAY)
+                or (
+                    hasattr(arg.type, "impl")
+                    and isinstance(arg.type.impl, sqlalchemy.sql.sqltypes.ARRAY)
+                )
+            ):
                 raise TypeError("The argument to unnest must have an ARRAY type.")
             self.type = arg.type.item_type
         super().__init__(*args, **kwargs)

@@ -24,6 +24,7 @@
 
 import sqlalchemy.testing.requirements
 import sqlalchemy.testing.exclusions
+from sqlalchemy.testing.exclusions import against, only_on
 
 supported = sqlalchemy.testing.exclusions.open
 unsupported = sqlalchemy.testing.exclusions.closed
@@ -136,6 +137,11 @@ def schemas(self):
 
         return unsupported()
 
+    @property
+    def array_type(self):
+        """Target database must support array_type"""
+        return supported()
+
     @property
     def implicit_default_schema(self):
         """target system has a strong concept of 'default' schema that can