CData Cloud offers access to SAP HANA across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to SAP HANA through CData Cloud.
CData Cloud allows you to standardize and configure connections to SAP HANA as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to SAP HANA in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to SAP HANA and configure any necessary connection properties to create a database in CData Cloud
Accessing data from SAP HANA through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to SAP HANA by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Set the following to connect to data:
Once you have provided the connection details, set the following database credentials to authenticate to SAP HANA:
Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:
The following SSOProperties are needed to authenticate to Okta:
The following is an example connection string:
AuthScheme=OKTA;User=username;Password=password;Server=myserver;SSO Properties='SSOLoginUrl=https://cdata-okta.okta.com';
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
The SAP HANA Cloud also supports setting client certificates. Set the following to connect using a client certificate.
Set the following properties:
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are Password. |
| Server | The name of the server running SAP HANA database. |
| Port | The port of the SAP HANA database. |
| Database | The name of the SAP HANA database. |
| User | The SAP HANA user account used to authenticate. |
| Password | The password used to authenticate the user. |
| IncludeSystemObjects | Set IncludeSystemObjects to True to fetch Hana System schema and tables. |
| UseSSL | This field sets whether SSL is enabled. |
| Property | Description |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Schema | The schema of the SAP Hana database. |
| Property | Description |
| SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| SSHAuthMode | The authentication method used when establishing an SSH Tunnel to the service. |
| SSHClientCert | A certificate to be used for authenticating the SSHUser. |
| SSHClientCertPassword | The password of the SSHClientCert key if it has one. |
| SSHClientCertSubject | The subject of the SSH client certificate. |
| SSHClientCertType | The type of SSHClientCert private key. |
| SSHServer | The SSH server. |
| SSHPort | The SSH port. |
| SSHUser | The SSH user. |
| SSHPassword | The SSH password. |
| SSHServerFingerprint | The SSH server fingerprint. |
| UseSSH | Whether to tunnel the SAP HANA connection over SSH. Use SSH. |
| Property | Description |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Property | Description |
| EmptyTimestampIsNull | When enabled, inserts DATE, TIME, SECONDDATE, and TIMESTAMP values as empty strings that are returned as NULLs. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| SessionVariables | A comma-separated list of session variables to set on the current connection. |
| Timeout | A timeout for the provider. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are Password. |
| Server | The name of the server running SAP HANA database. |
| Port | The port of the SAP HANA database. |
| Database | The name of the SAP HANA database. |
| User | The SAP HANA user account used to authenticate. |
| Password | The password used to authenticate the user. |
| IncludeSystemObjects | Set IncludeSystemObjects to True to fetch Hana System schema and tables. |
| UseSSL | This field sets whether SSL is enabled. |
The scheme used for authentication. Accepted entries are Password.
string
"Password"
The scheme used for authentication. Accepted entries are Password.
The name of the server running SAP HANA database.
string
""
Set this property to the name or network address of the SAP HANA database instance.
The name of the SAP HANA database.
string
"SYSTEMDB"
The name of the SAP HANA database running on the specified Server.
The SAP HANA user account used to authenticate.
string
""
Together with Password, this field is used to authenticate against the SAP HANA server.
The password used to authenticate the user.
string
""
The User and Password are together used to authenticate with the server.
Set IncludeSystemObjects to True to fetch Hana System schema and tables.
bool
false
Set `IncludeSystemObjects` to True to fetch Hana System schema and tables. By default, this property is set to False to avoid listing the large number of system tables in the metadata listing.
This field sets whether SSL is enabled.
bool
true
This field sets whether the Cloud will attempt to negotiate TLS/SSL connections to the server. By default, the Cloud checks the server's certificate against the system's trusted certificate store. To specify another certificate, set SSLServerCert.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Schema | The schema of the SAP Hana database. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
The schema of the SAP Hana database.
string
""
The schema of the SAP Hana database.
This section provides a complete list of the SSO properties you can configure in the connection string for this provider.
| Property | Description |
| SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
Additional properties required to connect to the identity provider in a semicolon-separated list.
string
""
Additional properties required to connect to the identity provider in a semicolon-separated list. The following sections provide examples using the Okta provider.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the SSH properties you can configure in the connection string for this provider.
| Property | Description |
| SSHAuthMode | The authentication method used when establishing an SSH Tunnel to the service. |
| SSHClientCert | A certificate to be used for authenticating the SSHUser. |
| SSHClientCertPassword | The password of the SSHClientCert key if it has one. |
| SSHClientCertSubject | The subject of the SSH client certificate. |
| SSHClientCertType | The type of SSHClientCert private key. |
| SSHServer | The SSH server. |
| SSHPort | The SSH port. |
| SSHUser | The SSH user. |
| SSHPassword | The SSH password. |
| SSHServerFingerprint | The SSH server fingerprint. |
| UseSSH | Whether to tunnel the SAP HANA connection over SSH. Use SSH. |
The authentication method used when establishing an SSH Tunnel to the service.
string
"Password"
A certificate to be used for authenticating the SSHUser.
string
""
SSHClientCert must contain a valid private key in order to use public key authentication. A public key is optional, if one is not included then the Cloud generates it from the private key. The Cloud sends the public key to the server and the connection is allowed if the user has authorized the public key.
The SSHClientCertType field specifies the type of the key store specified by SSHClientCert. If the store is password protected, specify the password in SSHClientCertPassword.
Some types of key stores are containers which may include multiple keys. By default the Cloud will select the first key in the store, but you can specify a specific key using SSHClientCertSubject.
The password of the SSHClientCert key if it has one.
string
""
This property is only used when authenticating to SFTP servers with SSHAuthMode set to PublicKey and SSHClientCert set to a private key.
The subject of the SSH client certificate.
string
"*"
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma it must be quoted.
The type of SSHClientCert private key.
string
"PEMKEY_FILE"
This property can take one of the following values:
| Types | Description | Allowed Blob Values |
| MACHINE/USER | Blob values are not supported. | |
| JKSFILE/JKSBLOB | base64-only | |
| PFXFILE/PFXBLOB | A PKCS12-format (.pfx) file. Must contain both a certificate and a private key. | base64-only |
| PEMKEY_FILE/PEMKEY_BLOB | A PEM-format file. Must contain an RSA, DSA, or OPENSSH private key. Can optionally contain a certificate matching the private key. | base64 or plain text. Newlines may be replaced with spaces when providing the blob as text. |
| PPKFILE/PPKBLOB | A PuTTY-format private key created using the puttygen tool. | base64-only |
| XMLFILE/XMLBLOB | An XML key in the format generated by the .NET RSA class: RSA.ToXmlString(true). | base64 or plain text. |
The SSH server.
string
""
The SSH server.
The SSH port.
string
"22"
The SSH port.
The SSH user.
string
""
The SSH user.
The SSH password.
string
""
The SSH password.
The SSH server fingerprint.
string
""
The SSH server fingerprint.
Whether to tunnel the SAP HANA connection over SSH. Use SSH.
bool
false
By default the Cloud will attempt to connect directly to SAP HANA. When this option is enabled, the Cloud will instead establish an SSH connection with the SSHServer and tunnel the connection to SAP HANA through it.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| EmptyTimestampIsNull | When enabled, inserts DATE, TIME, SECONDDATE, and TIMESTAMP values as empty strings that are returned as NULLs. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| SessionVariables | A comma-separated list of session variables to set on the current connection. |
| Timeout | A timeout for the provider. |
When enabled, inserts DATE, TIME, SECONDDATE, and TIMESTAMP values as empty strings that are returned as NULLs.
bool
true
When enabled, inserts DATE, TIME, SECONDDATE, and TIMESTAMP values as empty strings that are returned as NULLs.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
A comma-separated list of session variables to set on the current connection.
string
""
A comma-separated list of session variables to set on the current connection. For example: 'APPLICATION=myapp,var1=value1,var2=value2[,...]'
A timeout for the provider.
int
30
If the Timeout property is set to 0, operations will not time out; instead, they will run until they complete successfully or encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud raises an error condition.