BritishGeologicalSurvey / etlhelper

ETL Helper is a Python ETL library to simplify data transfer into and out of databases.
https://britishgeologicalsurvey.github.io/etlhelper/
GNU Lesser General Public License v3.0
100 stars 25 forks source link

Deprecate `get_rows` #176

Closed volcan01010 closed 1 year ago

volcan01010 commented 1 year ago

Summary

As an etlhelper developer, I would like to deprecate the get_rows function as it is a duplicate of fetchall so that there is less code / documentation to maintain.

Description

In early implementations of ETL Helper, the get_rows function was written to return all the rows. In time, we added more functions and aligned their names with the PEP 249 DB-API specs. fetchall performs exactly the same task as get_rows.

We now want to remove get_rows to minimise the code base. If you want to get all the rows, "There should be one-- and preferably only one --obvious way to do it.". fetchall is better as it is familiar from the PEP 249 specs.

This will require wide updates of the documentation, as well as updates to tests.

Acceptance criteria

volcan01010 commented 1 year ago

This was merged in for_v1