You are on page 1of 63

Contents I

Table of Contents
Part I What's New 1

Part II General Information 2


1 Overview
................................................................................................................................... 2
2 Features
................................................................................................................................... 3
3 Compatibility
................................................................................................................................... 5
4 Requirements
................................................................................................................................... 7
5 Licensing
................................................................................................................................... 7
6 Getting
...................................................................................................................................
Support 10

Part III Using ODBC Driver 12


1 Installation
................................................................................................................................... 12
Window s .......................................................................................................................................................... 12
m acOS .......................................................................................................................................................... 16
Linux .......................................................................................................................................................... 26
2 Connecting
...................................................................................................................................
to ASE 32
3 Connection
...................................................................................................................................
Options 35
4 Secure
...................................................................................................................................
Connections 37
..........................................................................................................................................................
SSL Connection Description 37
..........................................................................................................................................................
SSH Connection Description 39
..........................................................................................................................................................
HTTP Tunneling Description 42
5 Product
...................................................................................................................................
Activation 45
..........................................................................................................................................................
Obtaining Activation Key 45
Activation on..........................................................................................................................................................
Window s 46
Activation on..........................................................................................................................................................
m acOS 50
Activation on..........................................................................................................................................................
Linux 50
Where to See..........................................................................................................................................................
the License Inform ation? 51
6 Supported
...................................................................................................................................
Data Types 53
7 Supported
...................................................................................................................................
ODBC API Functions 53

© 2018 Devart
1 ODBC Driver for ASE

1 What's New

26-Feb-18 New features in ODBC Driver for SAP Sybase


Adaptive Server Enterprise 1.3
Performance of batch operations is significantly improved
The SSHStoragePath connection parameter is added

23-Oct-17 New features in ODBC Driver for SAP Sybase


Adaptive Server Enterprise 1.2
Compatibility with SAS JMP is improved
Compatibility with MS Power Query is improved
OUTER JOIN macros in SQL queries are supported
DateTime macros in SQL queries are supported
Scalar function macros in SQL queries are supported

26-Oct-16 New features in ODBC Driver for SAP Sybase


Adaptive Server Enterprise 1.1
Support for IPv6 protocol is added
Compatibility with MS Visual Studio
Compatibility with MS FoxPro is improved
Compatibility with MapInfo is improved
Compatibility with Libre Office is improved
Compatibility with Qlik is improved
Compatibility with Delphi & C++Builder is improved
MS Access linked tables support is improved

05-Apr-16 New features in ODBC Driver for SAP Sybase


Adaptive Server Enterprise 1.0
First release of ODBC Driver for SAP Sybase Adaptive Server Enterprise
Windows is supported
Linux is supported
macOS is supported

© 2018 Devart
General Information 2

2 General Information

1. Overview
2. Features
3. Compatibility
4. Requirements
5. Licensing
6. Getting Support

2.1 Overview
ODBC Driver for SAP Sybase Adaptive Server Enterprise provides high-performance and
feature-rich connectivity solution for ODBC-based applications to access SAP Sybase
Adaptive Server Enterprise databases from Windows, macOS, Linux - both 32-bit and 64-bit.

Full support for standard ODBC API functions and data types implemented in our driver
makes interaction of your database applications with SAP Sybase Adaptive Server Enterprise
fast, easy and extremely handy.

Direct connection
Database applications based on our solution get an opportunity to establish a connection to
SAP Sybase Adaptive Server Enterprise directly. Direct Connection gives your applications an
unrivaled advantage - connection to SAP Sybase Adaptive Server Enterprise databases
directly via TCP/IP. That improves performance of your applications, their quality, reliability
and especially the deployment process, since there is no need to supply additional client
software together with your application.

© 2018 Devart
3 ODBC Driver for ASE

Compatibility
ODBC Driver for SAP Sybase Adaptive Server Enterprise supports the following versions of
Adaptive Server Enterprise:
SAP Adaptive Server Enterprise 16.0 and higher
Sybase Adaptive Server Enterprise 12.5.4 and higher

2.2 Features

Direct Connection
Database applications based on our solution get an opportunity to establish connection to
ASE directly via TCP/IP. That improves performance of your applications, their quality,
reliability and especially the deployment process, since there is no need to supply additional
client software together with your application.

© 2018 Devart
General Information 4

ODBC Conformance
Our ODBC driver provides full support for common ODBC interface:
ODBC Data Types support
ODBC API Functions support

In addition, we provide support for Advanced Connection String parameters. Thus allowing
any desktop and web applications to connect to ASE from various environments and
platforms, that support ODBC.

Development Platforms Variety


ODBC Driver for SAP Sybase Adaptive Server Enterprise doesn't limit your choice of the
development platform and environment. The driver installations are available for various
operational systems and platforms. The current version supports Windows, macOS, Linux,
both 32-bit and 64-bit. So you can develop both 32-bit and 64-bit cross-platform applications.

DB Compatibility
ODBC Driver for SAP Sybase Adaptive Server Enterprise supports the following versions of
Adaptive Server Enterprise:
SAP Adaptive Server Enterprise 16.0 and higher
Sybase Adaptive Server Enterprise 12.0 and higher

© 2018 Devart
5 ODBC Driver for ASE

High Performance
All our products are designed to help you write high-performance, lightweight data access
layers, therefore they use advanced data access algorithms and techniques of optimization.

Support
Visit our Support page to get instant support from experienced professionals, fast and detailed
responses, user engagement and interaction, frequent builds with bug fixes, and much more.

2.3 Compatibility

ASE Compatibility
ODBC Driver for SAP Sybase Adaptive Server Enterprise supports the following database
servers:

ASE versions Support


SAP Adaptive Server Enterprise 16.0
and higher
Sybase Adaptive Server Enterprise
12.5.4 and higher

Supported Target Platforms

© 2018 Devart
General Information 6

Windows, 32-bit and 64-bit (including Windows Terminal Server)


macOS, 32-bit and 64-bit
Linux, 32-bit and 64-bit

Verified Compatibility With 3rd-Party Data Tools


Microsoft Visual Studio
Server Explorer and ADO.NET ODBC Provider

Microsoft SQL Server Management


Studio
Microsoft SQL Server Integration
Services

Microsoft SQL Server Data Tools

Microsoft Visual FoxPro

Microsoft Office

Embarcadero Delphi & C++Builder


UniDAC, FireDAC, dbGo (ADO), BDE and
dbExpress

EMS SQL Management Studio

Adobe ColdFusion

Open Office

Crystal Reports

QlikView

PHP

Python

Tableau

© 2018 Devart
7 ODBC Driver for ASE

PowerBASIC

SAS JMP

Omnis Studio

2.4 Requirements
The following few requirements must be met in order to use ODBC Driver for SAP Sybase
Adaptive Server Enterprise:
Important condition is that only one ODBC Driver for SAP Sybase Adaptive Server
Enterprise version can be installed on the PC in order to avoid incompatibility.

2.5 Licensing

ODBC Driver License Agreement


--------------------------------------------------

PLEASE READ THIS LICENSE AGREEMENT CAREFULLY. BY INSTALLING OR USING


THIS SOFTWARE,YOU INDICATE ACCEPTANCE OF AND AGREE TO BECOME BOUND
BY THE TERMS AND CONDITIONS OF THIS LICENSE. IF YOU DO NOT AGREE TO THE
TERMS OF THIS LICENSE, DO NOT INSTALL OR USE THIS SOFTWARE AND
PROMPTLY RETURN IT TO DEVART.

INTRODUCTION

This Devart end-user license agreement ("Agreement") is a legal agreement between you
(either an individual person or a single legal entity) and Devart, for the use of the ODBC Driver
software application, demos, intermediate files, printed materials, and online or electronic
documentation contained in this installation file. For the purpose of this Agreement, the
software program(s) and supporting documentation will be referred to as the "Software".

LICENSE

1. GRANT OF LICENSE

The enclosed Software is licensed, not sold. You have the following rights and privileges,

© 2018 Devart
General Information 8

subject to all limitations, restrictions, and policies specified in this Agreement.

1.1. If you are a legally licensed user, depending on the license type specified in the
registration letter you have received from Devart upon purchase of the Software:- the
"Desktop License" allows you to install and use the Software on a single desktop computer,
provided it is accessed by no more than one person at a time, either directly or remotely, for
sole purposes only in accordance with this Agreement. If more than one person can
simultaneously use the computer where you plan to install the product,you must purchase a
Server License. A Desktop License is valid for one single desktop installation;
- the "Server License" allows you to install and use the Software on a single server,provided it
is accessed by more than one person at a time, either directly or remotely.This definition
includes, but is not limited to, Web servers, application servers,batch servers, and desktop
workstations, where more than one concurrent users can access the Software. A Server
License is valid for one single server installation,provided it is used by 1 (one) legal entity in
accordance with this Agreement.

1.2. If you are a legally licensed user of the Software, you are also entitled to:- make one copy
of the Software for archival purposes only, or copy the Software onto the hard disk of your
computer and retain the original for archival purposes;- develop and test Applications with the
Software, subject to the Limitations below.

1.3. You are allowed to use evaluation versions of the Software as specified in the Evaluation
section.

No other rights or privileges are granted in this Agreement.

2. LIMITATIONS

Only legally registered users are licensed to use the Software, subject to all of the conditions
of this Agreement. Usage of the Software is subject to the following restrictions.

2.1. You may not reverse engineer, decompile, or disassemble the Software.

2.2. You may not reproduce or distribute any Software documentation without express written
permission from Devart.

2.3. You may not distribute and sell any portion of the Software integrating it into your
Applications.

© 2018 Devart
9 ODBC Driver for ASE

2.4. You may not transfer, assign, or modify the Software in whole or in part. In particular, the
Software license is non-transferable, and you may not transfer the Software installation
package.

2.5. You may not remove or alter any Devart's copyright, trademark, or other proprietary rights
notice contained in any portion of Devart files.

3. REDISTRIBUTION

The license grants you a non-exclusive right to reproduce any new software
programs(Applications) created using the Software. You cannot distribute the Software
integrated into your Applications. Any Devart's files remain Devart's exclusive property.

4. TRANSFER

You may not transfer the Software to any individual or entity without express written
permission from Devart. In particular, you may not share copies of the Software under
"Desktop License" with other co-developers without obtaining proper license of these copies
for each individual; you may not install the Software under "Server License" more than 1 (one)
server without obtaining proper license of these installations for each server.

5. TERMINATION

Devart may immediately terminate this Agreement without notice or judicial resolution in the
event of any failure to comply with any provision of this Agreement. Upon such termination
you must destroy the Software, all accompanying written materials, and all copies.

6. EVALUATION

Devart may provide evaluation ("Trial") versions of the Software. You may transfer or
distribute Trial versions of the Software as an original installation package only.If the Software
you have obtained is marked as a "Trial" version, you may install and use the Software for a
period of up to 30 calendar days from the date of installation(the "Trial Period"), subject to the
additional restriction that it is used solely for evaluation of the Software and not in conjunction
with the development or deployment of any application in production. You may not use
Applications developed using Trial versions of the Software for any commercial purposes.
Upon expiration of the Trial Period, the Software must be uninstalled, all its copies and all

© 2018 Devart
General Information 10

accompanying written materials must be destroyed.

7. WARRANTY

The Software and documentation are provided "AS IS" without warranty of any kind.Devart
makes no warranties, expressed or implied, including, but not limited to, the implied
warranties of merchantability and fitness for a particular purpose or use.

8. SUBSCRIPTION AND SUPPORT

The Software is sold on a subscription basis. The Software subscription entitles you to
download improvements and enhancement from Devart's web site as they become available,
during the active subscription period. The initial subscription period is one year from the date
of purchase of the license. The subscription is automatically activated upon purchase, and
may be subsequently renewed by Devart, subject to receipt applicable fees. Licensed users
of the Software with an active subscription may request technical assistance with using the
Software over email from the Software development. Devart shall use its reasonable
endeavors to answer queries raised, but does not guarantee that your queries or problems
will be fixed or solved.

Devart reserves the right to cease offering and providing support for legacy IDE versions.

9. COPYRIGHT

The Software is confidential and proprietary copyrighted work of Devart and is protected by
international copyright laws and treaty provisions. You may not remove the copyright notice
from any copy of the Software or any copy of the written materials,accompanying the
Software.

This Agreement contains the total agreement between the two parties and supersedes any
other agreements, written, oral, expressed, or implied.

2.6 Getting Support

This document lists several ways you can find help with using ODBC Driver for SAP Sybase
Adaptive Server Enterprise describes the Priority Support program.

Support Options

© 2018 Devart
11 ODBC Driver for ASE

There are a number of resources for finding help on installing and using ODBC Driver for SAP
Sybase Adaptive Server Enterprise:
You can find out more about ODBC Driver for SAP Sybase Adaptive Server Enterprise
installation or licensing by consulting Installation and License articles of this manual
respectively.
You can get community assistance and technical support on the Community Forum.
You can get advanced technical assistance by ODBC Driver for SAP Sybase Adaptive
Server Enterprise developers through the ODBC Driver for SAP Sybase Adaptive Server
Enterprise Priority Support program.

Subscriptions
The ODBC Driver for SAP Sybase Adaptive Server Enterprise Subscription program is an
annual maintenance and support service for ODBC Driver for SAP Sybase Adaptive Server
Enterprise users.
Users with a valid ODBC Driver for SAP Sybase Adaptive Server Enterprise Subscription get
the following benefits:
Product support through the ODBC Driver for SAP Sybase Adaptive Server Enterprise
Priority Support program
Access to new versions of ODBC Driver for SAP Sybase Adaptive Server Enterprise when
they are released
Access to all ODBC Driver for SAP Sybase Adaptive Server Enterprise updates and bug
fixes
Notifications about new product versions

Priority Support
ODBC Driver for SAP Sybase Adaptive Server Enterprise Priority Support is an advanced
product support service for getting expedited individual assistance with ODBC Driver for SAP
Sybase Adaptive Server Enterprise-related questions from the ODBC Driver for SAP Sybase
Adaptive Server Enterprise developers themselves. Priority Support is carried out over email
and has a two business day response policy. Priority Support is available for users with an
active ODBC Driver for SAP Sybase Adaptive Server Enterprise Subscription.
To get help through the ODBC Driver for SAP Sybase Adaptive Server Enterprise Priority
Support program, please send an email to odbc@devart.com describing the problem you are
having. Make sure to include the following information in your message:

Your ODBC Driver for SAP Sybase Adaptive Server Enterprise Registration number.
Full ODBC Driver for SAP Sybase Adaptive Server Enterprise edition name and version

© 2018 Devart
General Information 12

number. You can find the version number in DLL version information.
Versions of the ASE server and client you are using.
A detailed problem description.
If possible, ODBC Administrator Log, scripts for creating and filling in database objects, and
the application using ODBC Driver for SAP Sybase Adaptive Server Enterprise.

If you have any questions regarding licensing or subscriptions, please see the FAQ or
contact sales@devart.com

3 Using ODBC Driver

1. Installation
2. Connecting to ASE
3. Connection Options
4. Secure Connections
o SSL Connection Description
o SSH Connection Description
o HTTP Tunneling Description
5. Product Activation
6. Supported Data Types
7. Supported ODBC API Functions

3.1 Installation
ODBC Driver for SAP Sybase Adaptive Server Enterprise currently supports such platforms
as: Windows, macOS, Linux, both 32-bit and 64-bit.

See how to install Devart ODBC Driver for SAP Sybase


Adaptive Server Enterprise on:
Windows
macOS
Linux

3.1.1 Windows

Installation on Windows
Important Note:

© 2018 Devart
13 ODBC Driver for ASE

Before installing the ODBC driver, make sure that another version of ODBC Driver for SAP
Sybase Adaptive Server Enterprise is not installed on the PC, since more than one version
cannot be installed simultaneously on one PC.
1. Run the installer executive file. In an explorer it must look like the following:

2. Follow the instructions in the wizard.

3. In case if you already have the specified installation folder on the PC or another Driver

version is installed, you will get a warning. Click Yes to overwrite the old files with the

current installation, but it is recommended to completely uninstall the previous driver

version first, and then install the new one.

© 2018 Devart
Using ODBC Driver 14

4. On the Select Components page you can select whether to install the 64-bit version of the

driver or not. Clear the check box if you need no 64-bit installation. There is also a check

box on this page, that allows you to select whether to install Help and Manual.

5. In the License Information dialog box, you should select the license type and activate the

product. If you have no activation key, you can select Trial and use the driver for evaluation

purposes.

6. If you have an activation key, select the Activation Key option. Copy the activation key from

the registration email or your Customer Portal account and paste it into the Activation Key

edit box.

© 2018 Devart
15 ODBC Driver for ASE

7. If you have the activation key file, click the Load Activation Key button and browse to it.

© 2018 Devart
Using ODBC Driver 16

8. Click Next.

9. Click Install, then Finish.

10.After the installation is completed, you need to configure the driver.

3.1.2 macOS

Prerequisites
ODBC Driver for SAP Sybase Adaptive Server Enterprise works under control of an ODBC
driver manager. ODBC driver manager is not distributed along with our driver and must be
installed separately.
ODBC Driver for SAP Sybase Adaptive Server Enterprise is compatible with 2 ODBC driver
managers:
iODBC
UnixODBC

In case when using other ODBC driver managers, ODBC Driver for SAP Sybase Adaptive

© 2018 Devart
17 ODBC Driver for ASE

Server Enterprise will be installed, but it will require manual modification of configuration files
of these managers.

Installation
To install the driver, you should download the archive containing installation files, unpack and
run installation with root privileges. See the detailed description of these steps below:
1. Download the archive from Devart website. By default, the archive will be downloaded into

the ~/Downloads folder (or the selected one);

2. Run the 'Terminal' program;

3. Navigate to the 'Downloads' folder:

cd ./Users/test/Downloads

4. Unpack devartodbcase-osx.tar:

tar -xf devartodbcase-osx.tar

© 2018 Devart
Using ODBC Driver 18

5. Execute the install.sh script with root user privileges and specify the password:

sudo ./install.sh

© 2018 Devart
19 ODBC Driver for ASE

6. Read the EULA carefully.

© 2018 Devart
Using ODBC Driver 20

7. Agree to the license agreement:

© 2018 Devart
21 ODBC Driver for ASE

8. Select the installation folder for ODBC Driver for SAP Sybase Adaptive Server Enterprise

(or accept the suggested path):

© 2018 Devart
Using ODBC Driver 22

9. Select the used ODBC driver manager (iODBC by default):

© 2018 Devart
23 ODBC Driver for ASE

10.Specify the path (or remain the default: /Library/ODBC) to odbc.ini and odbcinst.ini files.

© 2018 Devart
Using ODBC Driver 24

11.If you have an activation key, you should create a file, for example with the "ase.lic" name

on your computer and paste the activation key into it. Then, specify the path to it in order to

activate the product.

To add/update the ase.lic file to an already installed driver, you need to create/replace this file
in the directory with the installed driver, and save the new activation key to it.

© 2018 Devart
25 ODBC Driver for ASE

Driver is installed successfully.

After the driver is installed, two DSNs with the names DEVART_ASE_x64 and
DEVART_ASE_x86 are created. You can use them to test connection with ASE server, we
will use DEVART_ASE_x64 as a sample. Now perform the following steps:
1. Open the odbc.ini file, the location of which was indicated during the installation. Find the
DEVART_ASE_x64 section and specify the required connection settings:
User ID=<your ASE User Name>
Password=<your ASE password>
Server=<your ASE server address>
Port=<your ASE Port>
Database=<your ASE database name>
2. Run the iODBC Test Command utility and test connection using the following command:
DSN=DEVART_ASE_x64

© 2018 Devart
Using ODBC Driver 26

See also:
Installation on Windows
Installation on Linux

3.1.3 Linux

Prerequisites
ODBC Driver for SAP Sybase Adaptive Server Enterprise works under control of an ODBC
driver manager. ODBC driver manager is not distributed along with our driver and must be
installed separately.
ODBC Driver for SAP Sybase Adaptive Server Enterprise is compatible with 2 ODBC driver
managers:
UnixODBC
iODBC

In case when using other ODBC driver managers, ODBC Driver for SAP Sybase Adaptive
Server Enterprise will be installed, but it will require manual modification of configuration files

© 2018 Devart
27 ODBC Driver for ASE

of these managers.

Installation
To install the driver, you should download the archive containing installation files, unpack and
run installation with root privileges. See the detailed description of these steps below:
1. Download the archive from Devart website. By default the archive will be downloaded into

the ~/Downloads folder (or the selected one);

2. Run the 'Terminal' program;

3. Navigate to the folder with the downloaded archive cd ~/Downloads (if you downloaded the

archive into another folder, you need to specify the path to this folder as the cd command

parameter):

cd ~/Downloads/

4. Unpack devartodbcase-linux.tar:

tar -xf devartodbcase-linux.tar

5. Execute the install.sh script with root user privileges and specify the password:

sudo ./install.sh

6. Read the EULA carefully.

© 2018 Devart
Using ODBC Driver 28

7. Agree to the license agreement:

8. Select the installation folder for ODBC Driver for SAP Sybase Adaptive Server Enterprise

© 2018 Devart
29 ODBC Driver for ASE

(or accept the suggested path):

9. Select the used ODBC driver manager (UnixODBC by default):

© 2018 Devart
Using ODBC Driver 30

10.Specify the path (or remain the default: /etc) to odbc.ini and odbcinst.ini files.

11.If you have an activation key, you should create a file, for example with the "ase.lic" name

on your computer and paste the activation key into it. Then specify the path to it in order to

activate the product.

To add/update the ase.lic file to an already installed driver, you need to create/replace this file
in the directory with the installed driver, and save the new activation key to it.

© 2018 Devart
31 ODBC Driver for ASE

Driver is installed successfully.

After the driver is installed, two DSNs with the names DEVART_ASE_X64 and
DEVART_ASE_X86 are created. You can use them to test connection with ASE server, we
will use DEVART_ASE_X86 as an example. Now perform the following steps:
1. Open the odbc.ini file, the location of which was indicated during the installation. Find the
DEVART_ASE_X86 section and specify the required connection settings:
User ID=<your ASE User Name>
Password=<your ASE password>
Server=<your ASE server address>
Port=<your ASE Port>
Database=<your ASE database name>
2. Run the UnixODBC Test Command utility and test connection using the following
command:
isql -v DEVART_ASE_X86

© 2018 Devart
Using ODBC Driver 32

See also:
Installation on Windows
Installation on MacOS

3.2 Connecting to ASE

1. After the driver is installed, it can be configured. For this, in the Control Panel open
Administrative Tools and find the Data Sources (ODBC) tool:

2. Now you have to add the ODBC Driver for SAP Sybase Adaptive Server Enterprise to the
list of System Data Sources or User Data Sources or File Data Sources using the
ODBC Data Source Administrator dialog.

© 2018 Devart
33 ODBC Driver for ASE

3. For this, click the Add button - the Create New Data Source dialog will appear with a list
of available drivers.

Select ODBC Driver for SAP Sybase Adaptive Server Enterprise and click Finish.

© 2018 Devart
Using ODBC Driver 34

Then you will be suggested to configure the driver.

4. To activate the driver via ODBC Administrator, refer to the Product Activation article for
more details.
5. In the appeared connection dialog, you can set the connection options.

© 2018 Devart
35 ODBC Driver for ASE

6. Then you can click OK and finish configuration or switch to the Advanced settings tab to
specify more detailed Connection String. See the full list of supported connection string
options in the Connection Options article.

3.3 Connection Options

SAP Sybase Adaptive Server Enterprise Connection Options


The following table describes the options that you can include in the connection string for SAP
Sybase Adaptive Server Enterprise:

Option Description
Server Serves to supply the server name for login.
Port Used to specify the port number for the connection. 5000 by default.
User ID Used to supply a unique User ID for login.
Password Used to supply a password for login.
Database Used to set the name of the database
ConnectionTime Used to specify the time in seconds before an attempt to make a
out connection is considered unsuccessful.

© 2018 Devart
Using ODBC Driver 36

Used to specify the version of the Internet Protocol. IPv4 and IPv6 are
IPVersion available. The IPv4 + IPv6 value allows to check for available protocol
versions and use the first available automatically.

Advanced Settings
Option Description
Empty strings as To retrieve metadata, not all parameters according to MSDN can
NULL accept a null value. If NULL, the driver should return an error. But
Allow NULL some 3rd-party tools pass NULL to the parameters. These options
strings should be enabled for compatibility with such tools.
RegionalNumber Enables using local regional settings when converting numbers to
Settings string.
RegionalDateTi Enables using local regional settings when converting dates and
meSettings times to string.
Adaptive Server Enterprise cannot distinguish SQL_CHAR from
SQL_VARCHAR, SQL_WCHAR from SQL_WVARCHAR, and
SQL_BINARY from SQL_VARBINARY on preparing an SQL
statement. It can break compatibility with some third-party tools. So
AllowFixedTypes the driver always returns SQL_VARCHAR instead of SQL_CHAR,
SQL_WVARCHAR instead of SQL_WCHAR, and SQL_VARBINARY
instead of SQL_BINARY in metadata. To change this behavior and
allow returning fixed types in metadata, this parameter should be set
to True.

Example Connection String


DRIVER={Devart ODBC Driver for ASE};User
ID=sa;Server=ASEserver;Data Source=master;Port=5000

See also:
SSL Connection Description
SSH Connection Description
HTTP Tunneling Description

© 2018 Devart
37 ODBC Driver for ASE

3.4 Secure Connections


This section describes the principles of establishing secure connections to ASE using ODBC
Driver for ASE.
SSL Connection Description
SSH Connection Description
HTTP Tunneling Description

3.4.1 SSL Connection Description


SSL (Secure Sockets Layer) is the protocol for secure access to remote computers over
insecure communication channels.
The SSL protocol runs above TCP/IP and below higher-level database protocol. It uses TCP/
IP on behalf of the higher-level protocols, and in the process allows an SSL-enabled server to
authenticate itself to an SSL-enabled client, allows the client to authenticate itself to the
server, and allows both machines to establish an encrypted connection.
These capabilities address fundamental concerns about communication over the Internet and
other TCP/IP networks:
SSL server authentication allows a user to confirm a server's identity. SSL-enabled client
software can use standard techniques of public-key cryptography to check that a server's
certificate and public ID are valid and have been issued by a certificate authority (CA) listed
in the client's list of trusted CAs. This confirmation might be important if the user, for
example, is sending a credit card number over the network and wants to check the
receiving server's identity.
SSL client authentication allows a server to confirm a user's identity. Using the same
techniques as those used for server authentication, SSL-enabled server software can
check that a client's certificate and public ID are valid and have been issued by a certificate
authority (CA) listed in the server's list of trusted CAs. This confirmation might be important
if the server, for example, is a bank sending confidential financial information to a customer
and wants to check the recipient's identity.
An encrypted SSL connection requires all information sent between a client and a server to
be encrypted by the sending software and decrypted by the receiving software, thus
providing a high degree of confidentiality. Confidentiality is important for both parties to any
private transaction. In addition, all data sent over an encrypted SSL connection is protected
with a mechanism for detecting tampering--that is, for automatically determining whether
the data has been altered in transit.

SSL is based on algorithms of asymmetric encryption and digital signature. Consult ASE
Reference Manual for information about Setting up SSL in ASE and Open Client and
Configuring SSL .

© 2018 Devart
Using ODBC Driver 38

Note:
Usage of SSL is more preferable for ASE connections than SSH because of less required
settings and higher performance.

How to connect to ASE using SSL


To use SSL encryption for connection to ASE, the corresponding SSL connection options
should be set:

Using ODBC Data Source Administrator

SSL Options Description


Option Description
Use SSL Enables or disables SSL for connection.
Holds the pathname to the certificate
CA Certificate
authority file.
Certificate Holds the pathname to the certificate file.
Key Holds the pathname to the key file.

© 2018 Devart
39 ODBC Driver for ASE

Example Connection String


User ID=sa;Data Source=master;Port=5000;Use SSL=true;SSL CACert=c:
\cacert.pem;SSL Cert=c:\client-cert.pem;SSL Key=c:\client-key.pem;

3.4.2 SSH Connection Description


ODBC Driver for SAP Sybase Adaptive Server Enterprise allows connection to ASE server
from a local computer using SSH tunneling.
SSH (Secure Shell) is the protocol for secure access to remote computers over insecure
communication channels.
The general chart of computer ties when connecting through the SSH tunnel is presented
below:

This connection method provides secure connection between your application using ODBC
Driver for SAP Sybase Adaptive Server Enterprise and SSH server that can go through
insecure communication channels, like Internet.
Connections between DB server and SSH server are insecure, therefore they should go
through secure communication channels. In the confluent case, DB server and SSH server
can be located on the same computer.
The principle of working of the SSH connections is described below. The SSH server listens
to the specified TCP/IP port. When the client tries to connect to this port, the SSH server
authenticates the client. If the authentication passes, the connection is established. Then the
client should create connections to DB server objects. The client sends an inquiry to establish
necessary connection to SSH server, and the server establishes it.

SSH Configuration using OpenSSH or other third-party


SSH tunnel
The following is the step-by-step sequence of actions for the easiest case of using OpenSSH
for Windows. The detailed description of each command you can see in the documentation

© 2018 Devart
Using ODBC Driver 40

for OpenSSH.
1. Download OpenSSH for Windows from http://sourceforge.net/projects/sshwindows/
2. Install SSH server:
o Choose a machine that will be used as SSH server. It does not have to be the same
machine that is a ASE server, but communication channel between SSH server and
ASE server must be protected
o Using Windows Control Panel create a user and set a password for him. For example,
SSHUser with password SSHPass
o Install Open SSH. It is enough to install only Server components
o Open OpenSSH/bin folder
o Add SSHUser to the list of allowed users:
mkpasswd -l -u SSHUser >> ..\etc\passwd
o Use mkgroup to create a group permissions file
mkgroup -l >> ..\etc\group
o Run OpenSSH service
net start opensshd

Note:
There is no need to install SSH client, since ODBC Driver for SAP Sybase Adaptive Server
Enterprise itself implements SSH client functionality.

About the methods of higher protection (key authentication, etc.) see documentation for
OpenSSH.

How to establish SSH connection to ASE


To establish a SSH connection to ASE, the corresponding connection options have to be set,
like shown below:

Using ODBC Data Source Administrator:

© 2018 Devart
41 ODBC Driver for ASE

SSH Options Description:


Option Description
Use SSH Enables or disables SSH tunneling.
Holds the host name or IP address of the
SSH Host name
SSH server to connect to.
Used to specify the port number for SSH
SSH Port
connection.
SSH User Name Sets the SSH user name for authentication.
Sets the SSH user password for
SSH Password
authentication.

Used to specify the path to the file


containing the SSH Private Key.
SSH Client Key If the authentication by key is used, the user
must have his pair of keys. The public key
should be transferred to the server, while

© 2018 Devart
Using ODBC Driver 42

the private key will be used by the client to


sign data,
that will be used by server to authenticate
the user. The server verifies the specified
user name and Private Key - and if the
Server Key corresponds to this user,
connection may be established.
Used to specify the path to the file that
SSH Server Key
contains SSH Public Key.
Used to specify the path to the directory
SSH StoragePath
where encyption keys are stored.

Example Connection String:


User ID=sa;Data Source=master;Port=5000;Use SSH=true;SSH
Hostname=localhost;SSH Port=22;SSH Username=SSHUser;SSH
Password=SSHPass;SSH Client Key='C:\User\...\PrivateKey.pem';SSH
Server Key='C:\User\...\PublicKey.pem';SSH StoragePath='D:\...';

3.4.3 HTTP Tunneling Description

Connection through HTTP tunnel


Sometimes client machines are shielded by a firewall that does not allow you to connect to
server directly at the specified port. If the firewall allows HTTP connections, you can use
HTTP tunneling based on the PHP script.
An example of the web script tunneling usage can be the following: you have a remote
website, and access to its database through the port of the database server is forbidden. Only
access through HTTP port 80 is allowed, and you need to access the database from a
remote computer, like when using usual direct connection.
To start using HTTP tunneling, you should deploy the Tunneling script. The php script must
be available through the HTTP protocol. You can verify it is accessible for a web. For this
enter the http://www.domain.com/tunnel.php address to a web browser and check the result.
The only requirement to the server is PHP 5 support.
P.S.: tunnel.php is provided along with ODBC Driver for SAP Sybase Adaptive Server
Enterprise. It is available at the driver installation path, in the http folder, by default: C:\Program
Files (x86)\Devart\ODBC\ASE\http\tunnel.php
To connect to the database, you should set connection parameters for usual direct

© 2018 Devart
43 ODBC Driver for ASE

connection and set the following parameters specific for the HTTP tunneling:

Using ODBC Data Source Administrator

HTTP Options Description


Option Description
Use Http Enables or disables HTTP tunneling.
Http Url Holds the url of the tunneling PHP script.
Set these properties if the access to the
Http Username
website folder with the script is available
only for registered users authenticated with
Http Password
user name and password.

Example Connection String


User ID=sa;Server=ASEserver;Data Source=master;Port=5000;Use
Http=true;Url=http://server/tunnel.php;Http Username=HttpUser;Http
Password=HttpPassword;

© 2018 Devart
Using ODBC Driver 44

Connection through proxy and HTTP tunnel


Consider the previous case with one more complication.
HTTP tunneling server is not directly accessible from client machine. For example, the client
can reach the server only through proxy at address 10.0.0.1, which listens on port 3128. In
this case in addition to the HTTP options, you have to setup Proxy options as follows:

Proxy Options Description


Option Description
Holds the host name or IP address of the
Proxy Host Name
proxy server to connect to.
Used to specify the port number for TCP/IP
Proxy Port
connection with proxy server.
Proxy Username Holds the proxy server account name.
Holds the password for the proxy server
Proxy Password
account.

Example Connection String


© 2018 Devart
45 ODBC Driver for ASE

User ID=sa;Data Source=ASEserver;Port=5000;Use


Http=true;Url=http://server/tunnel.php;Proxy
Hostname=10.0.0.1;Proxy Port=3128;Proxy User=ProxyUser;Proxy
Password=ProxyPassword;

Additional information
Technically speaking, there is one more way to tunnel network traffic. The Secure Shell
forwarding, or SSH, can be used for forwarding data. However, main purpose of SSH is traffic
encryption rather than avoiding firewalls or network configuration problems. The SSH
Connection article describes how to use SSH protocol in ODBC Driver for SAP Sybase
Adaptive Server Enterprise.
Keep in mind that traffic tunneling or encryption always increase CPU usage and network
load. It is recommended that you use direct connection whenever possible.

3.5 Product Activation

Obtaining Activation Key


Activation on Windows
Activation on macOS
Activation on Linux
Where to see the license information

3.5.1 Obtaining Activation Key


To obtain a product activation key, follow these instructions:
1. After purchasing the license, you receive a registration email to the email address,
specified when ordering the product.
2. This email contains a Driver Activation Key and Login Credentials for the Customer Portal.
Keep this information secret.
3. You can copy the Activation Key either from the registration email or at the Customer Portal
account.
4. To login to the Customer Portal, use your Username and Password from the registration
email.
5. To obtain your Activation Key, click the View link on the right. You will get the following
dialog box:

© 2018 Devart
Using ODBC Driver 46

6. Copy the Activation Key with the Copy to Clipboard button.

See also:
Activation on Windows
Activation on MacOS
Activation on Linux

3.5.2 Activation on Windows

Driver Activation After Installation


To activate your installed driver using ODBC Administrator, perform the following steps:
1. Run ODBC Administrator.

2. In the System DSN tab click the Add button.

© 2018 Devart
47 ODBC Driver for ASE

3. In the appeared dialog box, select the installed driver, click Finish.

© 2018 Devart
Using ODBC Driver 48

4. In the Driver Configuration dialog box, on the License tab, click the Input Activation Key

button.

© 2018 Devart
49 ODBC Driver for ASE

5. Copy the activation key from the registration email carefully and paste it into the Input

Activation Key edit box.

6. If you have the activation key file, click the Load Key button and browse to it.

7. Click OK.

© 2018 Devart
Using ODBC Driver 50

3.5.3 Activation on macOS

Driver Activation After Installation


In case if you installed the driver as TRIAL and you have an activation key, in order to activate
your driver, perform the following steps:
1. Create a file with the "activation.key" name.

2. Copy the activation key from the registration email or your Customer Portal account and

paste it into the created file.

3. Place the "activation.key" file into the folder where the driver was installed (for Devart

ODBC Driver for SAP Sybase Adaptive Server Enterprise it is /usr/local/devart/odbcase by

default).

See also:
Activation on Windows
Activation on Linux

3.5.4 Activation on Linux

Driver Activation After Installation


In case if you installed the driver as TRIAL and you have an activation key, in order to activate
your driver, perform the following steps:
1. Create a file with the "activation.key" name.

2. Copy the activation key from the registration email or your Customer Portal account and

paste it into the created file.

3. Place the "activation.key" file into the folder where the driver was installed (for Devart

ODBC Driver for SAP Sybase Adaptive Server Enterprise it is /usr/local/devart/odbcase by

default).

See also:
Activation on Windows
Activation on macOS

© 2018 Devart
51 ODBC Driver for ASE

3.5.5 Where to See the License Information?

To see the license information of your installed driver, do the following:


1. In the Control Panel run ODBC Administrator

2. Open the System DSN tab and click the Add button

3. Select the driver and click Finish

© 2018 Devart
Using ODBC Driver 52

4. In the appeared dialogue, select the License tab

© 2018 Devart
53 ODBC Driver for ASE

See also
Product Activation

3.6 Supported Data Types


ODBC Driver for SAP Sybase Adaptive Server Enterprise supports all the ASE data types.
The complete list of ASE data types is available in the ASE documentation.

Data Type Mapping


The following table describes how ODBC data types are mapped to ASE data types.

ASE Data Types ODBC Data Types


Datetime SQL_TYPE_TIMESTAMP
SQL_TIMESTAMP
Smalldatetime SQL_TYPE_TIMESTAMP
SQL_TIMESTAMP
Date SQL_TYPE_DATE SQL_DATE
Time SQL_SS_TIME2
Datetime2 SQL_TYPE_TIMESTAMP
SQL_TIMESTAMP
DatetimeOFFSET SQL_SS_TIMESTAMPOFFSET

3.7 Supported ODBC API Functions

This section summarizes ODBC routines, categorized by functionality.


For the complete ODBC API reference, please refer to the ODBC Programmer's Reference
at http://msdn.microsoft.com/en-us/library/ms714177.aspx.
An application can call SQLGetInfo function to obtain conformance information about ODBC
Driver for SAP Sybase Adaptive Server Enterprise. To obtain information about support for a
specific function in the driver, an application can call SQLGetFunctions.

Important Note:
For backward compatibility, ODBC Driver for SAP Sybase Adaptive Server Enterprise
supports all deprecated functions.

The following tables list ODBC Driver for SAP Sybase Adaptive Server Enterprise calls
grouped by task:

ODBC API Calls for Connecting to a Data Source


© 2018 Devart
Using ODBC Driver 54

Function Name Support Standard Purpose


Obtains an
environment,
SQLAllocHandle ISO 92 connection,
statement, or
descriptor handle.
Connects to a
specific driver by
SQLConnect ISO 92 data source name,
user ID, and
password.
Connects to a
specific driver by
connection string or
requests that the
SQLDriverConnect ODBC
Driver Manager and
driver display
connection dialog
boxes for the user.
Obtains an
environment handle
SQLAllocEnv Deprecated
allocated from
driver.
Obtains a
SQLAllocConnect Deprecated
connection handle

ODBC API Calls for Obtaining Information about a Driver


and Data Source
Function Name Support Standard Purpose
Returns the list of
SQLDataSources ISO 92 available data
sources, handled by

© 2018 Devart
55 ODBC Driver for ASE

the Driver Manager


Returns the list of
installed drivers and
SQLDrivers ODBC their attributes,
handles by Driver
Manager
Returns information
about a specific
SQLGetInfo ISO 92
driver and data
source.
Returns supported
SQLGetFunctions ISO 92
driver functions.
Returns information
SQLGetTypeInfo ISO 92 about supported
data types.

ODBC API Calls for Setting and Retrieving Driver


Attributes
Function Name Support Standard Purpose
Sets a connection
SQLSetConnectAttr ISO 92
attribute.
Returns the value of
SQLGetConnectAttr ISO 92 a connection
attribute.
SQLSetConnectOpti Sets a connection
Deprecated
on option
SQLGetConnectOpt Returns the value of
Deprecated
ion a connection option
Sets an environment
SQLSetEnvAttr ISO 92
attribute.
Returns the value of
SQLGetEnvAttr ISO 92
an environment

© 2018 Devart
Using ODBC Driver 56

attribute.
Sets a statement
SQLSetStmtAttr ISO 92
attribute.
Returns the value of
SQLGetStmtAttr ISO 92 a statement
attribute.
Sets a statement
SQLSetStmtOption Deprecated
option
Returns the value of
SQLGetStmtOption Deprecated
a statement option

ODBC API Calls for Preparing SQL Requests


Function Name Support Standard Purpose
Allocates a
SQLAllocStmt Deprecated
statement handle
Prepares an SQL
SQLPrepare ISO 92 statement for later
execution.
Assigns storage for
SQLBindParameter ODBC a parameter in an
SQL statement.
Returns the cursor
SQLGetCursorNam name associated
ISO 92
e with a statement
handle.
SQLSetCursorNam Specifies a cursor
ISO 92
e name.
Sets options that
SQLSetScrollOption
ODBC control cursor
s
behavior.

ODBC API Calls for Submitting Requests


© 2018 Devart
57 ODBC Driver for ASE

Function Name Support Standard Purpose


Executes a
SQLExecute ISO 92
prepared statement.
Executes a
SQLExecDirect ISO 92
statement
Returns the text of an
SQL statement as
SQLNativeSql ODBC
translated by the
driver.
Returns the
description for a
SQLDescribeParam ODBC
specific parameter
in a statement.
Returns the number
SQLNumParams ISO 92 of parameters in a
statement.
Used in conjunction
with SQLPutData to
supply parameter
SQLParamData ISO 92
data at execution
time. (Useful for long
data values.)
Sends part or all of a
data value for a
SQLPutData ISO 92
parameter. (Useful
for long data values.)

ODBC API Calls for Retrieving Results and Information


about Results
Function Name Support Standard Purpose
Returns the number
SQLRowCount ISO 92
of rows affected by

© 2018 Devart
Using ODBC Driver 58

an insert, update, or
delete request.
Returns the number
SQLNumResultCols ISO 92 of columns in the
result set.
Describes a column
SQLDescribeCol ISO 92
in the result set.
Describes attributes
SQLColAttribute ISO 92 of a column in the
result set.
Describes attributes
SQLColAttributes Deprecated of a column in the
result set.
Returns multiple
SQLFetch ISO 92
result rows.
Returns scrollable
SQLFetchScroll ISO 92
result rows.
Returns scrollable
SQLExtendedFetch Deprecated
result rows.
Positions a cursor
within a fetched
block of data and
enables an
SQLSetPos ODBC application to
refresh data in the
rowset or to update
or delete data in the
result set.

Performs bulk
insertions and bulk
SQLBulkOperations ODBC
bookmark
operations, including

© 2018 Devart
59 ODBC Driver for ASE

update, delete, and


fetch by bookmark.

ODBC API Calls for Retrieving Error or Diagnostic


Information
Function Name Support Standard Purpose
Returns additional
SQLError Deprecated error or status
information
Returns additional
diagnostic
information (a single
SQLGetDiagField ISO 92
field of the
diagnostic data
structure).
Returns additional
diagnostic
information (multiple
SQLGetDiagRec ISO 92
fields of the
diagnostic data
structure).

ODBC API Calls for Obtaining Information about the


Data Source's System Tables (Catalog Functions) Item
Function Name Support Standard Purpose
Returns a list of
columns and
SQLColumnPrivileg
ODBC associated
es
privileges for one or
more tables.
Returns the list of
SQLColumns X/Open
column names in

© 2018 Devart
Using ODBC Driver 60

specified tables.
Returns a list of
column names that
SQLForeignKeys ODBC make up foreign
keys, if they exist for
a specified table.
Returns the list of
column names that
SQLPrimaryKeys ODBC
make up the primary
key for a table.
Returns information
about the optimal set
of columns that
uniquely identifies a
row in a specified
SQLSpecialColumn table, or the columns
X/Open
s that are
automatically
updated when any
value in the row is
updated by a
transaction.
Returns statistics
about a single table
SQLStatistics ISO 92 and the list of
indexes associated
with the table.
Returns a list of
tables and the
SQLTablePrivileges ODBC privileges
associated with
each table.

© 2018 Devart
61 ODBC Driver for ASE

Returns the list of


table names stored
SQLTables X/Open
in a specific data
source.

ODBC API Calls for Performing Transactions


Function Name Support Standard Purpose
Commits or rolls
SQLTransact Deprecated
back a transaction
Commits or rolls
SQLEndTran ISO 92
back a transaction.

ODBC API Calls for Terminating a Statement


Function Name Support Standard Purpose
Ends statement
processing,
discards pending
results, and,
SQLFreeStmt ISO 92
optionally, frees all
resources
associated with the
statement handle.
Closes a cursor that
SQLCloseCursor ISO 92 has been opened on
a statement handle.
Cancels an SQL
SQLCancel ISO 92
statement.

ODBC API Calls for Terminating a Connection


Function Name Support Standard Purpose
SQLDisconnect ISO 92 Closes the

© 2018 Devart
Using ODBC Driver 62

connection.
Releases an
environment,
SQLFreeHandle ISO 92 connection,
statement, or
descriptor handle.
Releases
SQLFreeConnect Deprecated
connection handle.
Releases an
SQLFreeEnv Deprecated
environment handle.

© 2018 Devart