hana-cli
Version:
HANA Developer Command Line Interface
1,884 lines (1,261 loc) • 101 kB
Markdown
# SAP HANA CLI (hana-cli) — Complete Command Reference
> Generated from hana-cli v4.202603.2 on 2026-03-17
> This file is auto-generated. Do not edit manually.
## What is hana-cli?
**hana-cli** is a command-line tool that simplifies SAP HANA database development. It wraps complex multi-step database operations into single, easy-to-use commands. It is a development-time tool — not a replacement for `hdbsql` or production administration tools.
### Installation
```bash
npm install -g hana-cli
```
**Requirements:** Node.js ≥ 20.19.0
### Connection Setup
Before using most commands, establish a database connection:
```bash
# Interactive connection wizard
hana-cli connect
# Connect via BTP service key
hana-cli connectViaServiceKey
# Copy connection to default-env.json for CAP/CDS projects
hana-cli copy2DefaultEnv
```
Connection details are stored locally. Use `hana-cli status` to verify your connection.
### Running Commands
```bash
# Direct CLI mode
hana-cli <command> [options]
# Interactive mode (menu-driven)
hana-cli
# Get help for any command
hana-cli <command> --help
```
### Output Formats
Many commands support `--output` with values: `table`, `json`, `csv`, `excel`.
---
## Command Reference
### Analysis Tools
Analyze dependencies, privileges, calculations, and relationships
#### `calcViewAnalyzer`
**Aliases:** `cva`, `analyzeCalcView`, `calcview`
**Syntax:** `hana-cli calcViewAnalyzer [schema] [view]`
**Tags:** calc-view, analysis
**Use cases:**
- Analyze calculation views
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--view` (`-v`) | string | `"*"` | view |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--metrics` (`-m`) | boolean | `false` | metrics |
| `--limit` (`-l`) | number | `100` | limit |
| `--profile` (`-p`) | string | - | profile |
**Related:** `views`, `erdDiagram`
---
#### `dependencies`
**Aliases:** `deps`, `depend`, `dependency-graph`, `relationships`
**Syntax:** `hana-cli dependencies`
**Tags:** dependency, metadata, analysis
**Use cases:**
- Find object dependencies
- Understand impact of drops
**Related:** `objects`, `views`, `procedures`
---
#### `erdDiagram`
**Aliases:** `erd`, `er`, `schema-diagram`, `entityrelation`
**Syntax:** `hana-cli erdDiagram`
**Tags:** diagram, entity-relationship, visualization
**Use cases:**
- Generate ER diagram
- Visualize schema structure
**Related:** `calcViewAnalyzer`, `schemaClone`, `graphWorkspaces`
---
#### `grantChains`
**Aliases:** `grants`, `grantchain`
**Syntax:** `hana-cli grantChains`
**Tags:** grant, privilege, chain
**Use cases:**
- Analyze privilege grant chains
**Related:** `privilegeAnalysis`, `privilegeError`, `roles`
---
#### `graphWorkspaces`
**Aliases:** `gws`, `graphs`, `graphWorkspace`, `graphws`
**Syntax:** `hana-cli graphWorkspaces [schema] [workspace]`
**Tags:** graph, visualization
**Use cases:**
- Explore graph workspaces
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--workspace` (`-w`) | string | `"*"` | graphWorkspaceName |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--limit` (`-l`) | number | `200` | limit |
| `--profile` (`-p`) | string | - | profile |
**Related:** `erdDiagram`, `objects`
---
#### `privilegeAnalysis`
**Aliases:** `privanalysis`, `privanalyze`
**Syntax:** `hana-cli privilegeAnalysis`
**Tags:** privilege, security, analysis
**Use cases:**
- Analyze privilege distribution
- Find over-privileged users
**Related:** `roles`, `users`, `grantChains`
---
#### `privilegeError`
**Aliases:** `pe`, `privilegeerror`, `privilegerror`, `getInsuffficientPrivilegeErrorDetails`
**Syntax:** `hana-cli privilegeError [guid]`
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--guid` (`-g`, `--error`) | string | - | errorGuid |
**Related:** `grantChains`, `privilegeAnalysis`
---
#### `referentialCheck`
**Aliases:** `refcheck`, `checkReferential`, `fkcheck`
**Syntax:** `hana-cli referentialCheck`
**Tags:** referential-integrity, foreign-keys, validation
**Use cases:**
- Check foreign key integrity
- Find orphaned records
**Prerequisites:** Active database connection, Foreign key constraints defined
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table` (`-t`) | string | - | referentialCheckTable |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | referentialCheckSchema |
| `--constraints` (`-c`) | string | - | referentialCheckConstraints |
| `--mode` (`-m`) | string | `"check"` | referentialCheckMode |
| `--output` (`-o`) | string | - | referentialCheckOutput |
| `--format` (`-f`) | string | `"summary"` | referentialCheckFormat |
| `--limit` (`-l`) | number | `10000` | referentialCheckLimit |
| `--timeout` (`--to`) | number | `3600` | referentialCheckTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `tables`, `compareData`, `dataValidator`
---
### Backup & Recovery
Create backups, manage restores, and verify recovery readiness
#### `backup`
**Aliases:** `bkp`, `createBackup`
**Syntax:** `hana-cli backup [target] [name]`
**Tags:** backup, recovery
**Use cases:**
- Create backup
- Start backup process
**Prerequisites:** Active database connection, Sufficient disk space, BACKUP admin privileges
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--target` (`--tgt`) | string | - | backupTarget |
| `--name` (`-n`) | string | - | backupName |
| `--backupType` (`--type`) | string | `"table"` | backupType |
| `--format` (`-f`) | string | `"csv"` | backupFormat |
| `--destination` (`--dest`) | string | - | backupDestination |
| `--compress` (`-c`) | boolean | `true` | backupCompress |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--withData` (`--wd`) | boolean | `true` | backupWithData |
| `--overwrite` (`--ow`) | boolean | `false` | backupOverwrite |
**Related:** `backupStatus`, `backupList`, `restore`
---
#### `backupList`
**Aliases:** `blist`, `listBackups`, `backups`
**Syntax:** `hana-cli backupList [directory]`
**Tags:** backup, list, catalog
**Use cases:**
- List available backups
- View backup history
**Prerequisites:** Active database connection
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--directory` (`--dir`) | string | - | backupListDirectory |
| `--backupType` (`--type`) | string | `"all"` | backupType |
| `--sortBy` (`--sort`) | string | `"date"` | backupListSortBy |
| `--order` (`-o`) | string | `"desc"` | backupListOrder |
| `--limit` (`-l`) | number | `50` | limit |
| `--showDetails` (`--details`) | boolean | `false` | backupListShowDetails |
**Related:** `backup`, `backupStatus`, `restore`
---
#### `backupStatus`
**Aliases:** `bstatus`, `backupstate`, `bkpstatus`
**Syntax:** `hana-cli backupStatus`
**Tags:** backup, status, monitoring
**Use cases:**
- Check backup status
- Monitor backup progress
**Prerequisites:** Active database connection
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--catalogOnly` (`--co`) | boolean | `false` | backupStatusCatalogOnly |
| `--limit` (`-l`) | number | `20` | limit |
| `--backupType` (`--type`) | string | `"all"` | backupStatusType |
| `--status` (`--st`) | string | `"all"` | backupStatusState |
| `--days` | number | `7` | backupStatusDays |
**Related:** `backup`, `backupList`, `replicationStatus`
---
#### `replicationStatus`
**Aliases:** `replstatus`, `replication`, `replstat`
**Syntax:** `hana-cli replicationStatus`
**Tags:** replication, status, monitoring
**Use cases:**
- Check replication status
- Monitor data replication
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--type` (`--ty`) | string | `'system'` | replicationStatusType |
| `--serviceName` (`--sn`) | string | - | replicationStatusServiceName |
| `--detailed` (`-d`) | boolean | `false` | replicationStatusDetailed |
| `--watch` (`-w`) | boolean | `false` | replicationStatusWatch |
| `--profile` (`-p`) | string | - | profile |
**Related:** `backupStatus`, `backup`, `healthCheck`
---
#### `restore`
**Aliases:** `rst`, `restoreBackup`
**Syntax:** `hana-cli restore [backupFile]`
**Tags:** restore, recovery
**Use cases:**
- Restore from backup
- Recover database
**Prerequisites:** Active database connection, Backup file available, Database access privileges
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--backupFile` (`--bf`, `--file`) | string | - | restoreBackupFile |
| `--target` (`--tgt`) | string | - | restoreTarget |
| `--schema` (`-s`) | string | - | schema |
| `--overwrite` (`--ow`) | boolean | `false` | restoreOverwrite |
| `--dropExisting` (`--de`) | boolean | `false` | restoreDropExisting |
| `--continueOnError` (`--coe`) | boolean | `false` | restoreContinueOnError |
| `--batchSize` (`-b`, `--batch`) | number | `1000` | restoreBatchSize |
| `--dryRun` (`--dr`, `--preview`) | boolean | `false` | restoreDryRun |
**Related:** `backup`, `backupList`, `backupStatus`
---
### BTP Integration
SAP BTP integration tools and account management utilities
#### `btpInfo`
**Aliases:** `btpinfo`
**Syntax:** `hana-cli btpInfo`
**Tags:** btp, info, cloud
**Use cases:**
- Get BTP information
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--output` | string | - | output |
**Related:** `btp`, `btpTarget`, `btpSubs`
---
#### `btpInfoUI`
**Aliases:** `btpinfoUI`, `btpui`, `btpInfoui`
**Syntax:** `hana-cli btpInfoUI`
**Related:** `btpInfo`, `btp`
---
### Connection & Auth
Connection setup, authentication helpers, and configuration tools
#### `config`
**Aliases:** `cfg`
**Syntax:** `hana-cli config [action]`
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--edit` (`-e`) | boolean | `false` | edit |
| `--global` (`-g`) | boolean | `false` | global |
| `--path` (`-p`) | boolean | `false` | path |
| `--reset` | boolean | `false` | reset |
**Related:** `connect`, `connections`
---
#### `connect`
**Aliases:** `c`, `login`
**Syntax:** `hana-cli connect [user] [password]`
**Tags:** connect, connection, configuration
**Use cases:**
- Configure database connection
**Related:** `connections`, `connectViaServiceKey`, `config`
---
#### `connections`
**Aliases:** `conn`, `c`
**Syntax:** `hana-cli connections`
**Tags:** connection, configuration, management
**Use cases:**
- Manage saved connections
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--limit` (`-l`) | number | `100` | limit |
| `--user` (`-u`) | string | - | user |
| `--application` (`-a`) | string | - | applicationName |
| `--idle` (`-i`) | boolean | `false` | Include idle connections |
**Related:** `connect`, `connectViaServiceKey`, `status`
---
#### `connectViaServiceKey`
**Aliases:** `key`, `servicekey`, `service-key`
**Syntax:** `hana-cli serviceKey [instance] [key]`
**Tags:** connect, service-key, configuration
**Use cases:**
- Connect using service key
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--instance` | string | - | instance |
| `--key` | string | - | key |
| `--encrypt` | boolean | `true` | encrypt |
| `--validate` | boolean | `false` | validate |
| `--cf` | boolean | `true` | cf |
| `--save` | boolean | - | save |
**Related:** `connect`, `connections`, `config`
---
#### `copy2DefaultEnv`
**Aliases:** `copyDefaultEnv`, `copyDefault-Env`, `copy2defaultenv`, `copydefaultenv`, `copydefault-env`
**Syntax:** `hana-cli copy2DefaultEnv`
**Tags:** configuration, environment
**Use cases:**
- Copy settings to default environment
**Related:** `connect`, `config`, `copy2Env`
---
#### `copy2Env`
**Aliases:** `copyEnv`, `copyenv`, `copy2env`
**Syntax:** `hana-cli copy2Env`
**Tags:** configuration, environment
**Use cases:**
- Copy settings to environment file
**Related:** `connect`, `config`, `copy2Secrets`
---
#### `copy2Secrets`
**Aliases:** `secrets`, `make:secrets`
**Syntax:** `hana-cli copy2Secrets`
**Tags:** configuration, secrets
**Use cases:**
- Copy settings to secrets file
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--envJson` (`--from-file`) | string | `"default-env.json"` | envJson |
| `--secretsFolder` (`--to-folder`) | string | `"secrets"` | secretsFolder |
| `--filter` | string | - | secretsFilter |
**Related:** `connect`, `copy2Env`
---
#### `createJWT`
**Aliases:** `cJWT`, `cjwt`, `cJwt`
**Syntax:** `hana-cli createJWT [name]`
**Tags:** jwt, token, authentication
**Use cases:**
- Create JWT token
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--name` (`-c`) | string | - | jwtName |
| `--certificate` (`--cert`) | string | - | certificate |
| `--issuer` (`-i`) | string | - | issuer |
**Related:** `inspectJWT`, `connectViaServiceKey`
---
### Data Tools
Import, export, compare, validate, and manage data across systems
#### `compareData`
**Aliases:** `cmpdata`, `compardata`, `dataCompare`
**Syntax:** `hana-cli compareData`
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--sourceTable` (`--st`) | string | - | compareDataSourceTable |
| `--sourceSchema` (`--ss`) | string | `'**CURRENT_SCHEMA**'` | compareDataSourceSchema |
| `--targetTable` (`--tt`) | string | - | compareDataTargetTable |
| `--targetSchema` (`--ts`) | string | `'**CURRENT_SCHEMA**'` | compareDataTargetSchema |
| `--keyColumns` (`-k`) | string | - | compareDataKeyColumns |
| `--output` (`-o`) | string | - | compareDataOutput |
| `--columns` (`-c`) | string | - | compareDataColumns |
| `--showMatches` (`--sm`) | boolean | `false` | compareDataShowMatches |
| `--limit` (`-l`) | number | `1000` | compareDataLimit |
| `--timeout` (`--to`) | number | `3600` | compareDataTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `compareSchema`, `dataDiff`
---
#### `compareSchema`
**Aliases:** `cmpschema`, `schemaCompare`, `compareschema`
**Syntax:** `hana-cli compareSchema`
**Tags:** compare, diff, analysis
**Use cases:**
- Compare two schemas
- Find schema differences
**Prerequisites:** Active database connection, Both schemas exist
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--sourceSchema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | compareSchemaSourceSchema |
| `--targetSchema` (`-t`) | string | `'**CURRENT_SCHEMA**'` | compareSchemaTargetSchema |
| `--tables` (`--tb`) | string | - | compareSchemaTableFilter |
| `--compareIndexes` (`--ci`) | boolean | `true` | compareSchemaCompareIndexes |
| `--compareTriggers` (`--ct`) | boolean | `true` | compareSchemaCompareTriggers |
| `--compareConstraints` (`--cc`) | boolean | `true` | compareSchemaCompareConstraints |
| `--output` (`-o`) | string | - | compareSchemaOutput |
| `--timeout` (`--to`) | number | `3600` | compareSchemaTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `compareData`, `schemaClone`
---
#### `dataDiff`
**Aliases:** `ddiff`, `diffData`, `dataCompare`
**Syntax:** `hana-cli dataDiff`
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table1` (`--t1`) | string | - | dataDiffTable1 |
| `--table2` (`--t2`) | string | - | dataDiffTable2 |
| `--schema1` (`--s1`) | string | `'**CURRENT_SCHEMA**'` | dataDiffSchema1 |
| `--schema2` (`--s2`) | string | `'**CURRENT_SCHEMA**'` | dataDiffSchema2 |
| `--keyColumns` (`-k`) | string | - | dataDiffKeyColumns |
| `--compareColumns` (`-c`) | string | - | dataDiffCompareColumns |
| `--output` (`-o`) | string | - | dataDiffOutput |
| `--format` (`-f`) | string | `"summary"` | dataDiffFormat |
| `--limit` (`-l`) | number | `10000` | dataDiffLimit |
| `--showValues` (`--sv`) | boolean | `false` | dataDiffShowValues |
| `--dryRun` (`--dr`, `--preview`) | boolean | `false` | dryRun |
| `--timeout` (`--to`) | number | `3600` | dataDiffTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `compareData`, `dataValidator`
---
#### `dataLineage`
**Aliases:** `lineage`, `dataFlow`, `traceLineage`
**Syntax:** `hana-cli dataLineage`
**Related:** `dataProfile`, `compareData`
---
#### `dataMask`
**Aliases:** `mask`, `dataprivacy`, `anonymize`, `pii`
**Syntax:** `hana-cli dataMask`
**Tags:** masking, anonymization, privacy
**Use cases:**
- Mask sensitive data
- Anonymize personal information
**Related:** `dataValidator`, `import`
---
#### `dataProfile`
**Aliases:** `prof`, `profileData`, `dataStats`
**Syntax:** `hana-cli dataProfile`
**Tags:** profiling, statistics, data-analysis
**Use cases:**
- Profile table data
- Analyze column distributions
- Identify data patterns
**Prerequisites:** Active database connection, Target table exists
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table` (`-t`) | string | - | dataProfileTable |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | dataProfileSchema |
| `--columns` (`-c`) | string | - | dataProfileColumns |
| `--output` (`-o`) | string | - | dataProfileOutput |
| `--format` (`-f`) | string | `"summary"` | dataProfileFormat |
| `--nullAnalysis` (`--na`) | boolean | `true` | dataProfileNullAnalysis |
| `--cardinalityAnalysis` (`--ca`) | boolean | `true` | dataProfileCardinalityAnalysis |
| `--statisticalAnalysis` (`--sa`) | boolean | `true` | dataProfileStatisticalAnalysis |
| `--patternAnalysis` (`--pa`) | boolean | `false` | dataProfilePatternAnalysis |
| `--sampleSize` (`--ss`) | number | `10000` | dataProfileSampleSize |
| `--timeout` (`--to`) | number | `3600` | dataProfileTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `dataValidator`, `duplicateDetection`
---
#### `dataSync`
**Aliases:** `datasync`, `syncData`, `sync`
**Syntax:** `hana-cli dataSync`
**Tags:** sync, synchronization, replication
**Use cases:**
- Synchronize data between tables
- Replicate data
**Prerequisites:** Active database connection, Source and target tables exist
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--sourceConnection` (`--sc`) | string | - | dataSyncSourceConnection |
| `--targetConnection` (`--tc`) | string | - | dataSyncTargetConnection |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | dataSyncSchema |
| `--table` (`-t`) | string | - | dataSyncTable |
| `--syncMode` (`-m`) | string | `'full'` | dataSyncMode |
| `--batchSize` (`-b`) | number | `1000` | dataSyncBatchSize |
| `--conflictResolution` (`--cr`) | string | `'source'` | dataSyncConflictResolution |
| `--keyColumns` (`-k`) | string | - | dataSyncKeyColumns |
| `--timeout` (`--to`) | number | `3600` | dataSyncTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `import`, `export`
---
#### `dataValidator`
**Aliases:** `dval`, `validateData`, `dataValidation`
**Syntax:** `hana-cli dataValidator`
**Tags:** validation, quality, rules, checking
**Use cases:**
- Validate data against rules
- Check data quality
- Find invalid records
**Prerequisites:** Active database connection, Target table exists, Validation rules defined
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table` (`-t`) | string | - | dataValidatorTable |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | dataValidatorSchema |
| `--rules` (`-r`) | string | - | dataValidatorRules |
| `--rulesFile` (`--rf`) | string | - | dataValidatorRulesFile |
| `--columns` (`-c`) | string | - | dataValidatorColumns |
| `--output` (`-o`) | string | - | dataValidatorOutput |
| `--format` (`-f`) | string | `"json"` | dataValidatorFormat |
| `--limit` (`-l`) | number | `10000` | dataValidatorLimit |
| `--stopOnFirstError` (`--sfe`) | boolean | `false` | dataValidatorStopOnFirstError |
| `--timeout` (`--to`) | number | `3600` | dataValidatorTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `import`, `dataProfile`
---
#### `duplicateDetection`
**Aliases:** `dupdetect`, `findDuplicates`, `duplicates`
**Syntax:** `hana-cli duplicateDetection`
**Tags:** duplicates, quality, anomaly
**Use cases:**
- Find duplicate records
- Identify data redundancy
**Prerequisites:** Active database connection, Target table exists
**Related:** `dataProfile`, `dataValidator`
---
#### `export`
**Aliases:** `exp`, `downloadData`, `downloaddata`
**Syntax:** `hana-cli export`
**Tags:** export, download, extract, csv, excel
**Use cases:**
- Extract table data to file
- Download data
**Prerequisites:** Active database connection, Source table exists
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table` (`-t`) | string | - | exportTable |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | exportSchema |
| `--output` (`-o`) | string | - | exportOutput |
| `--format` (`-f`) | string | `"csv"` | exportFormat |
| `--where` (`-w`) | string | - | exportWhere |
| `--limit` (`-l`) | number | - | exportLimit |
| `--orderby` (`--ob`) | string | - | exportOrderBy |
| `--columns` (`-c`) | string | - | exportColumns |
| `--delimiter` (`-d`) | string | `'` | exportDelimiter |
| `--includeHeaders` (`--ih`) | boolean | `true` | exportIncludeHeaders |
| `--nullValue` (`--nv`) | string | `''` | exportNullValue |
| `--maxRows` (`--mr`) | number | `1000000` | exportMaxRows |
| `--timeout` (`--to`) | number | `3600` | exportTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `import`, `massExport`
---
#### `import`
**Aliases:** `imp`, `uploadData`, `uploaddata`
**Syntax:** `hana-cli import`
**Tags:** import, upload, load-data, csv, excel
**Use cases:**
- Load data from CSV/Excel
- Upload data to table
**Prerequisites:** Active database connection, Target table exists with compatible structure, CSV or Excel file available
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--filename` (`-n`) | string | - | importFilename |
| `--table` (`-t`) | string | - | importTable |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | importSchema |
| `--output` (`-o`) | string | `"csv"` | importOutputFormat |
| `--matchMode` (`-m`) | string | `"auto"` | importMatchMode |
| `--truncate` (`--tr`) | boolean | `false` | importTruncate |
| `--batchSize` (`-b`) | number | `1000` | importBatchSize |
| `--worksheet` (`-w`) | number | `1` | importWorksheet |
| `--startRow` (`--sr`) | number | `1` | importStartRow |
| `--skipEmptyRows` (`--se`) | boolean | `true` | importSkipEmptyRows |
| `--excelCacheMode` (`--ec`) | string | `"cache"` | importExcelCacheMode |
| `--dryRun` (`--dr`) | boolean | `false` | Preview import results without committing to database |
| `--maxFileSizeMB` (`--mfs`) | number | `500` | Maximum file size in MB (prevents memory exhaustion) |
| `--timeoutSeconds` (`--ts`) | number | `3600` | Import operation timeout in seconds (0 = no timeout) |
| `--nullValues` (`--nv`) | string | `'null` | Comma-separated list of values to treat as NULL |
| `--skipWithErrors` (`--swe`) | boolean | `false` | Continue import even if errors exceed threshold (logs errors) |
| `--maxErrorsAllowed` (`--mea`) | number | `-1` | Maximum errors allowed before stopping (-1 = unlimited) |
| `--profile` (`-p`) | string | - | profile |
**Related:** `export`, `dataValidator`
---
#### `importUI`
**Aliases:** `impui`, `importui`, `uploadui`, `uploadUI`
**Syntax:** `hana-cli importUI [filename] [table]`
**Related:** `import`
---
#### `kafkaConnect`
**Aliases:** `kafka`, `kafkaAdapter`, `kafkasub`
**Syntax:** `hana-cli kafkaConnect [action]`
**Tags:** kafka, streaming, integration
**Use cases:**
- Manage Kafka connections
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--action` (`-a`) | string | `'list'` | action |
| `--name` (`-n`) | string | - | connectorName |
| `--brokers` (`-b`) | string | - | kafkaBrokers |
| `--topic` (`-t`) | string | - | kafkaTopic |
| `--config` (`-c`) | string | - | configPath |
**Related:** `dataSync`, `import`
---
### Developer Tools
Developer utilities, templates, docs, and interactive helpers
#### `callProcedure`
**Aliases:** `cp`, `callprocedure`, `callProc`, `callproc`, `callSP`, `callsp`
**Syntax:** `hana-cli callProcedure [schema] [procedure]`
**Tags:** procedure, execution, call
**Use cases:**
- Call stored procedure
- Execute procedure
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--procedure` (`-p`, `--sp`) | string | - | procedure |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--profile` (`-p`) | string | - | profile |
**Related:** `inspectProcedure`, `procedures`
---
#### `cds`
**Aliases:** `cdsPreview`
**Syntax:** `hana-cli cds [schema] [table]`
**Tags:** cds, cap, data-model
**Use cases:**
- Work with CDS models
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table` (`-t`) | string | - | table |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--view` (`-v`) | boolean | `false` | viewOpt |
| `--useHanaTypes` (`--hana`) | boolean | `false` | useHanaTypes |
| `--useQuoted` (`-q`, `--quoted`) | boolean | `false` | useQuoted |
| `--port` (`-p`) | number | `false` | port |
| `--profile` (`--pr`) | string | - | profile |
**Related:** `activateHDI`, `generateDocs`, `codeTemplate`
---
#### `codeTemplate`
**Aliases:** `template`, `codegen`, `scaffold`, `boilerplate`
**Syntax:** `hana-cli codeTemplate`
**Tags:** template, code-generation
**Use cases:**
- Generate code templates
**Related:** `createModule`, `generateTestData`
---
#### `createModule`
**Aliases:** `createDB`, `createDBModule`
**Syntax:** `hana-cli createModule`
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--folder` | string | - | folder |
| `--hanaCloud` | boolean | `true` | hanaCloud |
**Related:** `generateTestData`, `codeTemplate`
---
#### `examples`
**Aliases:** `example`
**Syntax:** `hana-cli examples [command] [query...]`
**Related:** `viewDocs`, `interactive`, `kb`
---
#### `generateDocs`
**Aliases:** `docs`, `gendocs`, `generateDocumentation`
**Syntax:** `hana-cli generateDocs`
**Tags:** documentation, generate, docs
**Use cases:**
- Generate documentation
- Create docs from schema
**Related:** `viewDocs`, `helpDocu`, `readMe`
---
#### `generateTestData`
**Aliases:** `testdata`, `gendata`, `generateData`
**Syntax:** `hana-cli generateTestData`
**Tags:** test-data, generate, sample
**Use cases:**
- Generate test data
- Create sample records
**Related:** `codeTemplate`, `import`, `dataProfile`
---
#### `hdbsql`
**Syntax:** `hana-cli hdbsql`
**Tags:** sql, query, execution
**Use cases:**
- Execute SQL directly
**Related:** `querySimple`, `callProcedure`
---
#### `helpDocu`
**Aliases:** `openDocu`, `openDocumentation`, `documentation`, `docu`
**Syntax:** `hana-cli helpDocu`
**Related:** `viewDocs`, `kb`, `readMe`
---
#### `interactive`
**Aliases:** `i`, `repl`, `shell`
**Syntax:** `hana-cli interactive`
**Related:** `helpDocu`, `examples`, `kb`
---
#### `issue`
**Aliases:** `Issue`, `openIssue`, `openissue`, `reportIssue`, `reportissue`
**Syntax:** `hana-cli issue`
**Tags:** issue, report, help
**Use cases:**
- Report issues or get help
**Related:** `diagnose`, `helpDocu`
---
#### `kb`
**Syntax:** `hana-cli kb [query...]`
**Related:** `viewDocs`, `helpDocu`, `examples`
---
#### `readMe`
**Aliases:** `readme`
**Syntax:** `hana-cli readMe`
**Tags:** readme, documentation
**Use cases:**
- View help documentation
**Related:** `readMeUI`, `helpDocu`, `openReadMe`
---
#### `readMeUI`
**Aliases:** `readmeui`, `readMeUi`, `readmeUI`
**Syntax:** `hana-cli readMeUI`
**Related:** `readMe`, `UI`, `openReadMe`
---
#### `sdiTasks`
**Aliases:** `sditasks`, `sdi`, `smartDataIntegration`
**Syntax:** `hana-cli sdiTasks`
**Tags:** sdi, task, data-provisioning
**Use cases:**
- Manage SDI tasks
- Monitor data provisioning
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--action` (`-a`) | string | `'list'` | sdiTasksAction |
| `--taskName` (`--tn`) | string | - | sdiTasksTaskName |
| `--flowgraph` (`--fg`) | string | - | sdiTasksFlowgraph |
| `--agentName` (`--an`) | string | - | sdiTasksAgentName |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | sdiTasksSchema |
| `--profile` (`-p`) | string | - | profile |
**Related:** `dataSync`, `connections`
---
#### `test`
**Syntax:** `hana-cli test`
**Related:** `cds`, `activateHDI`
---
#### `timeSeriesTools`
**Aliases:** `tsTools`, `timeseries`, `timeseriestools`
**Syntax:** `hana-cli timeSeriesTools [action]`
**Tags:** time-series, temporal
**Use cases:**
- Work with time series data
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--action` (`-a`, `--Action`) | string | `'list'` | action |
| `--table` (`-t`, `--Table`) | string | - | table |
| `--schema` (`-s`, `--Schema`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--timeColumn` (`--tc`, `--TimeColumn`) | string | - | timeColumn |
| `--valueColumn` (`--vc`, `--ValueColumn`) | string | - | valueColumn |
| `--interval` (`-i`, `--Interval`) | string | `'HOUR'` | timeInterval |
| `--limit` (`-l`, `--Limit`) | number | `1000` | limit |
**Related:** `tables`, `dataProfile`
---
#### `UI`
**Aliases:** `ui`, `gui`, `GUI`, `launchpad`, `LaunchPad`, `launchPad`, `server`
**Syntax:** `hana-cli UI`
**Related:** `readMeUI`, `helpDocu`
---
#### `viewDocs`
**Aliases:** `docs`, `doc`, `documentation`
**Syntax:** `hana-cli viewDocs [topic]`
**Related:** `helpDocu`, `kb`, `examples`
---
### HANA Cloud
Manage SAP HANA Cloud instances and related services
#### `hanaCloudHDIInstances`
**Aliases:** `hdiInstances`, `hdiinstances`, `hdiServices`, `listhdi`, `hdiservices`, `hdis`
**Syntax:** `hana-cli hdi`
**Tags:** cloud, hdi, instance
**Use cases:**
- List HANA Cloud HDI instances
**Related:** `hanaCloudInstances`, `adminHDI`
---
#### `hanaCloudHDIInstancesUI`
**Aliases:** `hdiInstancesUI`, `hdiinstancesui`, `hdiServicesUI`, `listhdiui`, `hdiservicesui`, `hdisui`
**Syntax:** `hana-cli hdiUI`
**Related:** `hanaCloudHDIInstances`
---
#### `hanaCloudInstances`
**Aliases:** `hcInstances`, `instances`, `listHC`, `listhc`, `hcinstances`
**Syntax:** `hana-cli hc [name]`
**Tags:** cloud, instance, management
**Use cases:**
- List HANA Cloud instances
- View cloud databases
**Related:** `hanaCloudStart`, `hanaCloudStop`, `hanaCloudHDIInstances`
---
#### `hanaCloudSBSSInstances`
**Aliases:** `sbssInstances`, `sbssinstances`, `sbssServices`, `listsbss`, `sbssservices`, `sbsss`
**Syntax:** `hana-cli sbss`
**Tags:** cloud, sbss, instance
**Use cases:**
- List HANA Cloud SBSS instances
**Related:** `hanaCloudInstances`
---
#### `hanaCloudSBSSInstancesUI`
**Aliases:** `sbssInstancesUI`, `sbssinstancesui`, `sbssServicesUI`, `listsbssui`, `sbssservicesui`, `sbsssui`
**Syntax:** `hana-cli sbssUI`
**Related:** `hanaCloudSBSSInstances`
---
#### `hanaCloudSchemaInstances`
**Aliases:** `schemainstances`, `schemaServices`, `listschemas`, `schemaservices`
**Syntax:** `hana-cli schemaInstances`
**Tags:** cloud, schema, instance
**Use cases:**
- List HANA Cloud schema instances
**Related:** `hanaCloudInstances`, `schemas`
---
#### `hanaCloudSchemaInstancesUI`
**Aliases:** `schemainstancesui`, `schemaServicesUI`, `listschemasui`, `schemaservicesui`
**Syntax:** `hana-cli schemaInstancesUI`
**Related:** `hanaCloudSchemaInstances`
---
#### `hanaCloudSecureStoreInstances`
**Aliases:** `secureStoreInstances`, `securestoreinstances`, `secureStoreServices`, `listSecureStore`, `securestoreservices`, `securestores`
**Syntax:** `hana-cli securestore`
**Tags:** cloud, secure-store, instance
**Use cases:**
- List HANA Cloud Secure Store instances
**Related:** `hanaCloudInstances`, `certificates`
---
#### `hanaCloudSecureStoreInstancesUI`
**Aliases:** `secureStoreInstancesUI`, `secureStoreUI`, `securestoreinstancesui`, `secureStoreServicesUI`, `listSecureStoreUI`, `securestoreservicesui`, `securestoresui`
**Syntax:** `hana-cli securestoreUI`
**Related:** `hanaCloudSecureStoreInstances`
---
#### `hanaCloudStart`
**Aliases:** `hcstart`, `hc_start`, `start`
**Syntax:** `hana-cli hcStart [name]`
**Tags:** cloud, start, instance
**Use cases:**
- Start HANA Cloud instance
**Related:** `hanaCloudStop`, `hanaCloudInstances`
---
#### `hanaCloudStop`
**Aliases:** `hcstop`, `hc_stop`, `stop`
**Syntax:** `hana-cli hcStop [name]`
**Tags:** cloud, stop, instance
**Use cases:**
- Stop HANA Cloud instance
**Related:** `hanaCloudStart`, `hanaCloudInstances`
---
#### `hanaCloudUPSInstances`
**Aliases:** `upsInstances`, `upsinstances`, `upServices`, `listups`, `upsservices`
**Syntax:** `hana-cli ups`
**Tags:** cloud, ups, instance
**Use cases:**
- List HANA Cloud UPS instances
**Related:** `hanaCloudInstances`
---
#### `hanaCloudUPSInstancesUI`
**Aliases:** `upsInstancesUI`, `upsinstancesui`, `upServicesUI`, `listupsui`, `upsservicesui`
**Syntax:** `hana-cli upsUI`
**Related:** `hanaCloudUPSInstances`
---
### HDI Management
Manage HDI containers, groups, and deployment operations
#### `activateHDI`
**Aliases:** `ahdi`, `ah`
**Syntax:** `hana-cli activateHDI [tenant]`
**Tags:** hdi, deployment, activation
**Use cases:**
- Activate HDI deployment
- Deploy HDI changes
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--tenant` (`-t`) | string | - | tenant |
**Related:** `adminHDI`, `adminHDIGroup`, `cds`
---
#### `adminHDI`
**Aliases:** `adHDI`, `adhdi`
**Syntax:** `hana-cli adminHDI [user] [password]`
**Tags:** hdi, administration, management
**Use cases:**
- Administer HDI
- Manage HDI settings
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--user` (`-u`) | string | - | user |
| `--password` (`-p`) | string | - | password |
| `--create` (`-c`) | boolean | `true` | createUser |
**Related:** `adminHDIGroup`, `hanaCloudHDIInstances`
---
#### `adminHDIGroup`
**Aliases:** `adHDIG`, `adhdig`
**Syntax:** `hana-cli adminHDIGroup [user] [group]`
**Tags:** hdi, group, administration
**Use cases:**
- Manage HDI groups
- Administer HDI group
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--user` (`-u`, `--User`) | string | - | user |
| `--group` (`-g`) | string | `'SYS_XS_HANA_BROKER'` | group |
**Related:** `adminHDI`, `activateHDI`
---
#### `containers`
**Aliases:** `cont`, `listContainers`, `listcontainers`
**Syntax:** `hana-cli containers [containerGroup] [container]`
**Tags:** container, hdi, deployment
**Use cases:**
- List HDI containers
- Manage containers
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--container` (`-c`) | string | `"*"` | container |
| `--containerGroup` (`-g`, `--group`, `--containergroup`) | string | `'*'` | containerGroup |
| `--limit` (`-l`) | number | `200` | limit |
**Related:** `createContainer`, `dropContainer`, `containersUI`
---
#### `containersUI`
**Aliases:** `containersui`, `contUI`, `listContainersUI`, `listcontainersui`
**Syntax:** `hana-cli containersUI [containerGroup] [container]`
**Related:** `containers`
---
#### `createContainer`
**Aliases:** `cc`, `cCont`
**Syntax:** `hana-cli createContainer [container] [group]`
**Tags:** container, create, hdi
**Use cases:**
- Create new HDI container
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--container` (`-c`) | string | - | container |
| `--group` (`-g`) | string | `''` | group |
| `--save` (`-s`) | boolean | `true` | saveHDI |
| `--encrypt` (`-e`, `--ssl`) | boolean | `false` | encrypt |
**Related:** `dropContainer`, `containers`, `createContainerUsers`
---
#### `createContainerUsers`
**Aliases:** `ccu`, `cContU`
**Syntax:** `hana-cli createContainerUsers [container]`
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--container` (`-c`) | string | - | container |
| `--save` (`-s`) | boolean | `true` | saveHDI |
| `--encrypt` (`-e`, `--ssl`) | boolean | `false` | encrypt |
**Related:** `createContainer`, `users`
---
#### `dropContainer`
**Aliases:** `dc`, `dropC`
**Syntax:** `hana-cli dropContainer [container] [group]`
**Tags:** container, drop, hdi
**Use cases:**
- Drop HDI container
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--container` (`-c`) | string | - | container |
| `--group` (`-g`) | string | `''` | group |
**Related:** `createContainer`, `containers`
---
### Mass Operations
Bulk operations for grants, updates, deletions, and conversions
#### `massConvert`
**Aliases:** `mc`, `massconvert`, `massConv`, `massconv`
**Syntax:** `hana-cli massConvert [schema] [table] [view]`
**Tags:** convert, bulk-operation, data-type
**Use cases:**
- Convert data types
- Bulk data conversion
**Related:** `massUpdate`, `massRename`
---
#### `massConvertUI`
**Aliases:** `mcui`, `massconvertui`, `massConvUI`, `massconvui`
**Syntax:** `hana-cli massConvertUI [schema] [table]`
**Related:** `massConvert`
---
#### `massDelete`
**Aliases:** `md`, `massdelete`, `massDel`, `massdel`
**Syntax:** `hana-cli massDelete [schema] [object]`
**Tags:** delete, bulk-operation, purge
**Use cases:**
- Delete records in bulk
- Purge old data
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--schema` (`-s`) | string | - | schema |
| `--object` (`-o`) | string | - | object |
| `--limit` (`-l`) | number | `1000` | limit |
| `--objectType` (`-t`, `--type`) | string | - | objectType |
| `--includeSystem` (`-i`, `--system`) | boolean | `false` | includeSystemObjects |
| `--dryRun` (`--dr`, `--preview`) | boolean | `false` | dryRun |
| `--force` (`-f`) | boolean | `false` | force |
| `--log` | boolean | - | log |
**Related:** `massExport`, `massUpdate`
---
#### `massExport`
**Aliases:** `me`, `mexport`, `massExp`, `massexp`
**Syntax:** `hana-cli massExport [schema] [object]`
**Tags:** export, bulk-operation, extract
**Use cases:**
- Export multiple tables at once
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--schema` (`-s`, `--schema`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--object` (`-o`, `--object`) | string | `'*'` | object |
| `--objectType` (`-t`, `--type`) | string | - | objectType |
| `--limit` (`-l`, `--limit`) | number | `1000` | limit |
| `--format` (`-f`, `--format`) | string | `'csv'` | exportFormat |
| `--folder` (`--directory`, `--dir`) | string | - | folder |
| `--includeData` (`--data`) | boolean | `false` | includeData |
**Related:** `export`, `massDelete`
---
#### `massGrant`
**Aliases:** `mg`, `massgrant`, `massGrn`, `massgrn`
**Syntax:** `hana-cli massGrant [schema] [object]`
**Tags:** grant, permission, bulk-operation
**Use cases:**
- Grant permissions in bulk
- Bulk privilege assignment
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--schema` (`-s`) | string | - | schema |
| `--object` (`-o`) | string | - | object |
| `--grantee` (`-g`) | string | - | grantee |
| `--privilege` (`--pr`) | string | - | privilege |
| `--objectType` (`-t`, `--type`) | string | - | objectType |
| `--withGrantOption` (`--wgo`) | boolean | `false` | withGrantOption |
| `--dryRun` (`--dr`, `--preview`) | boolean | `false` | dryRun |
| `--log` | boolean | - | log |
**Related:** `massUsers`, `users`, `roles`
---
#### `massRename`
**Aliases:** `mr`, `massrename`, `massRN`, `massrn`
**Syntax:** `hana-cli massRename`
**Tags:** rename, bulk-operation
**Use cases:**
- Rename objects in bulk
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--schema` (`-s`) | string | - | schemaCDS |
| `--namespace` (`-n`) | string | - | namespace |
| `--prefix` (`-p`) | string | - | prefix |
| `--case` (`-c`) | string | - | case |
**Related:** `massConvert`, `massUpdate`
---
#### `massUpdate`
**Aliases:** `mu`, `massupdate`, `massUpd`, `massupd`
**Syntax:** `hana-cli massUpdate [schema] [object]`
**Tags:** update, bulk-operation
**Use cases:**
- Update many records at once
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--schema` (`-s`) | string | - | schema |
| `--object` (`-o`) | string | - | object |
| `--setClause` (`-c`, `--set`) | string | - | setClause |
| `--whereClause` (`-w`, `--where`) | string | - | whereClause |
| `--limit` (`-l`) | number | `1000` | limit |
| `--dryRun` (`--dr`, `--preview`) | boolean | `false` | dryRun |
| `--log` | boolean | - | log |
**Related:** `massDelete`, `massConvert`
---
#### `massUsers`
**Aliases:** `massUser`, `mUsers`, `mUser`, `mu`
**Syntax:** `hana-cli massUsers [user] [password]`
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--user` (`-u`) | string | - | user |
| `--password` (`-p`) | string | - | password |
**Related:** `users`, `roles`, `massGrant`
---
#### `tableCopy`
**Aliases:** `tablecopy`, `copyTable`, `copytable`
**Syntax:** `hana-cli tableCopy`
**Tags:** copy, transfer, data-movement
**Use cases:**
- Copy table between schemas
- Copy table to another system
**Prerequisites:** Active database connection, Source table exists, Target schema accessible
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--sourceTable` (`--st`) | string | - | tableCopySourceTable |
| `--targetTable` (`--tt`) | string | - | tableCopyTargetTable |
| `--sourceSchema` (`--ss`) | string | `'**CURRENT_SCHEMA**'` | tableCopySourceSchema |
| `--targetSchema` (`--ts`) | string | `'**CURRENT_SCHEMA**'` | tableCopyTargetSchema |
| `--structureOnly` (`--so`) | boolean | `false` | tableCopyStructureOnly |
| `--dataOnly` (`--do`) | boolean | `false` | tableCopyDataOnly |
| `--where` (`-w`) | string | - | tableCopyWhere |
| `--limit` (`-l`) | number | - | tableCopyLimit |
| `--batchSize` (`-b`, `--batch`) | number | `1000` | tableCopyBatchSize |
| `--dryRun` (`--dr`, `--preview`) | boolean | `false` | dryRun |
| `--timeout` (`--to`) | number | `3600` | tableCopyTimeout |
| `--profile` (`-p`) | string | - | profile |
**Related:** `export`, `import`, `tables`
---
### Object Inspection
Inspect tables, views, procedures, indexes, and related objects
#### `inspectFunction`
**Aliases:** `if`, `function`, `insFunc`, `inspectfunction`
**Syntax:** `hana-cli inspectFunction [schema] [function]`
**Tags:** function, inspection
**Use cases:**
- Inspect function details
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--functionName` (`-f`, `--function`) | string | - | function |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--output` (`-o`) | string | `"tbl"` | outputType |
**Related:** `functions`, `inspectProcedure`
---
#### `inspectIndex`
**Aliases:** `ii`, `index`, `insIndex`, `inspectindex`
**Syntax:** `hana-cli inspectIndex [schema] [index]`
**Tags:** index, inspection, analysis
**Use cases:**
- Inspect index details
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--index` (`-i`) | string | - | index |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
**Related:** `indexes`, `tables`, `tableHotspots`
---
#### `inspectJWT`
**Aliases:** `jwt`, `ijwt`, `iJWT`, `iJwt`
**Syntax:** `hana-cli inspectJWT`
**Tags:** jwt, token, analysis
**Use cases:**
- Analyze JWT token
**Related:** `createJWT`
---
#### `inspectLibMember`
**Aliases:** `ilm`, `libraryMember`, `librarymember`, `insLibMem`, `inspectlibrarymember`
**Syntax:** `hana-cli inspectLibMember [schema] [library] [libraryMem]`
**Tags:** library, member
**Use cases:**
- Inspect library member details
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--library` (`--lib`) | string | - | library |
| `--libraryMem` (`-m`, `--libMem`) | string | - | libMember |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--output` (`-o`) | string | `"tbl"` | outputType |
**Related:** `libraries`, `inspectLibrary`
---
#### `inspectLibrary`
**Aliases:** `il`, `library`, `insLib`, `inspectlibrary`
**Syntax:** `hana-cli inspectLibrary [schema] [library]`
**Tags:** library, inspection
**Use cases:**
- Inspect library details
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--library` (`--lib`) | string | - | library |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--output` (`-o`) | string | `"tbl"` | outputType |
**Related:** `libraries`, `inspectLibMember`
---
#### `inspectProcedure`
**Aliases:** `ip`, `procedure`, `insProc`, `inspectprocedure`, `inspectsp`
**Syntax:** `hana-cli inspectProcedure [schema] [procedure]`
**Tags:** procedure, inspection
**Use cases:**
- Inspect procedure details
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--procedure` (`-p`, `--sp`) | string | - | procedure |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--output` (`-o`) | string | `"tbl"` | outputType |
**Related:** `procedures`, `inspectFunction`, `callProcedure`
---
#### `inspectTable`
**Aliases:** `it`, `table`, `insTbl`, `inspecttable`, `inspectable`
**Syntax:** `hana-cli inspectTable [schema] [table]`
**Tags:** table, inspection, analysis
**Use cases:**
- Inspect table structure and properties
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table` (`-t`) | string | - | table |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--output` (`-o`) | string | `"tbl"` | outputType |
| `--useHanaTypes` (`--hana`) | boolean | `false` | useHanaTypes |
| `--useExists` (`--exists`, `--persistence`) | boolean | `true` | useExists |
| `--useQuoted` (`-q`, `--quoted`) | boolean | `false` | useQuoted |
| `--noColons` | boolean | `false` | noColons |
**Related:** `tables`, `inspectView`, `columnStats`
---
#### `inspectTableUI`
**Aliases:** `itui`, `tableUI`, `tableui`, `insTblUI`, `inspecttableui`, `inspectableui`
**Syntax:** `hana-cli inspectTableUI [schema] [table]`
**Related:** `tables`, `inspectTable`
---
#### `inspectTrigger`
**Aliases:** `itrig`, `trigger`, `insTrig`, `inspecttrigger`, `inspectrigger`
**Syntax:** `hana-cli inspectTrigger [schema] [trigger]`
**Tags:** trigger, inspection
**Use cases:**
- Inspect trigger details
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--trigger` (`-t`) | string | `"*"` | sequence |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--output` (`-o`) | string | `"tbl"` | outputType |
**Related:** `triggers`, `inspectProcedure`, `tables`
---
#### `inspectView`
**Aliases:** `iv`, `view`, `insVew`, `inspectview`
**Syntax:** `hana-cli inspectView [schema] [view]`
**Tags:** view, inspection
**Use cases:**
- Inspect view details
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--view` (`-v`) | string | - | view |
| `--schema` (`-s`) | string | `'**CURRENT_SCHEMA**'` | schema |
| `--output` (`-o`) | string | `"tbl"` | outputType |
| `--useHanaTypes` (`--hana`) | boolean | `false` | useHanaTypes |
| `--useExists` (`--exists`, `--persistence`) | boolean | `true` | useExists |
| `--useQuoted` (`-q`, `--quoted`) | boolean | `false` | useQuoted |
| `--noColons` | boolean | `false` | noColons |
**Related:** `views`, `inspectTable`, `inspectProcedure`
---
### Other
#### `commandMap`
**Syntax:** `hana-cli commandMap`
---
### Performance Monitoring
Monitor performance, expensive operations, and system bottlenecks
#### `blocking`
**Aliases:** `b`, `locks`
**Syntax:** `hana-cli blocking`
**Tags:** blocking, lock, session
**Use cases:**
- Find blocking locks
- Identify deadlocks
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--limit` (`-l`) | number | `50` | limit |
| `--details` (`-d`) | boolean | `false` | details |
**Related:** `deadlocks`, `longRunning`, `connections`
---
#### `columnStats`
**Syntax:** `hana-cli columnStats [schema] [table]`
**Tags:** statistics, column-analysis
**Use cases:**
- Analyze column statistics
- Update column statistics
**Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--table` (`-t`) | string | `"*"` | table |
| `--sc