Upsolver Iceberg Auditor CLI
Project description
Iceberg Diagnostics Tool
Overview
The Iceberg Table Analysis CLI Tool evaluates Iceberg tables to identify how Upsolver optimizations can enhance efficiency.
It presents a side-by-side comparison of current metrics against potential improvements in scan durations, file counts, and file sizes, providing a straightforward assessment of optimization opportunities.
Installation
iceberg-diag
can be installed using either Brew or PIP, as detailed below:
Using PIP
Prerequisites
- Python 3.8 or higher: Verify Python's installation:
python3 --version
To install iceberg-diag
using PIP, ensure you have the latest version of pip
:
pip install --upgrade pip
Then, install the package with pip
pip install iceberg-diag
Using Brew
Execute the following commands to install iceberg-diag
via Brew:
brew tap upsolver/iceberg-diag
brew install iceberg-diag
Usage Instructions
iceberg-diag [options]
Command-Line Options
-h
,--help
: Display the help message and exit.--profile PROFILE
: Set the AWS credentials profile for the session, defaults to the environment's current settings.--region REGION
: Set the AWS region for operations, defaults to the specified profile's default region.--database DATABASE
: Set the database name, will list all available iceberg tables if no--table-name
provided.--table-name TABLE_NAME
: Enter the table name or a glob pattern (e.g.,'*'
,'tbl_*'
).--remote
: Enable remote diagnostics by sending data to the Upsolver API for processing.
Provides more detailed analytics and includes information about file size reducations.-v, --verbose
: Enable verbose logging
Usage
-
Displaying help information:
iceberg-diag --help
-
Listing all available databases in profile:
iceberg-diag --profile <profile>
-
Listing all available iceberg tables in a given database:
iceberg-diag --profile <profile> --database <database>
-
Running diagnostics on a specific table in a specific AWS profile and region (completely locally):
iceberg-diag --profile <profile> --region <region> --database <database> --table-name '*'
-
Running diagnostics using
remote
optioniceberg-diag --profile <profile> --database <database> --table-name 'prod_*' --remote
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for iceberg_diag-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bfe67053d420af17fd3e0cd20738ec8488a9abbc3153c72c3a08b7dce653d0c |
|
MD5 | d201ec552f8fb28d04d1079f89666dae |
|
BLAKE2b-256 | 2d207307831b2bb6fcec1fce4fc5305d4c3f7b9f2ea7113216ee9ebf6c61b605 |