Dremio CLI

A comprehensive command-line interface for Dremio Cloud and Dremio Software.

🚀 Features

• 100% API Coverage - Complete support for all Dremio APIs
• Dual Platform Support - Works with both Dremio Cloud and Software
• Profile Management - Easily switch between environments
• Rich Output - Table, JSON, and YAML formatting
• Comprehensive Documentation - Detailed guides for every feature

📦 Installation

pip install alt-dremio-cli

⚡ Quick Start

# Configure a profile
alt-dremio-cli profile create --name myprofile --type software \
  --base-url https://dremio.company.com \
  --username admin --password secret

# List catalog
alt-dremio-cli catalog list

# Execute SQL
alt-dremio-cli sql execute "SELECT * FROM customers LIMIT 10"

# Create a view
alt-dremio-cli view create --path "Analytics.summary" \
  --sql "SELECT * FROM customers WHERE region = 'US'"

📚 Documentation

Complete Documentation (GitHub) →

(Use the link above if browsing on PyPI)

Core Guides

• Installation - Setup and configuration
• Profiles - Manage connection profiles
• Catalog - Browse and navigate data
• SQL - Execute queries and analyze plans
• Jobs - Monitor query execution

Data Management

• Sources - Connect to data systems
• Views - Create virtual datasets
• Tables - Manage physical datasets
• Spaces & Folders - Organize your catalog

Governance & Security

• Tags & Wiki - Document and categorize
• Grants - Access control and permissions
• Users - User management
• Roles - Role-based access control
• Reflections - Manage reflections
• Scripts - Manage scripts (Cloud only)

Dremio-as-Code (GitOps)

• Overview - Getting Started with DAC
• Sources - Manage Sources
• Tables - Manage Physical Tables
• Validations - Data Quality Checks
• Reflections - Manage Reflections
• Governance - Managing Access Control

Productivity

• Favorites - Save frequently used queries
• History - View and re-run commands
• REPL - Interactive SQL Shell (Enhanced)
• Monitor - Real-time System Monitor
• Catalog Explorer - Interactive Catalog TUI
• Init - Interactive Configuration Wizard
• Completion - Shell Completion Scripts
• Lineage - Visualize dataset dependencies

🎯 Key Features

Catalog Operations

Browse and navigate your Dremio catalog with ease.

alt-dremio-cli catalog list
alt-dremio-cli catalog get <id>
alt-dremio-cli catalog get-by-path "MySpace.MyFolder.MyView"

SQL Execution

Execute queries, explain plans, and validate syntax.

alt-dremio-cli sql execute "SELECT * FROM table"
alt-dremio-cli sql execute --file query.sql --async
alt-dremio-cli sql explain "SELECT * FROM table"
alt-dremio-cli sql validate "SELECT * FROM table"

Source Management

Connect to and manage data sources.

alt-dremio-cli source list
alt-dremio-cli source create --name MyDB --type POSTGRES --config-file db.json
alt-dremio-cli source refresh <id>

View Management

Create and manage virtual datasets.

alt-dremio-cli view create --path "Analytics.summary" --sql "SELECT * FROM data"
alt-dremio-cli view update <id> --sql "SELECT * FROM updated_data"
alt-dremio-cli view list --space Analytics

Job Management

Monitor and manage query jobs.

alt-dremio-cli job list
alt-dremio-cli job get <id>
alt-dremio-cli job results <id> --output-file results.json
alt-dremio-cli job profile <id> --download profile.zip

Access Control

Manage permissions and grants.

alt-dremio-cli grant list <catalog-id>
alt-dremio-cli grant add <id> --grantee-type ROLE --grantee-id analyst --privileges SELECT
alt-dremio-cli user list
alt-dremio-cli role list

🔧 Configuration

Profile-Based Configuration

# Create profile
alt-dremio-cli profile create --name prod --type cloud \
  --base-url https://api.dremio.cloud \
  --project-id <project-id> \
  --token <pat-token>

# Use profile
alt-dremio-cli --profile prod catalog list

# Set default profile
alt-dremio-cli profile set-default prod

Environment Variables

# Set in .env file
DREMIO_BASE_URL=https://dremio.company.com
DREMIO_USERNAME=admin
DREMIO_PASSWORD=secret

📊 Output Formats

# Table format (default)
alt-dremio-cli catalog list

# JSON format
alt-dremio-cli --output json catalog list

# YAML format
alt-dremio-cli --output yaml catalog list

🌐 Platform Support

Feature	Software	Cloud
Catalog Operations	✅	✅
SQL Execution	✅	⚠️ Limited
Job Management	✅	✅
View Management	✅	✅
Source Management	✅	✅
Grant Management	✅	✅
User/Role Management	✅	⚠️ Via Console

💻 Development

# Clone repository
git clone https://github.com/developer-advocacy-dremio/dremio-python-cli.git
cd dremio-python-cli/dremio-cli

# Install in development mode
pip install -e .

# Run tests
pytest

# Run live tests
python scripts/test_sql_operations.py

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🔗 Links

• Documentation
• Dremio Documentation
• Dremio Cloud
• Dremio Software

🆘 Support

For issues and questions:

• GitHub Issues: Report an issue
• Documentation: Read the docs
• Community: Dremio Community