PostgresOSM.list_table_names

PostgresOSM.list_table_names(schema_name='public', verbose=False)

List the names of all tables in a schema.

Parameters

• schema_name (str) – name of a schema, defaults to 'public'

• verbose (bool or int) – whether to print relevant information in console as the function runs, defaults to False

Returns

a list of table names

Return type

list or None

Examples:

>>> from pyhelpers.sql import PostgreSQL

>>> testdb = PostgreSQL('localhost', 5432, username='postgres', database_name='testdb')
Password (postgres@localhost:5432): ***
Connecting postgres:***@localhost:5432/testdb ... Successfully.

>>> lst_tbl_names = testdb.list_table_names()
>>> print(lst_tbl_names)
[]

>>> lst_tbl_names = testdb.list_table_names(schema_name='testdb', verbose=True)
The schema "testdb" does not exist.

>>> # Create a new table named "test_table" in the schema "testdb"
>>> new_table_name = 'test_table'
>>> column_specs = 'col_name_1 INT, col_name_2 TEXT'
>>> testdb.create_table(new_table_name, column_specs, verbose=True)
Creating a table: "public"."test_table" ... Done.

>>> lst_tbl_names = testdb.list_table_names(schema_name='public')
>>> print(lst_tbl_names)
['test_table']

>>> # Delete the database "testdb"
>>> testdb.drop_database(verbose=True)
To drop the database "testdb" from postgres:***@localhost:5432
? [No]|Yes: yes
Dropping "testdb" ... Done.