| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
About Collectors
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
Pre-requisites
Python 3.6 - 3.10
Access to the KADA Collector repository that contains the Oracle whl
The repository is currently hosted in KADA’s Azure Blob Storage. You will be given a SAS token to access the repository. Reach out to KADA Support (support@kada.ai) if you do not have access.
Download the Oracle whl (e.g. kada_collectors_extractors_oracle-#.#.#-py3-none-any.whl)
Access to K Landing Directory
Access toOracle (see section below)
...
If you are using TNSNAMES ensure the tnsnames.ora file is up to date with the correct entries to be referenced.
You can connect 3 ways.
Host/servicename
TNSNAME in the tnsnames.ora file
A connection descriptor
...
Step 1: Create the Source in K
Create a Oracle source in K
Go to Settings, Select Sources and click Add Source
Select “Load from File” option
Give the source a Name - e.g. Oracle Production
Add the Host name for the Oracle Server
Click Finish Setup
...
Step 2: Getting Access to the Source Landing Directory
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
Step 3: Install the Collector
It is recommended to use a python environment such as pyenv or pipenv if you are not intending to install this package at the system level.
Some python packages also have dependencies on the OS level packages, so you may be required to install additional OS packages if the below fails to install.
You can download the latest Core Library and whl via Platform Settings → Sources → Download Collectors
...
Run the following command to install the collector
| Code Block |
|---|
pip install kada_collectors_extractors_oracle-3.0.0-py3<version>-none-any.whl |
You will also need to install the common library kada_collectors_lib -1.0.0 for this collector to function properly.
| Code Block |
|---|
pip install kada_collectors_lib-1.0.0-py3<version>-none-any.whl |
| Info |
|---|
You may require an ODBC package for the OS to be installed as well as an oracle client library package if do you not have one already, see https://www.oracle.com/au/database/technologies/instant-client.html |
...
Step 4: Configure the Collector
The collector requires a set of parameters to connect to and extract metadata from Oracle
...
| Code Block | ||
|---|---|---|
| ||
{
"username": "",
"password": "",
"dsn": "",
"oracle_client_path": "",
"oracle_major_version": "12c",
"database_name": "",
"host_name": "",
"wallet_path": "",
"output_path": "/tmp/output",
"mask": true
"compress": true
} |
...
Step 5: Run the Collector
The following code is an example of how to run the extractor. You may need to uplift this code to meet any code standards at your organisation.
...
If you are handling external arguments of the runner yourself, you’ll need to consider additional items for the run method. Refer to this document for more information https://kadaai.atlassian.net/wiki/spaces/KSL/pages/1902411777/Additional+Notes#The-run-method
...
Step 6: Check the Collector Outputs
K Extracts
A set of files (eg metadata, databaselog, linkages, events etc) will be generated. These files will appear in the output_path directory you set in the configuration details
...
A high water mark file is created in the same directory as the execution called oracle_hwm.txt and produce files according to the configuration JSON. This file is only produced if you call the publish_hwm method.
...
Step 7: Push the Extracts to K
Once the files have been validated, you can push the files to the K landing directory.
You can use Azure Storage Explorer if you want to initially do this manually. You can push the files using python as well (see Airflow example below)
...
Example: Using Airflow to orchestrate the Extract and Push to K
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...