Skip to content

Latest commit

 

History

History
216 lines (128 loc) · 7.04 KB

open-db-tunnel-9e3f90f.md

File metadata and controls

216 lines (128 loc) · 7.04 KB

open-db-tunnel

This command opens a database tunnel to the database system associated with the specified schema or database.

Remember:

SAP Business Technology Platform, Neo environment will sunset on December 31, 2028, subject to terms of customer or partner contracts.

For more information, see SAP Note 3351844.

Tip:

This documentation refers to SAP Business Technology Platform, Neo environment. If you are looking for documentation about other environments, see SAP Business Technology Platform ↗️.

Note:

Make sure that you have installed the required tools correctly.

If you face trouble using this command, please check that your installation is correct.

For more information, see Set Up the Console Client and Using the Console Client.

The command has two modes:

  • Default mode: The tunnel remains open until you explicitly close it by pressing [ENTER] in the command line. It is closed automatically after 24 hours or if the command window is closed.

    neo open-db-tunnel -a <subaccount_technical_name> -h <host> -u <user> -i <ID_or_alias>

  • Background mode: The database tunnel is opened in a separate process. Use the close-db-tunnel command to close the tunnel once you are done, or it is closed automatically after one hour.

    neo open-db-tunnel -a <subaccount_technical_name> -h <host> -u <user> -i <ID_or_alias> --background

Parameters

Required

-a, --account

Subaccount technical name

Type: string (up to 30 characters; lowercase letters and numbers, starting with a letter)

-h, --host

Enter a region host.

Type: URL. For acceptable values see Regions ↗️.

-i, --id

  • SAP ASE database system (ASE): Specify the database ID of an SAP ASE user database.

  • SAP HANA tenant database system (HANAMDC): Specify the database ID of an SAP HANA tenant database.

  • SAP HANA single-container database system (HANAXS): Specify the alias of the database system.

  • Shared SAP HANA database: Specify the schema ID of a schema.

Type: string

--access-token

Identifies a database access permission. The access token and database ID parameters are mutually exclusive.

-p, --password

To protect your password, enter it only when prompted by the console client and not explicitly as a parameter in the properties file or the command line.

Type: string

-u, --user

Use your e-mail, SAP ID, or user name

Type: string

Optional

--background

Opens the tunnel session in a background process

Type: switch, takes no value

--output

Prints information about the tunnel in a special output format.

Acceptable values: 'json'

Type: string

Example

neo open-db-tunnel -a mysubaccount -h us2.hana.ondemand.com -u [email protected] -i mydatabase

Related Information

Accessing Databases Remotely ↗️

Open Database Tunnels ↗️

Connect to SAP HANA Databases via the Eclipse IDE ↗️

Connect to SAP HANA Schemas via the Eclipse IDE (Neon) ↗️

close-db-tunnel

Connect to the Remote SAP ASE Database ↗️

Automating the Use of Database Tunnels ↗️

Machine-Readable Command Output

Connect DB Tools to SAP HANA via Service Channels ↗️