Skip to content

Commit 4aff75d

Browse files
committed
BigQuery: deprecate list_dataset_tables in favor of list_tables
1 parent 29620a1 commit 4aff75d

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

bigquery/google/cloud/bigquery/client.py

+13-2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import functools
2121
import os
2222
import uuid
23+
import warnings
2324

2425
import six
2526

@@ -389,8 +390,8 @@ def update_table(self, table, fields, retry=DEFAULT_RETRY):
389390
method='PATCH', path=table.path, data=partial, headers=headers)
390391
return Table.from_api_repr(api_response)
391392

392-
def list_dataset_tables(self, dataset, max_results=None, page_token=None,
393-
retry=DEFAULT_RETRY):
393+
def list_tables(self, dataset, max_results=None, page_token=None,
394+
retry=DEFAULT_RETRY):
394395
"""List tables in the dataset.
395396
396397
See
@@ -432,6 +433,16 @@ def list_dataset_tables(self, dataset, max_results=None, page_token=None,
432433
result.dataset = dataset
433434
return result
434435

436+
def list_dataset_tables(self, *args, **kwargs):
437+
"""DEPRECATED: List tables in the dataset.
438+
439+
Use :func:`~google.cloud.bigquery.client.Client.list_tables` instead.
440+
"""
441+
warnings.warn(
442+
'list_dataset_tables is deprecated, use list_tables instead.',
443+
DeprecationWarning)
444+
return self.list_tables(*args, **kwargs)
445+
435446
def delete_dataset(self, dataset, retry=DEFAULT_RETRY):
436447
"""Delete a dataset.
437448

bigquery/tests/system.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -230,11 +230,11 @@ def test_get_table_w_public_dataset(self):
230230
self.assertEqual(
231231
schema_names, ['word', 'word_count', 'corpus', 'corpus_date'])
232232

233-
def test_list_dataset_tables(self):
233+
def test_list_tables(self):
234234
DATASET_ID = _make_dataset_id('list_tables')
235235
dataset = self.temp_dataset(DATASET_ID)
236236
# Retrieve tables before any are created for the dataset.
237-
iterator = Config.CLIENT.list_dataset_tables(dataset)
237+
iterator = Config.CLIENT.list_tables(dataset)
238238
all_tables = list(iterator)
239239
self.assertEqual(all_tables, [])
240240
self.assertIsNone(iterator.next_page_token)
@@ -251,7 +251,7 @@ def test_list_dataset_tables(self):
251251
self.to_delete.insert(0, created_table)
252252

253253
# Retrieve the tables.
254-
iterator = Config.CLIENT.list_dataset_tables(dataset)
254+
iterator = Config.CLIENT.list_tables(dataset)
255255
all_tables = list(iterator)
256256
self.assertIsNone(iterator.next_page_token)
257257
created = [table for table in all_tables

0 commit comments

Comments
 (0)