This plugin allows vdk-core to interface with and execute queries against an Impala database.
Features
- It provides a powerful recovery mechanism handling a lot of challenges - like eventual consistency issues in Impala and more. In one production deployment of VDK it was able to improve SLA of Impala from 95% (queries directly to Impala) to 99% (queries using VDK to Impala).
- It automatically classifies error based on who is best responsible to handle them - user (job owner) vs platform (infra owner).
- It provides a default implementation of Kimball templates for generating SCD1, SCD2 dimension tables, Periodic Snapshot Fact Table
- It can collect lineage data, assuming a lineage logger has been provided through the vdk-core configuration (see
vdk config-helpfor more info)
Usage
Run
pip install vdk-impala
After this, data jobs will have access to a Impala database connection, managed by Versatile Data Kit SDK.
If it is the only database plugin installed , vdk would automatically use it.
Otherwise, users need to set VDK_DB_DEFAULT_TYPE=IMPALA as an environment variable or set 'db_default_type' option in the data job config file (config.ini).
For example
def run(job_input: IJobInput):
job_input.execute_query("select 'Hi Impala!'")
Lineage
The package can gather lineage data for all successful Impala SQL queries that have actually read or written data. Other plugins can read and optionally send the lineage data to separate system. They need to provide ILineageLogger implementation and hook this way:
@hookimpl
def vdk_initialize(context: CoreContext) -> None:
context.state.set(StoreKey[ILineageLogger]("impala-lineage-logger"), MyLogger())
Lineage is calculated based on the executed query profile. It is retrieved via the cursor by executing additional RPC request against the same Impala node that has coordinated the query right after the original query has successfully finished. See https://impala.apache.org/docs/build/html/topics/impala_logging.html for more information how profiles are stored and here https://impala.apache.org/docs/build/impala-3.1.pdf for more information about the profiles themselves.
If enabled, query plan is retrieved for every successfully executed query against Impala excluding keepalive queries like "Select 1".
Database Loading Templates
Kimbal dimensional modeling templates
-
SCD2 dimension tables
See the following tutorial for more details. It is based on Trino but the process is equivalent for Impala (only the database configuration requires change).
Data Quality Checks
Most of the processing templates support quality checks that are used for preventing bad data going into production tables. The checks represent a callback function that is passed as an optional parameter to the job_input.execute_template() method.
Example:
def run(job_input: IJobInput) -> None:
def check(tmp_table_name):
result = #Implement your data quality check logic and return True/False
return result
job_input.execute_template(
template_name="load/dimension/scd1",
"source_schema": test_schema,
"source_view": source_view,
"target_schema": test_schema,
"target_table": target_table,
"check": check,
"staging_schema": staging_schema, #If not provided the checks would be performed in the target_schema
)
Configuration
Run vdk config-help - search for those prefixed with "IMPALA_" to see what configuration options are available.
Disclaimer
This plugin is tested against a specific impala version. The version comes from the docker-compose.yaml container's impala version. For more information on the imapala version tested against please google the docker image.
Testing
Testing this plugin locally requires installing the dependencies listed in vdk-plugins/vdk-impala/requirements.txt
Run
pip install -r requirements.txt
1 maintainer
Metadata
1 maintainer
Release files for vdk-impala 0.4.1227724565
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vdk-impala-0.4.1227724565.tar.gz | 31.0 kB | Details |
Release files / vdk-impala-0.4.1227724565.tar.gz
| Download URL | vdk-impala-0.4.1227724565.tar.gz |
|---|---|
| Size | 31.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3011ab783ef89b46a793c3d40d862a64f931768d8182cdd6daeb048e48453030
|
|
BLAKE2b-256 checksum How to use checksums |
1fbf74dc28bb363cab9ca7aa0cced3cfd8b3757805cdd25b8f1c29c2b912aae1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.13
|
