vantage6.algorithm.tools.wrappers.get_column_names#

get_column_names(database_uri, db_type=None, query=None, sheet_name=None)#

Get the column names of dataframe that will be loaded into an algorithm

Parameters:

  • database_uri (str) – Path to the database file or URI of the database.

  • db_type (str) – The type of the database. This should be one of the CSV, SQL, Excel, Sparql or Parquet.

  • query (str) – The query to execute on the database. This is required for SQL and Sparql databases.

  • sheet_name (str) – The sheet name to read from the Excel file. This is optional and only for Excel databases.

Returns:

The column names of the dataframe

Return type:

list[str]