HANA CLI

Appearance

Commands Overview ​

All available commands organized by category. 155 total commands available - see the Complete Command Reference for the full list.

📊 Analysis Tools ​

Tools for data analysis, profiling, and quality checks.

All commands: Calc View Analyzer, Column Stats, Data Diff, Data Lineage, Data Profile, Duplicate Detection, ERD Diagram, Fragmentation Check, Referential Check, Table Hotspots.

🗄️ Data Tools ​

Commands for data migration, synchronization, and transformation.

  • Import - Import CSV/Excel datasets into target tables
  • Export - Export table data to CSV, Excel, or JSON
  • Compare Data - Compare row-level data across sources
  • Data Sync - Synchronize data between source and target systems
  • Data Validator - Validate data quality and integrity constraints
  • Kafka Connect - Stream records using Kafka integration workflows

All commands: Compare Data, Data Sync, Data Validator, Export, Import, Kafka Connect.

🏗️ Schema Tools ​

Tools for schema management and database structure operations.

All commands: Compare Schema, Schema Clone, Table Copy.

🔍 Object Inspection ​

Commands for inspecting database objects and metadata.

All commands: Functions, Indexes, Inspect Function, Inspect Lib Member, Inspect Library, Inspect Procedure, Inspect Table, Inspect Trigger, Inspect View, Libraries, Objects, Partitions, Procedures, Schemas, Sequences, Tables, Tables PG, Tables SQLite, Triggers, Views.

🧰 Mass Operations ​

Bulk operations across schemas and objects.

All commands: Mass Convert, Mass Delete, Mass Export, Mass Grant, Mass Rename, Mass Update, Mass Users.

📈 Performance Monitoring ​

Monitoring, diagnostics, and performance tuning commands.

All commands: Alerts, Blocking, Cache Stats, Deadlocks, Expensive Statements, Long Running, Memory Analysis, Memory Leaks, Query Plan, Trace Contents, Traces, Workload Management.

💾 Backup & Recovery ​

Backup, restore, and retention workflows.

All commands: Backup, Backup List, Backup Status, Reclaim, Restore.

🔐 Security ​

Security auditing, policies, and privilege analysis.

All commands: Audit Log, Certificates, Create XSA Admin, Encryption Status, Grant Chains, Privilege Analysis, Privilege Error, Pwd Policy, Roles, Security Scan.

🔑 Connection & Auth ​

Connection management and authentication utilities.

All commands: Connect, Connect via Service Key, Connections, Create JWT, Inspect JWT, Inspect User, Users.

🧩 HDI Management ​

HDI container lifecycle and group management.

All commands: Activate HDI, Admin HDI, Admin HDI Group, Containers, Create Container, Create Container Users, Create Group, Drop Container, Drop Group, HANA Cloud HDI Instances.

☁️ HANA Cloud ​

HANA Cloud instance operations and lifecycle control.

All commands: HANA Cloud Instances, HANA Cloud SBSS Instances, HANA Cloud Schema Instances, HANA Cloud Secure Store Instances, HANA Cloud Start, HANA Cloud Stop, HANA Cloud UPS Instances.

🧭 BTP Integration ​

BTP targeting and convenience openers.

All commands: BTP, BTP Info, BTP Subs, BTP Target, Open BAS, Open DB Explorer.

🛠️ Developer Tools ​

Commands for development and testing.

  • Help Docu - Open CLI help documentation in your browser
  • Open Read Me - Open README documentation in your browser
  • Open Change Log - Open changelog documentation in your browser
  • CDS - Run CDS-related helper operations
  • Generate Docs - Generate and refresh project documentation

All commands: Call Procedure, CDS, Change Log, Code Template, Create Module, Generate Docs, HDBSQL, Help Docu, Issue, Open Change Log, Open Read Me, Query Simple, Read Me.

🧪 System Admin ​

Administrative diagnostics and system configuration checks.

All commands: Cache Contents, Crash Dumps, Data Types, Dependencies, Diagnose, Disks, Feature Usage, Features, Health Check, Host Information, INI Contents, INI Files, Ports, Recommendations, Status, System Info.

⚙️ System Tools ​

Administrative and system-level commands.

All commands: CLI (Internal), Command Map (Internal), Compare Schema (Legacy Alias), Copy2 Default Env, Copy2 Env, Copy2 Secrets, Data Mask, Data Volumes, Export (Legacy Alias), FT Indexes, Generate Test Data, Graph Workspaces, Import (Legacy Alias), Index Test (Legacy Placeholder), Inspect Index, Kafka Connect (Legacy Alias), RICK, Replication Status, SDI Tasks, Spatial Data, Synonyms, Table Groups, Test, Time Series Tools, Time Series Tools (Legacy Alias), UI, Version, XSA Services.

Looking for a specific command? Use the search bar above or jump directly to:

Pro Tips ​

  • Use --help flag with any command for detailed options
  • Some commands support --output for different formats (json, csv, table)
  • Use --verbose flag for detailed execution output
  • Use --debug flag for debugging information
  • Use --quiet flag to suppress output for scripting
  • Some commands support aliases for faster typing (e.g., imp for import)

Examples ​

bash
# Get help for a command
hana-cli import --help

# Use verbose output
hana-cli dataProfile -s SCHEMA -t TABLE --verbose

# Export as JSON
hana-cli export -s SCHEMA -t TABLE --output json