MSSQL.get_column_info

MSSQL.get_column_info(table_name, schema_name=None, as_dict=True)[source]

Retrieve information about columns of a table.

Parameters:

  • table_name (str) – Name of the table to retrieve column information from.

  • schema_name (str | None) – Name of the schema where the table is located; defaults to DEFAULT_SCHEMA (i.e. 'master') if schema_name=None.

  • as_dict (bool) – Whether to return the column information as a dictionary; defaults to True.

Returns:

Information about all columns of the specified table in the currently-connected database.

Return type:

pandas.DataFrame | dict

See also