feat: add table method to database

tswast · tswast · commit 1250d8ace73c · 2021-02-17T09:18:07.000-06:00
diff --git a/google/cloud/spanner_v1/database.py b/google/cloud/spanner_v1/database.py
@@ -602,6 +602,28 @@ def list_database_operations(self, filter_="", page_size=None):
             filter_=database_filter, page_size=page_size
         )
 
+    def table(self, table_id):
+        """Factory to create a table object within this database.
+
+        Note: This method does not create a table in Cloud Spanner, but it can
+        be used to check if a table exists.
+
+        .. code-block:: python
+
+           my_table = database.table("my_table")
+           if my_table.exists():
+               print("Table with ID 'my_table' exists.")
+           else:
+               print("Table with ID 'my_table' does not exist.")
+
+        :type table_id: str
+        :param table_id: The ID of the table.
+
+        :rtype: :class:`~google.cloud.spanner_v1.table.Table`
+        :returns: a table owned by this database.
+        """
+        return Table(table_id, self)
+
     def list_tables(self):
         """List tables within the database.
 
@@ -613,7 +635,7 @@ def list_tables(self):
         with self.snapshot() as snapshot:
             results = snapshot.execute_sql(_LIST_TABLES_QUERY)
             for row in results:
-                yield Table(row[0], self)
+                yield self.table(row[0])
 
 
 class BatchCheckout(object):
diff --git a/google/cloud/spanner_v1/instance.py b/google/cloud/spanner_v1/instance.py
@@ -361,7 +361,7 @@ def database(self, database_id, ddl_statements=(), pool=None):
         """Factory to create a database within this instance.
 
         :type database_id: str
-        :param database_id: The ID of the instance.
+        :param database_id: The ID of the database.
 
         :type ddl_statements: list of string
         :param ddl_statements: (Optional) DDL statements, excluding the
diff --git a/tests/unit/test_database.py b/tests/unit/test_database.py
@@ -1243,6 +1243,18 @@ def test_list_database_operations_explicit_filter(self):
             filter_=expected_filter_, page_size=page_size
         )
 
+    def test_table_factory_defaults(self):
+        from google.cloud.spanner_v1.table import Table
+
+        client = _Client()
+        instance = _Instance(self.INSTANCE_NAME, client=client)
+        pool = _Pool()
+        database = self._make_one(self.DATABASE_ID, instance, pool=pool)
+        my_table = database.table("my_table")
+        self.assertIsInstance(my_table, Table)
+        self.assertIs(my_table._database, database)
+        self.assertEqual(my_table.table_id, "my_table")
+
     def test_list_tables(self):
         client = _Client()
         instance = _Instance(self.INSTANCE_NAME, client=client)
