Describe the feature
As we near the release of v1.0.0, this is a change to change the names of the functions we export.
Here are all exported functions and my suggestion for changes:
Changes wanted or discussion needed
| Function |
Suggestion |
Reason |
defer_db_cleanup |
defer_remove_table |
defer_ works well with withr convention but db_cleanup is not clear. remove_table is aligned with DBI::dbRemoveTable. |
is.historical |
is_historical |
Periods in functions are a confusing relic of R which interacts badly with S3 methods |
digest_to_checksum |
add_checksum |
Since we are returning the data with a checksum column added or mutated if existing so mutate_checksum could be an alternative |
update_snapshot |
save_snapshot |
I don't think were "updating" snapshots rather, we are saving snapshots |
No changes needed:
| Function |
Comment |
filter_keys |
filter_keys works okay-ish, but maybe subset gives a more clear picture. It is more a filter than a subset - as applied to both target and incoming. |
interlace |
I think interlace is not bad, but like other alternatives in my mind, it does not exactly describe |
unique_table_name |
Not clear if it makes or checks uniqueness. |
Logger, LoggerNull |
Uses R6 naming scheme (PascalCase) which fits well with convention |
get_connection, close_connection |
Clear concise names |
create_table, create_index, create_logs_if_missing |
Clear concise names |
get_catalog, get_schema, get_table, get_tables |
Clear concise names |
lock_table, unlock_table |
Clear concise names |
id |
Inspired by the DBI::Id() function |
slice_time |
Follows the naming style of dplyr::slice_min(), dplyr::slice_max() etc. |
table_exists, schema_exists |
Clear concise names |
db_timestamp |
Good enough |
What use will this feature have?
More intuitive usage of the SCDB functions
Who should add the feature?
N/A
Additional context
N/A
Describe the feature
As we near the release of v1.0.0, this is a change to change the names of the functions we export.
Here are all exported functions and my suggestion for changes:
Changes wanted or discussion needed
defer_db_cleanupdefer_remove_tabledefer_works well withwithrconvention butdb_cleanupis not clear.remove_tableis aligned withDBI::dbRemoveTable.is.historicalis_historicaldigest_to_checksumadd_checksumchecksumcolumn added or mutated if existing somutate_checksumcould be an alternativeupdate_snapshotsave_snapshotNo changes needed:
filter_keysfilter_keysworks okay-ish, but maybesubsetgives a more clear picture. It is more a filter than a subset - as applied to both target and incoming.interlaceinterlaceis not bad, but like other alternatives in my mind, it does not exactly describeunique_table_nameLogger,LoggerNullget_connection,close_connectioncreate_table,create_index,create_logs_if_missingget_catalog,get_schema,get_table,get_tableslock_table,unlock_tableidDBI::Id()functionslice_timedplyr::slice_min(),dplyr::slice_max()etc.table_exists,schema_existsdb_timestampWhat use will this feature have?
More intuitive usage of the SCDB functions
Who should add the feature?
N/A
Additional context
N/A