AgentSkillsCN

sap-hana-cli

协助使用 SAP HANA Developer CLI（hana-cli）进行数据库开发与管理。 适用于：安装 hana-cli、连接 SAP HANA 数据库、检查数据库对象（表、视图、存储过程、函数）、管理 HDI 容器、执行 SQL 查询、将元数据转换为 CDS/EDMX/OpenAPI 格式、管理 SAP HANA Cloud 实例、与 BTP CLI 集成，或对 hana-cli 命令进行故障排查时使用。 涵盖：91 条命令、17 种以上输出格式、HDI 容器管理、云端操作。

SKILL.md
--- frontmatter
name: sap-hana-cli
description: |
  Assists with SAP HANA Developer CLI (hana-cli) for database development and administration.
  Use when: installing hana-cli, connecting to SAP HANA databases, inspecting database objects
  (tables, views, procedures, functions), managing HDI containers, executing SQL queries,
  converting metadata to CDS/EDMX/OpenAPI formats, managing SAP HANA Cloud instances,
  working with BTP CLI integration, or troubleshooting hana-cli commands.
  Covers: 91 commands, 17+ output formats, HDI container management, cloud operations.
license: GPL-3.0
metadata:
  version: "1.1.0"
  last_verified: "2025-11-26"

SAP HANA Developer CLI (hana-cli)

Related Skills

  • •sap-cap-capire: Use for CAP database development, HDI container management, and CDS syntax comparison
  • •sap-btp-cloud-platform: Use for HANA Cloud operations, BTP integration, and cloud instance management
  • •sap-abap-cds: Use for comparing CDS syntax between CAP and ABAP or understanding HANA CDS features
  • •sap-datasphere: Use when working with SAP Datasphere integration or data warehousing scenarios

A developer-centric command-line interface for SAP HANA database development, particularly useful in non-SAP tooling environments like VS Code.

Repository: https://github.com/SAP-samples/hana-developer-cli-tool-example npm Package: https://www.npmjs.com/package/hana-cli Current Version: 3.202405.1 (April 2024) Node.js Requirement: ≥20.19.0

Table of Contents

Quick Start

Installation

bash
# Install globally via npm (recommended)
npm install -g hana-cli

# Verify installation
hana-cli version

First Connection

bash
# Interactive connection setup
hana-cli connect

# Or specify connection directly
hana-cli connect -n "hostname:port" -u DBUSER -p PASSWORD --save

# Using service key (HANA Cloud)
hana-cli connectViaServiceKey

Core Command Categories

Database Object Inspection

CommandAliasesPurpose
inspectTableit, tableInspect table structure
inspectView-Inspect view definition
inspectProcedure-Inspect stored procedure
inspectFunction-Inspect function definition
tables-List all tables in schema
views-List all views in schema
procedures-List stored procedures
functions-List functions

Query Execution

CommandAliasesPurpose
querySimpleqsExecute SQL query
callProcedurecpExecute stored procedure
hdbsql-Direct SQL execution

HDI Container Management

CommandAliasesPurpose
containerscontList HDI containers
createContainer-Create new container
dropContainer-Remove container
activateHDI-Enable HDI service
adminHDI-Administer HDI privileges

Cloud & BTP Operations

CommandAliasesPurpose
hanaCloudInstances-List HANA Cloud instances
hanaCloudStart-Start cloud instance
hanaCloudStop-Stop cloud instance
btp-Configure BTP CLI
btpInfo-Display BTP target info

Output Formats

The --output / -o option supports 17+ formats:

FormatUse Case
tblHuman-readable table (default)
jsonJSON data
yamlYAML format
csvCSV export
excelExcel file
cdsCAP CDS definitions
hdbcdsHANA CDS format
hdbtableHDB Table definitions
sqlSQL DDL statements
edmxOData EDMX metadata
openapiOpenAPI/Swagger spec
graphqlGraphQL schema

Connection Configuration

Connection credentials are searched in priority order:

  1. •default-env-admin.json (with --admin flag)
  2. •.cdsrc-private.json (via cds bind)
  3. •.env file with VCAP_SERVICES
  4. •File specified via --conn parameter
  5. •default-env.json in current/parent directories
  6. •~/.hana-cli/default.json

For connection templates, see templates/default-env.json.

Common Workflows

Inspect and Convert Table to CDS

bash
# Inspect table structure
hana-cli inspectTable -s MYSCHEMA -t MYTABLE

# Convert to CDS format
hana-cli inspectTable -s MYSCHEMA -t MYTABLE -o cds

Mass Convert Schema Objects

bash
# Convert all objects in schema to CDS
hana-cli massConvert -s MYSCHEMA

Execute Query with Export

bash
# Run query and export to JSON
hana-cli querySimple -q "SELECT * FROM MYTABLE" -o json

# Export to Excel file
hana-cli querySimple -q "SELECT * FROM MYTABLE" -o excel -f ./output -n report

Manage HDI Containers

bash
# List all containers
hana-cli containers

# Create new container
hana-cli createContainer -c MY_CONTAINER -g MY_GROUP

# Create container users
hana-cli createContainerUsers -c MY_CONTAINER

UI Commands

Many commands have browser-based UI alternatives (suffix UI):

  • •tablesUI - Browse tables visually
  • •containersUI - Manage containers in browser
  • •massConvertUI - Visual mass conversion
  • •querySimpleUI - Query builder interface
  • •systemInfoUI - System dashboard

Key Features

  • •Multi-database support: HANA, PostgreSQL, SQLite backends
  • •Format conversion: 17+ output formats including CDS, EDMX, OpenAPI
  • •HDI management: Full container lifecycle management
  • •Cloud integration: SAP BTP CLI and HANA Cloud support
  • •Interactive prompts: Missing parameters prompted automatically
  • •Service key auth: Secure cloud authentication

Detailed References

For comprehensive documentation:

  • •All 91 Commands: See references/command-reference.md
  • •Connection & Security: See references/connection-security.md
  • •HDI Management: See references/hdi-management.md
  • •Output Formats: See references/output-formats.md
  • •Cloud Operations: See references/cloud-operations.md
  • •Database Inspection: See references/db-inspection.md
  • •Mass Operations: See references/mass-operations.md
  • •System Administration: See references/system-admin.md
  • •Web UI Interface: See references/web-ui.md
  • •Troubleshooting Guide: See references/troubleshooting.md
  • •Development Environment: See references/development-environment.md
  • •ABAP Programming Patterns: See references/abap-programming.md

Troubleshooting

Connection Issues

bash
# Check current connection status
hana-cli status

# Test with explicit credentials
hana-cli connect -n "host:443" -u USER -p PASS --encrypt true

# Use SSL trust store
hana-cli connect --trustStore /path/to/certificate.pem

Permission Errors

bash
# Diagnose privilege errors
hana-cli privilegeError

# View current user info
hana-cli inspectUser

Version Compatibility

  • •Node.js: Requires ≥20.19.0
  • •@sap/cds: Uses 9.4.4
  • •@sap/cds-dk: Requires ≥8.9 for cds bind

Bundled Resources

Reference Documentation

  • •references/command-reference.md - Complete command reference with all options
  • •references/abap-programming.md - ABAP-specific programming patterns
  • •references/quick-start.md - Quick start guide and examples

Scripts

  • •scripts/hana-setup.sh - HANA development environment setup script
  • •scripts/migration-helper.sh - Migration helper script for existing projects

Resources

Last Updated: 2025-11-26 | Version: 1.1.0