search

catalyst-cooperative / pudl

The Public Utility Data Liberation Project provides analysis-ready energy system data to climate advocates, researchers, policymakers, and journalists.
https://catalyst.coop/pudl
MIT License
456 stars 105 forks source link

Devise naming convention for PUDL DB table columns #33

Closed zaneselvans closed 6 years ago

zaneselvans commented 7 years ago

Many of the database tables we are creating have dozens of columns. We need readable, memorable, tab-completable convention for naming them. This could be based on the table or data source they are being imported from, and also the nature of the data within them.

zaneselvans commented 7 years ago

Probably the field names should be all lower case with underscores, and not unnecessarily duplicate information contained in their parent table name (e.g. in a table named "fuel" we could have fields called "type" and "unit" or we could have fields called "fuel_type" and "fuel_unit" but the fact that these fields pertain to fuel is already encoded in the fact they're part of the fuel table...