Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a sentence about required fields to documentation #57

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added a sentence about required fields to documentation #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d84d8b
Added a sentence about required fields to documentation
EIjo Aug 1, 2024
5430c86
Ran docs/runmarkdown.R; added generated html files
janblom Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/RabbitInAHat.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@ <h2>Field to Field Mappings</h2>
<p>If you select the source table orange box, Rabbit-In-a-Hat will expose values the source data has for that table. This is meant to help in the process in understanding the source data and what logic may be required to handle the data in the ETL. In the example below <em>ndcnum</em> is selected and raw NDC codes are displayed starting with most frequent (note that in the WhiteRabbit scan a “Min cell count” could have been selected and values smaller than that count will not show).</p>
<p><img src="images/rabbitinahat-fieldex.png" /></p>
<p>Continue this process until all source columns necessary in all mapped tables have been mapped to the corresponding CDM column. Not all columns must be mapped into a CDM column and not all CDM columns require a mapping. One source column may supply information to multiple CDM columns and one CDM column can receive information from multiple columns.</p>
<p>Sidenote: fields with a <code>*</code> in front of their name are considered required fields. For source fields this means that this field was always populated when running the WhiteRabbit scans.</p>
</div>
<div id="output-generation" class="section level2">
<h2>Output generation</h2>
Expand Down
3 changes: 3 additions & 0 deletions docs/RabbitInAHat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,9 @@ Continue this process until all source columns necessary in all mapped tables ha
Not all columns must be mapped into a CDM column and not all CDM columns require a mapping.
One source column may supply information to multiple CDM columns and one CDM column can receive information from multiple columns.

Sidenote: fields with a `*` in front of their name are considered required fields.
For source fields this means that this field was always populated when running the WhiteRabbit scans.

## Output generation

### Generating an ETL Document
Expand Down
4 changes: 2 additions & 2 deletions docs/WhiteRabbit.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ <h4>PostgreSQL</h4>
<div id="google-bigquery" class="section level4">
<h4>Google BigQuery</h4>
<p>If you want to use a BigQuery instance as the source database, after installing WhiteRabbit, you will need to download a zip file with the BigQuery JDBC driver, and unzip it in de <code>repo</code> directory of the WhiteRabbit installation. The latest version tested with WhiteRabbit is 1.5.2.1005 .</p>
<p>The zip file can be downloaded <a href="https://storage.googleapis.com/simba-bq-release/jdbc/SimbaJDBCDriverforGoogleBigQuery42_1.5.2.1005.zip">here</a></p>
<p>The zip file can be downloaded <a href="https://storage.googleapis.com/simba-bq-release/jdbc/SimbaJDBCDriverforGoogleBigQuery42_1.5.2.1005.zip">here</a>.</p>
<p>Google BigQuery (GBQ) supports two different connection/authentication methods: application default credentials and service account authentication. The former method is considered more secure because it writes auditing events to stackdriver. The specific method used is determined by the arguments provided to the configuration panel as described below.</p>
<p>Authentication via application default credentials:</p>
<p>When using application default credentials authentication, you must run the following gcloud command in the user account only once: <code>gcloud auth application-default login</code> (do not include the single quote characters). An application key is written to <code>~/.config/gcloud/application_default_credentails.json</code>.</p>
Expand Down Expand Up @@ -539,7 +539,7 @@ <h4>Snowflake</h4>
<div id="teradata" class="section level4">
<h4>Teradata</h4>
<p>If you want to use a Teradata instance as the source database, after installing WhiteRabbit, you will need to download a zip file with the Teradata JDBC driver, and unzip it in de <code>repo</code> directory of the WhiteRabbit installation. The latest version tested with WhiteRabbit is 20.00.00.16 .</p>
<p>The zip file can be downloaded <a href="https://downloads.teradata.com/download/connectivity/jdbc-driver">here</a></p>
<p>The zip file can be downloaded <a href="https://downloads.teradata.com/download/connectivity/jdbc-driver">here</a>.</p>
</div>
</div>
</div>
Expand Down
Loading