{"id":20484433,"url":"https://github.com/sap-samples/hana-developer-cli-tool-example","last_synced_at":"2025-04-13T04:05:22.363Z","repository":{"id":40363801,"uuid":"240335405","full_name":"SAP-samples/hana-developer-cli-tool-example","owner":"SAP-samples","description":"Learn how to build a developer-centric SAP HANA command line tool, particularly designed to be used when performing SAP HANA development in non-SAP tooling (for example from VS Code).","archived":false,"fork":false,"pushed_at":"2025-04-09T18:08:43.000Z","size":150603,"stargazers_count":92,"open_issues_count":1,"forks_count":24,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-04-13T04:05:02.867Z","etag":null,"topics":["command-line-tool","owner-jung-thomas","sample","sample-code","sap-hana","sap-hana-cloud","sap-hana-cloud-hana-database","vscode"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SAP-samples.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.js","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-13T18:45:21.000Z","updated_at":"2025-04-09T18:08:46.000Z","dependencies_parsed_at":"2024-04-09T16:25:51.868Z","dependency_job_id":"b3400915-93d0-4515-a812-91bc706ab79b","html_url":"https://github.com/SAP-samples/hana-developer-cli-tool-example","commit_stats":{"total_commits":285,"total_committers":8,"mean_commits":35.625,"dds":0.1578947368421053,"last_synced_commit":"60536cc878d886e81536d79f61c6a5fd858fbdb8"},"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fhana-developer-cli-tool-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fhana-developer-cli-tool-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fhana-developer-cli-tool-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAP-samples%2Fhana-developer-cli-tool-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SAP-samples","download_url":"https://codeload.github.com/SAP-samples/hana-developer-cli-tool-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661708,"owners_count":21141450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line-tool","owner-jung-thomas","sample","sample-code","sap-hana","sap-hana-cloud","sap-hana-cloud-hana-database","vscode"],"created_at":"2024-11-15T16:22:22.066Z","updated_at":"2025-04-13T04:05:22.330Z","avatar_url":"https://github.com/SAP-samples.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SAP HANA Developer Command Line Interface\n\n[![REUSE status](https://api.reuse.software/badge/github.com/SAP-samples/hana-developer-cli-tool-example)](https://api.reuse.software/info/github.com/SAP-samples/hana-developer-cli-tool-example)\n\nThe [change log](CHANGELOG.md) describes notable changes in this package.\n\n## Description\n\nThis sample is intended to shown how one could build a developer-centric SAP HANA command line tool, particularly designed to be used when performing local SAP HANA development in non-SAP tooling (like VSCode). It utilizes the default-env.json that is often used in local development for connectivity to a remote SAP HANA DB (although it can of course be used with a local SAP HANA, express edition instance as well). There is no intention to replacing the hdbsql tool as a generic SQL console. Instead this sample will focus on simplifying and grouping common and complex commands that otherwise might a lot of separate scripts.\n\nIntroduction Video: [https://youtu.be/dvVQfi9Qgog](https://youtu.be/dvVQfi9Qgog)\n\nHowever the tool isn't limited to only local development. It also works well when developing in the cloud. The hana-cli tool can also run well from a cloud shell in the SAP Business Application Studio, Google Cloud Shell, AWS Cloud9, etc. We can also run against a SAP HANA service for SAP BTP or SAP HANA Cloud instance. This demonstrates that the tool can run just about anywhere you can get a command line that has access to the Node.js Runtime. We can also connect to a remote HANA instance even if it isn't running in the same cloud environment in which we are performing our development tasks.\n\nRunning in Cloud Shells Video: [https://youtu.be/L7QyVLvAIIQ](https://youtu.be/L7QyVLvAIIQ)\n\n## Requirements / Download and Installation\n\nIf you would rather just access the tool directly, it is now available in npm as well. You can install via:\n\n```shell\nnpm install -g hana-cli\n```\n\nOtherwise you can also run it from the sources as described here:\n\n* Install Node.js version 14.x or 16.x on your development machine [https://nodejs.org/en/download/](https://nodejs.org/en/download/)\n\n* @sap Node.js packages have moved from https://npm.sap.com to the default registry https://registry.npmjs.org. As future versions of @sap modules are going to be published only there, please make sure to adjust your registry with:\n\n```shell\nnpm config delete @sap:registry\n```\n\n* Clone the repository from [https://github.com/SAP-samples/hana-developer-cli-tool-example](https://github.com/SAP-samples/hana-developer-cli-tool-example)\n\n```shell\ngit clone https://github.com/SAP-samples/hana-developer-cli-tool-example\n```\n\n* Run NPM install from the root of the hana-developer-cli-tool-example project you just cloned to download dependencies\n\n```shell\nnpm install\n```\n\n* Run NPM link from the cloned project root to make the hana-cli command available from everywhere [https://docs.npmjs.com/cli/link](https://docs.npmjs.com/cli/link)\n\n```shell\nnpm link\n```\n\n[![asciicast](https://asciinema.org/a/301560.svg)](https://asciinema.org/a/301560)\n\n## Security\n\nThis application primarily uses the default-env.json that is often used in local development for connectivity to a remote HANA DB (although it can of course be used with a local SAP HANA, express edition instance as well). For more details on how the default-env.json works, see the readme.md of the @sap/xsenv package or the @sap/hdi-deploy package.\n\nThe tool doesn't simply look for a default-env.json file in the current directory however. There are numerous options and places it will look for the connection parameters. Here is the order in which it checks:\n\n - First we look for the Admin option and use a default-env-admin.json - this overrides all other parameters\n - If no admin option or if there was an admin option but no default-env-admin.json could be found in this directory or 5 parent directories, then look for `.cdsrc-private.json` in this directory or 5 parent directories and use [`cds bind`](https://cap.cloud.sap/docs/advanced/hybrid-testing#bind-to-cloud-services) functionality to lookup the credentials securely. This is the most secure option, but please note: this will make each command take a few seconds longer as credentials are no longer stored locally but looked up from cf or k8s dynamically with each command\n - If no `.cdsrc-private.json` found in this directory or 5 parent directories, then look for a .env file in this directory or up to 5 parent directories\n - No .env file found or it doesn't contain a VCAP_SERVICES section, then check to see if the --conn parameter was specified. If so check for that file in the current directory or up to 5 parent directories\n - If the file specified via the --conn parameter wasn't found locally then check for it in the ${homedir}/.hana-cli/ folder\n - If no specific configuration file was was found then look for a file named default-env.json in the current directory or up to 5 parent directories\n - Last resort if nothing has been found up to this point - look for a file named default.json in the ${homedir}/.hana-cli/ folder\n\n## Examples\n\nA lot of the functionality of this tool revolves around typical tasks you face while doing HANA database development.\nFor example you might want to get a list of all views in your current schema/container:\n\n```shell\nC:\\github\\hana-xsa-opensap-hana7\\user_db\u003ehana-cli views\nSchema: OPENSAP_HANA_USER, View: *\nSCHEMA_NAME VIEW_NAME VIEW_OID COMMENTS\n----------------- ------------------------------------------- -------- ------------\nOPENSAP_HANA_USER user.models::USER_DETAILS 171133 USER_DETAILS\nOPENSAP_HANA_USER user.models::USER_DETAILS/hier/USER_DETAILS 171139 null\n```\n\nThen perhaps you want to inspect a view to see the columns and their data types:\n\n```shell\nC:\\github\\hana-xsa-opensap-hana7\\user_db\u003ehana-cli view * user.models::USER_DETAILS\nSchema: %, View: user.models::USER_DETAILS\n{ SCHEMA_NAME: 'OPENSAP_HANA_USER',\n VIEW_NAME: 'user.models::USER_DETAILS',\n VIEW_OID: 171133,\n COMMENTS: 'USER_DETAILS',\n IS_COLUMN_VIEW: 'TRUE',\n VIEW_TYPE: 'CALC',\n HAS_STRUCTURED_PRIVILEGE_CHECK: 'TRUE',\n HAS_PARAMETERS: 'TRUE',\n HAS_CACHE: 'NONE',\n CREATE_TIME: '2019-07-30 13:14:15.594000000' }\n\n\nSCHEMA_NAME VIEW_NAME VIEW_OID COLUMN_NAME POSITION DATA_TYPE_NAME OFFSET LENGTH SCALE IS_NULLABLE DEFAULT_VALUE CS_DATA_TYPE_NAME COLUMN_ID COMMENTS\n----------------- ------------------------- -------- ----------- -------- -------------- ------ ------ ----- ----------- ------------- ----------------- --------- ---------\nOPENSAP_HANA_USER user.models::USER_DETAILS 171133 EMAIL 1 NVARCHAR 0 255 null TRUE null STRING 171135 Email\nOPENSAP_HANA_USER user.models::USER_DETAILS 171133 FIRSTNAME 2 NVARCHAR 0 40 null TRUE null STRING 171136 FirstName\nOPENSAP_HANA_USER user.models::USER_DETAILS 171133 LASTNAME 3 NVARCHAR 0 40 null TRUE null STRING 171137 LastName\nOPENSAP_HANA_USER user.models::USER_DETAILS 171133 USERID 4 INTEGER 0 10 0 TRUE null INT 171138 UserId\n```\n\nBut there are multiple output options for inspection. Perhaps you are using Cloud Application Programming Model and need to create a proxy entity in CDS for a view. This tool will read the catalog metadata and convert it to CDS:\n\n```shell\nC:\\github\\hana-xsa-opensap-hana7\\user_db\u003ehana-cli view OPENSAP_HANA_USER user.models::USER_DETAILS -o cds\nSchema: OPENSAP_HANA_USER, View: user.models::USER_DETAILS\n@cds.persistence.exists\nEntity user_modelsUSER_DETAILS {\n key \"EMAIL\": String(255) null @title: 'EMAIL: Email' ;\nkey \"FIRSTNAME\": String(40) null @title: 'FIRSTNAME: FirstName' ;\nkey \"LASTNAME\": String(40) null @title: 'LASTNAME: LastName' ;\nkey \"USERID\": Integer null @title: 'USERID: UserId' ;\n}\n```\n\nOr maybe you are service enabling this view and you want to see it converted to EDMX:\n\n```shell\nC:\\github\\hana-xsa-opensap-hana7\\user_db\u003ehana-cli view OPENSAP_HANA_USER user.models::USER_DETAILS -o edmx\nSchema: OPENSAP_HANA_USER, View: user.models::USER_DETAILS\n\u003c?xml version=\"1.0\" encoding=\"utf-8\"?\u003e\n\u003cedmx:Edmx Version=\"1.0\" xmlns:edmx=\"http://schemas.microsoft.com/ado/2007/06/edmx\" xmlns:m=\"http://schemas.microsoft.com/ado/2007/08/dataservices/metadata\" xmlns:sap=\"http://www.sap.com/Protocols/SAPData\"\u003e\n \u003cedmx:Reference Uri=\"https://wiki.scn.sap.com/wiki/download/attachments/448470974/Common.xml?api=v2\" xmlns:edmx=\"http://docs.oasis-open.org/odata/ns/edmx\"\u003e\n \u003cedmx:Include Alias=\"Common\" Namespace=\"com.sap.vocabularies.Common.v1\"/\u003e\n \u003c/edmx:Reference\u003e\n \u003cedmx:DataServices m:DataServiceVersion=\"2.0\"\u003e\n \u003cSchema Namespace=\"HanaCli\" xmlns=\"http://schemas.microsoft.com/ado/2008/09/edm\"\u003e\n \u003cEntityContainer Name=\"EntityContainer\" m:IsDefaultEntityContainer=\"true\"\u003e\n \u003cEntitySet Name=\"user_modelsUSER_DETAILS\" EntityType=\"HanaCli.user_modelsUSER_DETAILS\"/\u003e\n \u003c/EntityContainer\u003e\n \u003cEntityType Name=\"user_modelsUSER_DETAILS\"\u003e\n \u003cKey\u003e\n \u003cPropertyRef Name=\"EMAIL\"/\u003e\n \u003cPropertyRef Name=\"FIRSTNAME\"/\u003e\n \u003cPropertyRef Name=\"LASTNAME\"/\u003e\n \u003cPropertyRef Name=\"USERID\"/\u003e\n \u003c/Key\u003e\n \u003cProperty Name=\"EMAIL\" Type=\"Edm.String\" MaxLength=\"255\"/\u003e\n \u003cProperty Name=\"FIRSTNAME\" Type=\"Edm.String\" MaxLength=\"40\"/\u003e\n \u003cProperty Name=\"LASTNAME\" Type=\"Edm.String\" MaxLength=\"40\"/\u003e\n \u003cProperty Name=\"USERID\" Type=\"Edm.Int32\"/\u003e\n \u003c/EntityType\u003e\n \u003cAnnotations Target=\"HanaCli.user_modelsUSER_DETAILS/EMAIL\" xmlns=\"http://docs.oasis-open.org/odata/ns/edm\"\u003e\n \u003cAnnotation Term=\"Common.Label\" String=\"EMAIL: Email\"/\u003e\n \u003c/Annotations\u003e\n \u003cAnnotations Target=\"HanaCli.user_modelsUSER_DETAILS/FIRSTNAME\" xmlns=\"http://docs.oasis-open.org/odata/ns/edm\"\u003e\n \u003cAnnotation Term=\"Common.Label\" String=\"FIRSTNAME: FirstName\"/\u003e\n \u003c/Annotations\u003e\n \u003cAnnotations Target=\"HanaCli.user_modelsUSER_DETAILS/LASTNAME\" xmlns=\"http://docs.oasis-open.org/odata/ns/edm\"\u003e\n \u003cAnnotation Term=\"Common.Label\" String=\"LASTNAME: LastName\"/\u003e\n \u003c/Annotations\u003e\n \u003cAnnotations Target=\"HanaCli.user_modelsUSER_DETAILS/USERID\" xmlns=\"http://docs.oasis-open.org/odata/ns/edm\"\u003e\n \u003cAnnotation Term=\"Common.Label\" String=\"USERID: UserId\"/\u003e\n \u003c/Annotations\u003e\n \u003c/Schema\u003e\n \u003c/edmx:DataServices\u003e\n\u003c/edmx:Edmx\u003e\n```\n\nThis tool will even create a temporary OData V4 service for any existing table, view or Calculation View and launch a test Fiori Ui locally.\n![Fioir Example](images/ex1.png)\n\n## Commands\n\n### activateHDI\n\n```shell\nhana-cli activateHDI [tenant]\n[aliases: ahdi, ah]\nActivate the HDI service in a particluar SAP HANA Tenant (Must be ran in the\nSYSTEMDB)\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -t, --tenant, --Tenant SAP HANA Tenant [string]\n```\n\n### adminHDI\n\n```shell\nhana-cli adminHDI [user] [password]\n[aliases: adHDI, adhdi]\nCreate an Admin User for HDI or assign HDI admin privileges to an existing user\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -u, --user, --User User\n -p, --password, --Password Password\n -c, --create, --Create Set this parameter to false to reuse an existing\n database user and assign the HDI admin privileges\n to this user. In this case a dummy password can\n be given.\n [boolean] [default: false]\n```\n\n### adminHDIGroup\n\n```shell\nhana-cli adminHDIGroup [user] [group]\n[aliases: adHDIG, adhdig]\nAdd a User as an HDI Group Admin\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -u, --user, --User User\n -g, --group, --Group HDI Group [string] [default: \"SYS_XS_HANA_BROKER\"]\n```\n\n### btp\n\n```shell\nhana-cli btp [directory] [subaccount]\n\nSet the target for commands for the btp CLI to the global account, a directory,\nor a subaccount. Commands are executed in the specified target, unless you override it using a parameter. If the specified target is part of an account hierarchy, its parents are also targeted, so that if a command is only available on a higher level, it will be executed there.\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra output t\n hat is only helpful to human readable interface. Us\n eful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS of i\n ntermediate details [boolean] [default: false]\n\nOptions:\n --subaccount, --sa The ID of the subaccount to be targeted [string]\n```\n\n![bas example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/btp.gif)\n\n### btpInfo\n\n```shell\nDetailed Information about btp CLI target\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra outp\n ut that is only helpful to human readable inter\n face. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"json\"] [default: \"tbl\"]\n```\n\n### callProcedure\n\n```shell\nhana-cli callProcedure [schema] [procedure]\n[aliases: cp, callprocedure, callProc, callproc, callSP, callsp]\nCall a stored procedure and display the results\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -p, --procedure, --Procedure, --sp Stored Procedure [string]\n -s, --schema, --Schema schema\n [string] [default: \"**CURRENT_SCHEMA**\"]\n```\n\n![callProcedure example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/callProcedure.gif)\n\n### certificates\n\n```shell\nhana-cli certificates\n[aliases: cert, certs]\nList System Certificates\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![certificates example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/certificates.gif)\n\n### cds\n\n```shell\nhana-cli cds [schema] [table]\n[aliases: cdsPreview]\nDisplay a DB object via CDS\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -t, --table, --Table Database Table [string]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -v, --view, --View CDS processing for View instead of Table\n [boolean] [default: false]\n --useHanaTypes, --hana Use SAP HANA-Specific Data Types See (https://cap.\n cloud.sap/docs/cds/cdl#predefined-types)\n [boolean] [default: false]\n -q, --useQuoted, --quoted, --quotedIdent Use Quoted Identifiers ![non-identif\n ifiers ier] [boolean] [default: false] \n -p, --port Port to run HTTP server for CDS preview\n [default: false]\n```\n\n### changelog\n\n```shell\nhana-cli changelog\n[aliases: chg]\nOpen Change Log in browser\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra output\n that is only helpful to human readable interface.\n Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS of\n intermediate details [boolean] [default: false]\n```\n\n### changes\n\n```shell\nhana-cli changes\n[aliases: chg]\nDisplay Change Log in CLI\n```\n\n### changesUI\n\n```shell\nhana-cli changesUI\n[aliases: chgUI, chgui, changeLogUI, changelogui]\nDisplay Change Log in Browser UI\n```\n\n### completion\n\n```shell\nhana-cli completion\ngenerate completion script for bash shell\n```\n\n### connect\n\n```shell\nhana-cli connect [user] [password]\n[aliases: c, login]\nConnects to an SAP HANA DB and writes connection information to a\ndefault-env-admin.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -n, --connection Connection String \u003chost\u003e[:\u003cport\u003e]\n -u, --user, --User User\n -p, --password, --Password Password\n -U, --userstorekey, --UserStoreKey Optional: HDB User Store Key -\n Overrides all other Connection\n Parameters\n -s, --save, --Save Save Credentials to\n default-env-admin.json\n [boolean] [default: true]\n -e, --encrypt, --Encrypt, --ssl Encrypt connections (required for\n SAP HANA service for SAP BTP or SAP\n HANA Cloud) [boolean]\n -t, --trustStore, --Trust, --trust, SSL Trust Store\n --truststore\n```\n\n![connect example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/connect.gif)\n\n### containers\n\n```shell\nhana-cli containers [containerGroup] [container]\n[aliases: cont, listContainers, listcontainers]\nList all HDI Containers\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --container, --Container Container Name\n [string] [default: \"*\"]\n -g, --containerGroup, --Group, --group, Container Group\n --containergroup [string] [default: \"*\"]\n -l, --limit Limit results[number] [default: 200]\n```\n\n### containersUI\n\n```shell\nhana-cli containersUI [containerGroup] [container]\n[aliases: contui, listContainersUI, listcontainersui, containersui]\nList all HDI Containers in browser UI\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --container, --Container Container Name\n [string] [default: \"*\"]\n -g, --containerGroup, --Group, --group, Container Group\n --containergroup [string] [default: \"*\"]\n -l, --limit Limit results[number] [default: 200]\n```\n### copy2DefaultEnv\n\n```shell\nhana-cli copy2DefaultEnv\n[aliases: copyDefaultEnv, copyDefault-Env, copy2defaultenv, copydefaultenv,\n copydefault-env]\nCopy .env contents to default-env.json and reformat\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra output\n that is only helpful to human readable interface.\n Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS of\n intermediate details [boolean] [default: false]\n```\n\n### copy2Env\n\n```shell\nhana-cli copy2Env\n[aliases: copyEnv, copyenv, copy2env]\nCopy default-env.json contents to .env and reformat\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n### copy2Secrets\n\n```shell\nhana-cli copy2Secrets\n[aliases: secrets, make:secrets]\nmake secrets for Kubernetes deployment\n(https://www.npmjs.com/package/@sap/xsenv#usage-in-kubernetes)\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra output\n that is only helpful to human readable interface.\n Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS of\n intermediate details [boolean] [default: false]\n\nOptions:\n --envJson, --from-file JSON file containing VCAP_SERVICES variable\n [string] [default: \"default-env.json\"]\n --secretsFolder, --to-folder Folder name for storing secrets\n [string] [default: \"secrets\"]\n --filter List of service instances to process [string]\n```\n\n### createGroup\n\n```shell\nhana-cli createGroup [group]\n[aliases: cg, cGrp]\nCreate an HDI container group\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -g, --group, --Group Container Group Name [string]\n```\n\n### createContainer\n\n```shell\nhana-cli createContainer [container] [group]\n[aliases: cc, cCont]\nCreate an HDI Container and populate connection details into default-env.json\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --container, --Container Container Name [string]\n -g, --group, --Group Container Group Name [string] [default: empty]\n -s, --save, --Save Save Credentials to default-env.json\n [boolean] [default: true]\n -e, --encrypt, --Encrypt, --ssl Encrypt connections (required for SAP HANA\n service for SAP BTP or SAP HANA Cloud)\n [boolean] [default: false]\n```\n\n![createContainer example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/createContainer.gif)\n\n### createContainerUsers\n\n```shell\nhana-cli createContainerUsers [container]\n[aliases: ccu, cContU]\nCreate new HDI Container technical users for an existing container and populates\nconnection details into default-env.json\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --container, --Container Container Name [string]\n -s, --save, --Save Save Credentials to default-env.json\n [boolean] [default: true]\n -e, --encrypt, --Encrypt, --ssl Encrypt connections (required for SAP HANA\n service for SAP BTP or SAP HANA Cloud)\n [boolean] [default: false]\n```\n\n### createJWT\n\n```shell\nhana-cli createJWT [name]\n[aliases: cJWT, cjwt, cJwt]\nCreate JWT Token and Import Certificate (To obtain the certificate and issuer\nused in the SQL you need to use the xsuaa service key credentials.url element\nwhich should look like this:\nhttps://\u003csubdomain\u003e.authentication.\u003cregion\u003e.hana.ondemand.com then add\n/sap/trust/jwt path to it in a browser)\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --name, --Name JWT Provider Name (Any descriptive Value)\n [string]\n -c, --certificate, --Certificate certificate [string]\n -i, --issuer, --Issuer Certificate Issuer [string]\n```\n\n### createModule\n\n```shell\nhana-cli createModule\n[aliases: createDB, createDBModule]\nCreate DB Module\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -f, --folder, --Folder DB Module Folder Name\n [string] [default: \"db\"]\n --hanaCloud, --hc, --hana-cloud, Build Module for SAP HANA Cloud?\n --hanacloud [boolean] [default: true]\n```\n\n### createXSAAdmin\n\n```shell\nhana-cli createXSAAdmin [user] [password]\n[aliases: cXSAAdmin, cXSAA, cxsaadmin, cxsaa]\nCreate an SAP HANA DB User which is also an XSA Admin\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -u, --user, --User User\n -p, --password, --Password Passwordd\n```\n\n![createXSAAdmin example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/createXSAAdmin.gif)\n\n### dataTypes\n\n```shell\nhana-cli dataTypes\n[aliases: dt, datatypes, dataType, datatype]\nList of HANA Data Types and their technical details\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n![dataTypes example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/dataTypes.gif)\n\n### dataTypesUI\n\n```shell\nhana-cli dataTypesUI\n[aliases: dtui, datatypesui, dataTypeUI, datatypeui]\nList of HANA Data Types and their technical details in the browser UI\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n### dataVolumes\n\n```shell\nhana-cli dataVolumes\n[aliases: dv, datavolumes]\nDetails about the HANA Data Volumes\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![dataVolumes example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/dataVolumes.gif)\n\n### disks\n\n```shell\nhana-cli disks\n[aliases: di, Disks]\nDetails about disk devices used by HANA\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![disks example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/disks.gif)\n\n### dropContainer\n\n```shell\nhana-cli dropContainer [container] [group]\n[aliases: dc, dropC]\nDrop HDI container and clean up HDI Container users\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --container, --Container Container Name [string]\n -g, --group, --Group Container Group Name [string] [default: empty]\n```\n\n### dropGroup\n\n```shell\nhana-cli dropGroup [group]\n[aliases: dg, dropG]\nDrop HDI container group\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -g, --group, --Group Container Group Name [string]\n```\n\n### features\n\n```shell\nhana-cli features\n[aliases: fe, Features]\nSAP HANA Features and Version\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![features example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/features.gif)\n\n### featureUsage\n\n```shell\nhana-cli featureUsage\n[aliases: fu, FeaturesUsage]\nUsage Statistics by Feature\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![featureUsage example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/featureUsage.gif)\n\n### functions\n\n```shell\nhana-cli functions [schema] [function]\n[aliases: f, listFuncs, ListFunc, listfuncs, Listfunc, listFunctions,\n listfunctions]\nGet a list of all functions\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -f, --function, --Function Function [string] [default: \"*\"]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n```\n\n![functions example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/functions.gif)\n\n### hdi\n\n```shell\nhana-cli hdi\n[aliases: hdiInstances, hdiinstances, hdiServices, listhdi, hdiservices, hdis]\nList all SAP HANA Cloud HDI service instances in your target Space\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra output\n that is only helpful to human readable interface.\n Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS of\n intermediate details [boolean] [default: false]\nOptions:\n -c, --cf, --cmd Cloud Foundry? [boolean] [default: true]\n```\n\n![hdi example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/hdi.gif)\n\n### hc\n\n```shell\nhana-cli hc [name]\n[aliases: hcInstances, instances, listHC, listhc, hcinstances]\nList all SAP HANA Cloud instances in your target Space\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -n, --name SAP HANA Cloud Instance name [string] [default: \"**default**\"]\n```\n\n![hc example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/hc.gif)\n\n![hc #2 example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/hc_2.gif)\n\n### hcStart\n\n```shell\nhana-cli hcStart [name]\n[aliases: hcstart, hc_start, start]\nStart SAP HANA Cloud instance\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -n, --name SAP HANA Cloud Instance name [string] [default: \"**default**\"]\n```\n\n### hcStop\n\n```shell\nhana-cli hcStop [name]\n[aliases: hcstop, hc_stop, stop]\nStop SAP HANA Cloud instance\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -n, --name SAP HANA Cloud Instance name [string] [default: \"**default**\"]\n```\n\n### hdbsql\n\n```shell\nhana-cli hdbsql\n\nLaunch the hdbsql tool (if installed separately) using the locally persisted\ncredentials default-env*.json\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![hdbsql example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/hdbsql.gif)\n\n### help\n\n```shell\nhana-cli help\nList all Commands and their Aliases\n```\n\n### hostInformation\n\n```shell\nhana-cli hostInformation\n[aliases: hi, HostInformation, hostInfo, hostinfo]\nHost technical details\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![hostInformation example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/hostInformation.gif)\n\n### indexes\n\n```shell\nhana-cli indexes [schema] [indexes]\n[aliases: ind, listIndexes, ListInd, listind, Listind, listfindexes]\nGet a list of indexes\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -i, --indexes, --Indexes Function [string] [default: \"*\"]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n```\n\n![indexes example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/indexes.gif)\n\n### iniContents\n\n```shell\nhana-cli iniContents [file] [section]\n[aliases: if, inifiles, ini]\nContents of INI Configuration (filtered by File Name)\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -f, --file, --File File Name [string] [default: \"*\"]\n -s, --section, --Section Section [string] [default: \"*\"]\n -l, --limit Limit results [number] [default: 200]\n```\n\n![iniContents example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/iniContents.gif)\n\n### iniFiles\n\n```shell\nhana-cli iniFiles\n[aliases: if, inifiles, ini]\nList of INI Configuration Files for SAP HANA\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n![iniFiles example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/iniFiles.gif)\n\n### inspectFunction\n\n```shell\nhana-cli inspectFunction [schema] [function]\n[aliases: if, function, insFunc, inspectfunction]\nReturn metadata about a Function\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -f, --function, --Function Function [string]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"sql\"] [default: \"tbl\"]\n```\n\n![inspectFunction example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/inspectFunction.gif)\n\n### inspectIndex\n\n```shell\nhana-cli inspectIndex [schema] [index]\n[aliases: ii, index, insIndex, inspectindex]\nReturn metadata about an Index\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -i, --index, --Index DB Table Index [string]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n```\n\n![inspectIndex example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/inspectIndex.gif)\n\n### inspectJWT\n\n```shell\nhana-cli inspectJWT\n[aliases: jwt, ijwt, iJWT, iJwt]\nInspect JWT Token Configuration\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n### inspectLibMember\n\n```shell\nhana-cli inspectLibMember [schema] [library] [libraryMem]\n[aliases: ilm, libraryMember, librarymember, insLibMem, inspectlibrarymember]\nReturn metata about a Library Member\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n --library, --lib, --Library Library [string]\n -m, --libraryMem, --libMem, Library Member\n --LibraryMember [string]\n -s, --schema, --Schema schema\n [string] [default: \"**CURRENT_SCHEMA**\"]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"sql\"] [default: \"tbl\"]\n```\n\n![inspectLibMember example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/inspectLibMember.gif)\n\n### inspectLibrary\n\n```shell\nhana-cli inspectLibrary [schema] [library]\n[aliases: il, library, insLib, inspectlibrary]\nReturn metadata about a Library\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n --library, --lib, --Library Library [string]\n -s, --schema, --Schema schema\n [string] [default: \"**CURRENT_SCHEMA**\"]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"sql\"] [default: \"tbl\"]\n```\n\n![inspectLibrary example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/inspectLibrary.gif)\n\n### inspectProcedure\n\n```shell\nhana-cli inspectProcedure [schema] [procedure]\n [aliases: ip, procedure, insProc, inspectprocedure, inspectsp]\nReturn metadata about a Stored Procedure\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -p, --procedure, --Procedure, --sp Stored Procedure [string]\n -s, --schema, --Schema schema\n [string] [default: \"**CURRENT_SCHEMA**\"]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"sql\"] [default: \"tbl\"]\n```\n\n![inspectProcedure example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/inspectProcedure.gif)\n\n### inspectTable\n\n```shell\nhana-cli inspectTable [schema] [table]\n[aliases: it, table, insTbl, inspecttable, inspectable]\nReturn metadata about a DB table\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -t, --table, --Table Database Table [string]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"sql\", \"sqlite\", \"cds\", \"json\", \"yaml\", \"cdl\",\n \"annos\", \"edm\", \"edmx\", \"swgr\", \"openapi\", \"hdbtable\", \"hdbmigrationtable\",\n \"hdbcds\", \"jsdoc\"] [default: \"tbl\"]\n --useHanaTypes, --hana Use SAP HANA-Specific Data Types See (https://cap.\n cloud.sap/docs/cds/cdl#predefined-types)\n [boolean] [default: false]\n --useExists, --exists, --persistence Use Persistence Exists Annotation\n [boolean] [default: true]\n -q, --useQuoted, --quoted, --quotedIdent Use Quoted Identifiers ![non-identif\n ifiers ier] [boolean] [default: false] \n```\n\n![inspectTable example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/inspectTable.gif)\n\n### inspectTrigger\n\n```shell\nhana-cli inspectTrigger [schema] [trigger]\n[aliases: itrig, trigger, insTrig, inspecttrigger, inspectrigger]\nReturn metadata about a Trigger\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -t, --trigger, --Trigger Sequence [string] [default: \"*\"]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"sql\"] [default: \"tbl\"]\n```\n\n### inspectUser\n\n```shell\nhana-cli inspectUser [user]\n[aliases: iu, user, insUser, inspectuser]\nReturn metadata about a User\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -u, --user, --User User [string]\n```\n\n![inspectUser example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/inspectUser.gif)\n\n### inspectView\n\n```shell\nhana-cli inspectView [schema] [view]\n[aliases: iv, view, insVew, inspectview]\nReturn metadata about a DB view\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -v, --view, --View Database View [string]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"tbl\", \"sql\", \"sqlite\", \"cds\", \"json\", \"yaml\", \"cdl\",\n \"annos\", \"edm\", \"edmx\", \"swgr\", \"openapi\", \"hdbview\", \"hdbcds\"] [default:\n \"tbl\"]\n --useHanaTypes, --hana Use SAP HANA-Specific Data Types See (https://cap.\n cloud.sap/docs/cds/cdl#predefined-types)\n [boolean] [default: false]\n --useExists, --exists, --persistence Use Persistence Exists Annotation\n [boolean] [default: true]\n -q, --useQuoted, --quoted, --quotedIdent Use Quoted Identifiers ![non-identif\n ifiers ier] [boolean] [default: false] \n```\n\n### issue\n\n```shell\nReport an Issue with the hana-cli\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra output t\n hat is only helpful to human readable interface. Us\n eful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS of i\n ntermediate details [boolean] [default: false]\n```\n\n### libraries\n\n```shell\nhana-cli libraries [schema] [library]\n[aliases: l, listLibs, ListLibs, listlibs, ListLib, listLibraries,\n listlibraries]\nGet a list of all libraries\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n --library, --lib, --Library Library [string] [default: \"*\"]\n -s, --schema, --Schema schema\n [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n```\n\n![libraries example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/libraries.gif)\n\n### massConvert\n\n```shell\nhana-cli massConvert [schema] [table]\n\nConvert a group of tables to CDS or HDBTable format\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -t, --table, --Table Database Table[string] [default: \"*\"]\n -s, --schema, --Schema schema\n [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n -f, --folder, --Folder DB Module Folder Name\n [string] [default: \"./\"]\n -n, --filename, --Filename File name [string]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"hdbtable\", \"cds\", \"hdbmigrationtable\"] [default: \"cds\"]\n --useHanaTypes, --hana Use SAP HANA-Specific Data Types See\n (https://cap.cloud.sap/docs/cds/cdl#p\n redefined-types)\n [boolean] [default: false]\n --useCatalogPure, --catalog, --pure Use \"Pure\" catalog definitions in a\n massConvert. Will include additional\n metadata such as Associations and\n Merge settings but will also include\n some references that are incompatible\n with HDI [boolean] [default: false]\n --useExists, --exists, --persistence Use Persistence Exists Annotation\n [boolean] [default: true]\n -q, --useQuoted, --quoted, --quotedIdent Use Quoted Identifiers ![non-identif\n ifiers ier] [boolean] [default: false] \n --namespace, --ns CDS namespace [string] [default: \"\"]\n --synonyms Filename to store sysnonyms\n [string] [default: \"\"]\n --keepPath Keep table/view path (with dots)\n [boolean] [default: false]\n --noColons Replace :: in table/view path with\n dot [boolean] [default: false]\n```\n\n### massConvertUI\n\n```shell\nhana-cli massConvertUI [schema] [table]\n\nConvert a group of tables to CDS or HDBTable format via a browser based UI\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -t, --table, --Table Database Table[string] [default: \"*\"]\n -s, --schema, --Schema schema\n [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n -f, --folder, --Folder DB Module Folder Name\n [string] [default: \"./\"]\n -n, --filename, --Filename File name [string]\n -o, --output, --Output Output Format for inspection\n [string] [choices: \"hdbtable\", \"cds\", \"hdbmigrationtable\"] [default: \"cds\"]\n --useHanaTypes, --hana Use SAP HANA-Specific Data Types See\n (https://cap.cloud.sap/docs/cds/cdl#p\n redefined-types)\n [boolean] [default: false]\n --useCatalogPure, --catalog, --pure Use \"Pure\" catalog definitions in a\n massConvert. Will include additional\n metadata such as Associations and\n Merge settings but will also include\n some references that are incompatible\n with HDI [boolean] [default: false]\n --namespace, --ns CDS namespace [string] [default: \"\"]\n --synonyms Filename to store sysnonyms\n [string] [default: \"\"]\n --keepPath Keep table/view path (with dots)\n [boolean] [default: false]\n --noColons Replace :: in table/view path with\n dot [boolean] [default: false]\n```\n![massConvertUI example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/massConvertUI.png)\n\n### massRename\n\n```shell\nhana-cli massRename\n[aliases: mr, massrename, massRN, massrn]\nMass Rename fields based upon a CDS-based massExport file\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n### massUsers\n\n```shell\nhana-cli massUsers [user] [password]\n[aliases: massUser, mUsers, mUser, mu]\nMass Create 50 Developer Users (for workshops)\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -u, --user, --User User\n -p, --password, --Password Password\n```\n\n### matrix\n\n```shell\nhana-cli matrix\n\nBlue or Red Pill?\n```\n\n### objects\n\n```shell\nhana-cli objects [schema] [object]\n[aliases: o, listObjects, listobjects]\nSearch across all object types\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -o, --object, --Object DB Object [string] [default: \"*\"]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n```\n\n![objects example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/objects.gif)\n\n### openbas\n\n```shell\nhana-cli openbas\n\nOpen SAP Business Appplication Studio\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra output t\n hat is only helpful to human readable interface. Us\n eful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS of i\n ntermediate details [boolean] [default: false]\n```\n\n![bas example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/bas.gif)\n### openDBX\n\n```shell\nhana-cli opendbx\n[aliases: open, openDBX, opendb, openDBExplorer, opendbexplorer]\nOpen DB Explorer\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n### ports\n\n```shell\nhana-cli ports\n\nDisplay port assignments for internal SAP HANA services\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n### privilegeError\n\n```shell\nhana-cli privilegeError [guid]\n[aliases: pe, privilegeerror, privilegerror,\n getInsuffficientPrivilegeErrorDetails]\nGet Insufficient Privilege Error Details\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -g, --guid, --error GUID from original error message [string]\n```\n\n![privilegeError example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/privilegeError.gif)\n\n### procedures\n\n```shell\nhana-cli procedures [schema] [procedure]\n[aliases: p, listProcs, ListProc, listprocs, Listproc, listProcedures,\n listprocedures]\nGet a list of all stored procedures\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -p, --procedure, --Procedure Stored Procedure [string] [default: \"*\"]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n```\n\n![procedures example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/procedures.gif)\n\n### querySimple\n\n```shell\nhana-cli querySimple\n[aliases: qs, querysimple]\nExecute single SQL command and output results\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -q, --query, --Query SQL Statement [string]\n -f, --folder, --Folder DB Module Folder Name [string] [default: \"./\"]\n -n, --filename, --Filename File name [string]\n -o, --output, --Output Output Type for Query Results\n [string] [choices: \"table\", \"json\", \"excel\", \"csv\"] [default: \"table\"]\n```\n\n![querySimple example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/querySimple.gif)\n\n### querySimpleUI\n\n```shell\nhana-cli querySimpleUI\n[aliases: qsui, querysimpleui, queryUI, sqlUI]\nExecute single SQL command and output results via HTML UI\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -q, --query, --Query SQL Statement [string]\n -f, --folder, --Folder DB Module Folder Name [string] [default: \"./\"]\n -n, --filename, --Filename File name [string]\n -o, --output, --Output Output Type for Query Results\n [string] [choices: \"table\", \"json\", \"excel\", \"csv\"] [default: \"table\"]\n```\n\n### readMe\n\n```shell\nhana-cli readMe\nDisplay Read Me in CLI\n```\n\n### readMeUI\n\n```shell\nhana-cli readMeUI\nDisplay Read Me in Browser UI\n```\n### readme\n\n```shell\nhana-cli readme\n[aliases: openreadme, openReadme, openReadMe, openHelp, openhelp]\nOpen Readme Documentation in browser\n```\n\n\n### reclaim\n\n```shell\nhana-cli reclaim\n[aliases: re]\nReclaim LOB, Log, and Data Volume space\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n```\n\n### rick\n\n```shell\nhana-cli rick\n\nFor expert users only\n```\n\n### roles\n\n```shell\nhana-cli roles [schema] [role]\n[aliases: tc, traceContents, traceContent, tracecontent]\nGet a list of roles\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -r, --role, --Role Database Role [string] [default: \"*\"]\n -s, --schema, --Schema schema [string] [default: \"**CURRENT_SCHEMA**\"]\n -l, --limit Limit results [number] [default: 200]\n```\n\n![roles example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/roles.gif)\n\n### sbss\n\n```shell\nhana-cli sbss List all SAP HANA Cloud SBSS service\n instances in your target Space\n[aliases: sbssInstances, sbssinstances, sbssServices, listsbss, sbssservices,\n sbsss]\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --cf, --cmd Cloud Foundry? [boolean] [default: true]\n```\n\n### schemas\n\n```shell\nhana-cli schemas [schema]\n[aliases: sch, getSchemas, listSchemas]\nGet a list of all schemas\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -s, --schema, --schemas schema [string] [default: \"*\"]\n -l, --limit Limit results [number] [default: 200]\n --all, --al, --allSchemas Show all schemas regardless of permissions\n [boolean] [default: false]\n```\n\n![schemas example](https://raw.githubusercontent.com/wiki/SAP-samples/hana-developer-cli-tool-example/images/schemas.gif)\n\n### schemasUI\n\n```shell\nhana-cli schemasUI [schema]\n[aliases: schui, getSchemasUI, listSchemasUI, schemasui]\nGet a list of all schemas in the Browser UI\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -s, --schema, --schemas schema [string] [default: \"*\"]\n -l, --limit Limit results [number] [default: 200]\n --all, --al, --allSchemas Show all schemas regardless of permissions\n [boolean] [default: false]\n```\n\n### schemaInstances\n\n```shell\nhana-cli schemaInstances List all SAP HANA Cloud Schema\n service instances in your target\n Space\n [aliases: schemainstances, schemaServices, listschemas, schemaservices]\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --cf, --cmd Cloud Foundry? [boolean] [default: true]\n```\n\n### securestore\n\n```shell\nhana-cli securestore List all SAP HANA Cloud SecureStore\n service instances in your target\n Space\n [aliases: secureStoreInstances, securestoreinstances, secureStoreServices,\n listSecureStore, securestoreservices, securestores]\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -c, --cf, --cmd Cloud Foundry? [boolean] [default: true]\n```\n\n### serviceKey\n\n```shell\nhana-cli serviceKey [instance] [key]\n[aliases: key, servicekey, service-key]\nConnect and write default-env.json via service key\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding output of LOTS\n of intermediate details\n [boolean] [default: false]\n\nOptions:\n -i, --instance, --Instance CF/XS Service Instance Name\n -e, --encrypt, --Encrypt, --ssl Encrypt connections (required for\n SAP HANA service for SAP BTP or SAP\n HANA Cloud)[boolean] [default: true]\n -v, --validate, --Validate, Validate Certificate\n --validateCertificate [boolean] [default: false]\n -c, --cf, --cmd Cloud Foundry?\n [boolean] [default: true]\n -s, --save, --Save Save Credentials to default-env.json\n [boolean] [default: true]\n```\n\n### sequences\n\n```shell\nhana-cli sequences [schema] [sequence]\n[aliases: seq, listSeqs, ListSeqs, listseqs, Listseq, listSequences]\nGet a list of all squences\n\nConnection Parameters:\n -a, --admin, --Admin Connect via admin (default-env-admin.json)\n [boolean] [default: false]\n --conn Connection Filename to override default-env.json\n\nTroubleshooting:\n --disableVerbose, --quiet Disable Verbose output - removes all extra\n output that is only helpful to human readable\n interface. Useful for scripting commands.\n [boolean] [default: false]\n --debug, --Debug Debug hana-cli itself by adding ou","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fhana-developer-cli-tool-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsap-samples%2Fhana-developer-cli-tool-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsap-samples%2Fhana-developer-cli-tool-example/lists"}