Fix missing fields in bill runs view #599
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
https://eaflood.atlassian.net/browse/WATER-4057 As part of the work we have been doing on two-part tariff, we will be creating all our new tables in the default `public` schema. We have also decided that when there is a legacy table that we are still going to need we will create a [View](https://www.postgresql.org/docs/current/sql-createview.html) of it in the `public` schema. This allows us to correct any issues with naming conventions, strip out unused fields, and join entities currently sat in different schemas. The first example of this approach was done in PR #531 . In [Create water schema views](#551) we created the view for `water.billing_batches` and dropped a column we thought wasn't needed and renamed one we thought was wrong. We actually use `errorCode:` in our own codebase during supplementary billing if a bill run fails so it is needed. And `invoiceCount` actually refers to the number of debit (positive value) bills in a bill run, not the total number of bills. 'Invoice' rather than 'Debit' is the term used throughout the UI. So, we need to revert the name change. > Note - when it comes to views you have to drop and recreate them. Unlike tables you cannot alter columns individually diff --git a/db/migrations/public/20231215174532_alter-bill-runs-view.js b/db/migrations/public/20231215174532_alter-bill-runs-view.js new file mode 100644 index 0000000..af07d8e --- /dev/null +++ b/db/migrations/public/20231215174532_alter-bill-runs-view.js @@ -0,0 +1,68 @@ +'use strict' + +const viewName = 'bill_runs' + +exports.up = function (knex) { + return knex + .schema + .dropView(viewName) + .createView(viewName, (view) => { + view.as(knex('billing_batches').withSchema('water').select([ + 'billing_batch_id AS id', + 'region_id', + 'batch_type', + 'from_financial_year_ending', + 'to_financial_year_ending', + 'status', + 'invoice_count', + 'credit_note_count', + 'net_total', + 'bill_run_number', + 'error_code', + 'external_id', + 'is_summer AS summer', + 'source', + 'legacy_id', + 'metadata', + 'invoice_value', + 'credit_note_value', + 'transaction_file_reference', + 'scheme', + 'date_created AS created_at', + 'date_updated AS updated_at' + ])) + }) +} + +exports.down = function (knex) { + return knex + .schema + .dropView(viewName) + .createView(viewName, (view) => { + // NOTE: We have commented out unused columns from the source table + view.as(knex('billing_batches').withSchema('water').select([ + 'billing_batch_id AS id', + 'region_id', + 'batch_type', + 'from_financial_year_ending', + 'to_financial_year_ending', + 'status', + 'invoice_count AS bill_count', + 'credit_note_count', + 'net_total', + 'bill_run_number', + // 'error_code', + 'external_id', + 'is_summer AS summer', + 'source', + 'legacy_id', + 'metadata', + 'invoice_value', + 'credit_note_value', + 'transaction_file_reference', + 'scheme', + 'date_created AS created_at', + 'date_updated AS updated_at' + ])) + }) +}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://eaflood.atlassian.net/browse/WATER-4057
As part of the work we have been doing on two-part tariff, we will create all our new tables in the default
publicschema.We have also decided that when there is a legacy table that we are still going to need we will create a View of it in the
publicschema. This allows us to correct any issues with naming conventions, strip out unused fields, and join entities currently sat in different schemas. The first example of this approach was done in PR #531 .In Create water schema views we created the view for
water.billing_batchesand dropped a column we thought wasn't needed and renamed one we thought was wrong.We use
errorCode:in our codebase during supplementary billing if a bill run fails so it is needed. AndinvoiceCountrefers to the number of debit (positive value) bills in a bill run, not the total number. 'Invoice' rather than 'Debit' is used throughout the UI. So, we need to revert the name change.