[Issue 2934] Create opp tbls in analytics (#3081)

## Summary
Fixes #{[2934](#2934)}

### Time to review: __10 mins__

## Changes proposed
Migration file to copy initial opportunity tables.

1. lk_opportunity_status
2. lk_opportunity_category
3. opportunity
4. opportunity_summary
5. current_opportunity_summary 


Added documentation for future reference

analytics/src/analytics/integrations/etldb/migrations/versions/0006_add_opportunity_tables.sql

@@ -0,0 +1,129 @@
+CREATE TABLE IF NOT EXISTS lk_opportunity_status
+(
+    opportunity_status_id SERIAL
+        PRIMARY KEY,
+    description           TEXT                       NOT NULL,
+    created_at            TIMESTAMP WITH TIME ZONE   NOT NULL,
+    updated_at            TIMESTAMP WITH TIME ZONE   NOT NULL
+);
+
+CREATE TABLE IF NOT EXISTS lk_opportunity_category
+(
+    opportunity_category_id SERIAL
+        PRIMARY KEY,
+    description             TEXT                                   NOT NULL,
+    created_at              TIMESTAMP WITH TIME ZONE               NOT NULL,
+    updated_at              TIMESTAMP WITH TIME ZONE               NOT NULL
+);
+
+
+CREATE TABLE IF NOT EXISTS opportunity
+(
+    opportunity_id          BIGSERIAL
+        primary key,
+    opportunity_number      TEXT,
+    opportunity_title       TEXT,
+    agency_code             TEXT,
+    opportunity_category_id INTEGER
+        CONSTRAINT opportunity_opportunity_category_id_lk_opportunity_cate_c6e9
+            REFERENCES lk_opportunity_category,
+    category_explanation    TEXT,
+    is_draft                BOOLEAN                                NOT NULL,
+    revision_number         INTEGER,
+    modified_comments       TEXT,
+    publisher_user_id       TEXT,
+    publisher_profile_id    BIGINT,
+    created_at              TIMESTAMP WITH TIME ZONE               NOT NULL,
+    updated_at              TIMESTAMP WITH TIME ZONE               NOT NULL
+);
+
+CREATE INDEX IF NOT EXISTS opportunity_is_draft_idx
+    ON opportunity (is_draft);
+
+CREATE INDEX IF NOT EXISTS opportunity_opportunity_category_id_idx
+    ON opportunity (opportunity_category_id);
+
+CREATE INDEX IF NOT EXISTS opportunity_opportunity_title_idx
+    ON opportunity (opportunity_title);
+
+CREATE INDEX IF NOT EXISTS opportunity_agency_code_idx
+    ON opportunity (agency_code);
+
+
+CREATE TABLE IF NOT EXISTS opportunity_summary
+(
+    opportunity_summary_id            BIGSERIAL
+        PRIMARY KEY,
+    opportunity_id                    BIGINT                                 NOT NULL
+        CONSTRAINT opportunity_summary_opportunity_id_opportunity_fkey
+            REFERENCES opportunity,
+    summary_description               TEXT,
+    is_cost_sharing                   BOOLEAN,
+    is_forecast                       BOOLEAN                                NOT NULL,
+    post_date                         DATE,
+    close_date                        DATE,
+    close_date_description            TEXT,
+    archive_date                      DATE,
+    unarchive_date                    DATE,
+    expected_number_of_awards         BIGINT,
+    estimated_total_program_funding   BIGINT,
+    award_floor                       BIGINT,
+    award_ceiling                     BIGINT,
+    additional_info_url               TEXT,
+    additional_info_url_description   TEXT,
+    forecasted_post_date              DATE,
+    forecasted_close_date             DATE,
+    forecasted_close_date_description TEXT,
+    forecasted_award_date             DATE,
+    forecasted_project_start_date     DATE,
+    fiscal_year                       INTEGER,
+    revision_number                   INTEGER,
+    modification_comments             TEXT,
+    funding_category_description      TEXT,
+    applicant_eligibility_description TEXT,
+    agency_code                       TEXT,
+    agency_name                       TEXT,
+    agency_phone_number               TEXT,
+    agency_contact_description        TEXT,
+    agency_email_address              TEXT,
+    agency_email_address_description  TEXT,
+    is_deleted                        BOOLEAN,
+    can_send_mail                     BOOLEAN,
+    publisher_profile_id              BIGINT,
+    publisher_user_id                 TEXT,
+    updated_by                        TEXT,
+    created_by                        TEXT,
+    created_at                        TIMESTAMP WITH TIME ZONE   NOT NULL,
+    updated_at                        TIMESTAMP WITH TIME ZONE   NOT NULL,
+    version_number                    INTEGER,
+    CONSTRAINT opportunity_summary_is_forecast_uniq
+        UNIQUE (is_forecast, revision_number, opportunity_id)
+);
+
+CREATE INDEX IF NOT EXISTS opportunity_summary_opportunity_id_idx
+    ON opportunity_summary (opportunity_id);
+
+CREATE TABLE IF NOT EXISTS  current_opportunity_summary
+(
+    opportunity_id         BIGINT                                 NOT NULL
+        CONSTRAINT current_opportunity_summary_opportunity_id_opportunity_fkey
+            REFERENCES  opportunity,
+    opportunity_summary_id BIGINT                                 NOT NULL
+        CONSTRAINT current_opportunity_summary_opportunity_summary_id_oppo_8251
+            REFERENCES  opportunity_summary,
+    opportunity_status_id  INTEGER                                NOT NULL
+        CONSTRAINT current_opportunity_summary_opportunity_status_id_lk_op_3147
+            REFERENCES  lk_opportunity_status,
+    created_at             TIMESTAMP WITH TIME ZONE   NOT NULL,
+    updated_at             TIMESTAMP WITH TIME ZONE   NOT NULL,
+    PRIMARY KEY (opportunity_id, opportunity_summary_id)
+);
+
+CREATE INDEX IF NOT EXISTS current_opportunity_summary_opportunity_id_idx
+    ON  current_opportunity_summary (opportunity_id);
+
+CREATE INDEX IF NOT EXISTS current_opportunity_summary_opportunity_status_id_idx
+    ON  current_opportunity_summary (opportunity_status_id);
+
+CREATE INDEX IF NOT EXISTS current_opportunity_summary_opportunity_summary_id_idx
+    ON  current_opportunity_summary (opportunity_summary_id);

documentation/analytics/development.md

@@ -174,3 +174,32 @@ Additional guidance on working with the CLI tool can be found in the [usage guid
 2. Wrap this function with a [sub-command `typer` decorator](https://typer.tiangolo.com/tutorial/subcommands/single-file/). For example if you want to calculate sprint burndown with the entrypoint `analytics calculate sprint_burndown`, you'd use the decorator: `metrics_app.command(name="sprint_burndown")`
 3. If the function accepts parameters, [annotate those parameters](https://typer.tiangolo.com/tutorial/options/name/).
 4. Add *at least* one unit test for the CLI entrypoint, optionally mocking potential side effects of calling the entrypoint.
+
+### Copying table from grants-db
+
+1. Add a new sql migration file in `src/analytics/integrations/etldb/migrations/versions` and prefix file name with the next iteration number (ex: `0007`).
+2. Use your database management system(ex: `pg_admin`, `db_beaver`...) and right-click on the table you wish to copy and select `SQL scripts` then `request and copy original DDL` 
+3. Paste the DDL in your new migration file. Fix any formating issues, see previous migration files for reference.
+4. Remove all reference to schema, roles, triggers and the use of `default now()` for timestamp columns.
+
+    Example: 
+    ``` sql 
+    create table if not exists opi.opportunity
+    ( 
+     ...,
+     created_at              timestamp with time zone default now() not null,
+     ...
+    )
+    ```
+    should be
+    ``` sql 
+    CREATE TABLE IF NOT EXISTS opportunity;
+    ( 
+     ...,
+     created_at              timestamp with time zone not null
+     ...
+    )
+      ```
+
+5. Run migration via `make db-migrate` command
+