part i what's new 1 part ii general information 1 devart odbc driver for sugarcrm © 2015-2016...

32
I Contents I © 2015-2016 Devart Table of Contents Part I What's New 1 Part II General Information 1 ................................................................................................................................... 1 1 Overview ................................................................................................................................... 2 Features ................................................................................................................................... 4 3 Compatibility ................................................................................................................................... 5 Requirements ................................................................................................................................... 5 5 Licensing ................................................................................................................................... 8 6 Getting Support Part III Using ODBC Driver 9 ................................................................................................................................... 9 1 Installation .......................................................................................................................................................... 9 Windows ................................................................................................................................... 12 2 Product Registration .......................................................................................................................................................... 12 Driver Activation During Installation .......................................................................................................................................................... 13 Driver Activation After Installation .......................................................................................................................................................... 15 Where to See the License Information? ................................................................................................................................... 18 3 Driver Configuration ................................................................................................................................... 20 4 Connection Options ................................................................................................................................... 21 5 Supported Data Types ................................................................................................................................... 22 6 Supported ODBC API Functions Index 0

Upload: truongminh

Post on 12-Jun-2018

215 views

Category:

Documents


0 download

TRANSCRIPT

IContents

I

© 2015-2016 Devart

Table of ContentsPart I What's New 1

Part II General Information 1

................................................................................................................................... 11 Overview

................................................................................................................................... 22 Features

................................................................................................................................... 43 Compatibility

................................................................................................................................... 54 Requirements

................................................................................................................................... 55 Licensing

................................................................................................................................... 86 Getting Support

Part III Using ODBC Driver 9

................................................................................................................................... 91 Installation

.......................................................................................................................................................... 9Windows

................................................................................................................................... 122 Product Registration

.......................................................................................................................................................... 12Driver Activation During Installation

.......................................................................................................................................................... 13Driver Activation After Installation

.......................................................................................................................................................... 15Where to See the License Information?

................................................................................................................................... 183 Driver Configuration

................................................................................................................................... 204 Connection Options

................................................................................................................................... 215 Supported Data Types

................................................................................................................................... 226 Supported ODBC API Functions

Index 0

Devart ODBC Driver for SugarCRM1

© 2015-2016 Devart

1 What's New

08-Jul-16 New features in ODBC Driver for SugarCRM 1.0First release of ODBC Driver for SugarCRM CRM:

Windows 32-bit is supported

Windows 64-bit is supported

2 General Information

1. Overview

2. Features

3. Compatibility

4. Requirements

5. Licensing

6. Getting Support

2.1 Overview

Devart Devart ODBC Driver for SugarCRM provides high-performance and feature-rich connectivitysolution for ODBC-based applications to access SugarCRM databases from Windows 32-bit and 64-bit.

Full support for standard ODBC API functions and data types implemented in our driver makesinteraction of your database applications with SugarCRM CRM fast, easy and extremely handy.

Connection to SugarCRMDatabase applications based on our solution get an opportunity to establish connection to SugarCRMCRM directly via HTTP. That improves performance of your applications, their quality, reliability andespecially the deployment process, since there is no need to supply additional client softwaretogether with your application.

General Information 2

© 2015-2016 Devart

2.2 Features

Connection to SugarCRMOur driver provides capabilities to establishconnections to SugarCRM cloud databasesdirectly via HTTP. If you have no ability toaccess SugarCRM via HTTP, you can alsoconnect using Proxy options: Host, Port,Username, Password.

Extended SQL SyntaxOur ODBC driver provides an unrivalledopportunity to work with SugarCRM objectsjust as with SQL tables. The extended SQLsyntax allows you to use all the SQLbenefits in SQL-92 compatible SELECTstatements:

Complex JOINs

WHERE conditions

Subqueries

GROUP statements

Aggregation functions

ORDER statements

etc.

DML Operations Bulk Updates

Devart ODBC Driver for SugarCRM3

© 2015-2016 Devart

Devart ODBC Driver for SugarCRM providessupport for DML:

INSERT

UPDATE

DELETE

which allows you to modify data inSugarCRM CRM the same way as in SQLdatabases.

Moreover, with our driver you can performbulk updates to SugarCRM by combiningSQL statements into batches, thussimplifying and speeding up large datamodification with SugarCRM.

ODBC ConformanceThe driver provides full support for commonODBC interface:

ODBC API Functions support

ODBC Data Types support

In addition, we provide support for AdvancedConnection String parameters. Thusallowing any desktop and web applicationsto connect to SugarCRM from variousenvironments and platforms, that supportODBC.

SugarCRM CompatibilityOur ODBC driver fully supports all datatypes defined in the SugarCRM API.

Moreover, the driver is compatible with theSugarCRM API itself.

Advanced Data ConversionWe have implemented advanced DataConversion mechanisms that provide bi-directional mapping between any SugarCRMand ODBC data types.

IntegrationThe driver is compatible with 3rd-party dataanalysis tools, such as Microsoft Excel,and integrates with various IDEs andsystems like Visual Studio, etc.

For the complete list of compatible toolsand environments visit the Compatibilitypage.

Platforms VarietyDevart ODBC Driver for SugarCRM can beused with 32-bit and 64-bit applications onboth x32 and x64 platforms, so there is noneed to additionally configure the driver,applications or environment.

Fully Unicode DriverWith our fully Unicode driver, you canretrieve and work with any data from multi-lingual SugarCRM databases correctly, notdepending on whether its charset is Latin,Cyrillic, Hebrew, Chinese, etc., in any

General Information 4

© 2015-2016 Devart

environment localization.

High PerformanceEvery operation with SugarCRM becomessignificantly faster using such capabilities ofour driver as Local data caching, connectionpooling, query optimization and much more.

SupportVisit our Support page to get instant supportfrom experienced professionals, fast anddetailed responses, user engagement andinteraction, frequent builds with bug fixes,and much more.

2.3 Compatibility

SugarCRM CRM Compatibility

SugarCRM API

SugarCRM Data Types

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

Verified Compatibility With 3rd-Party Data Tools

Microsoft Visual Studio

Microsoft SQL Server Management Studio

Microsoft SQL Server Integration Services

Microsoft SQL Server Data Tools

Microsoft Office

Microsoft Visual FoxPro

Devart ODBC Driver for SugarCRM5

© 2015-2016 Devart

Crystal Reports

ClikView

PHP

Python

2.4 Requirements

Important condition is that only one Devart ODBC Driver for SugarCRM version can be installed onthe PC in order to avoid incompatibility.

.Net Framework 4.5

2.5 Licensing

ODBC Driver License Agreement

Copyright 2015, Devart. All Rights Reserved

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

PLEASE READ THIS LICENSE AGREEMENT CAREFULLY. BY INSTALLING OR USING THISSOFTWARE,YOU INDICATE ACCEPTANCE OF AND AGREE TO BECOME BOUND BY THETERMS AND CONDITIONS OF THIS LICENSE. IF YOU DO NOT AGREE TO THE TERMS OF THISLICENSE, DO NOT INSTALL OR USE THIS SOFTWARE AND PROMPTLY RETURN IT TODEVART.

INTRODUCTION

This Devart end-user license agreement ("Agreement") is a legal agreement between you (either anindividual person or a single legal entity) and Devart, for the use of the ODBC Driver softwareapplication, demos, intermediate files, printed materials, and online or electronic documentationcontained in this installation file. For the purpose of this Agreement, the software program(s) andsupporting 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, subject toall limitations, restrictions, and policies specified in this Agreement.

General Information 6

© 2015-2016 Devart

1.1. If you are a legally licensed user, depending on the license type specified in the registration letteryou have received from Devart upon purchase of the Software:- the "Desktop License" allows you toinstall and use the Software on a single desktop computer, provided it is accessed by no more thanone person at a time, either directly or remotely, for sole purposes only in accordance with thisAgreement. If more than one person can simultaneously use the computer where you plan to installthe product,you must purchase a Server License. A Desktop License is valid for one single desktopinstallation;

- the "Server License" allows you to install and use the Software on a single server,provided it isaccessed by more than one person at a time, either directly or remotely.This definition includes, butis not limited to, Web servers, application servers,batch servers, and desktop workstations, wheremore than one concurrent users can access the Software. A Server License is valid for one singleserver 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 theSoftware for archival purposes only, or copy the Software onto the hard disk of your computer andretain the original for archival purposes;- develop and test Applications with the Software, subject tothe 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 thisAgreement. 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 writtenpermission from Devart.

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

2.4. You may not transfer, assign, or modify the Software in whole or in part. In particular, theSoftware 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 noticecontained in any portion of Devart files.

3. REDISTRIBUTION

The license grants you a non-exclusive right to reproduce any new software programs(Applications)

Devart ODBC Driver for SugarCRM7

© 2015-2016 Devart

created using the Software. You cannot distribute the Software integrated into your Applications. AnyDevart's files remain Devart's exclusive property.

4. TRANSFER

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

5. TERMINATION

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

6. EVALUATION

Devart may provide evaluation ("Trial") versions of the Software. You may transfer or distribute Trialversions of the Software as an original installation package only.If the Software you have obtained ismarked as a "Trial" version, you may install and use the Software for a period of up to 30 calendardays from the date of installation(the "Trial Period"), subject to the additional restriction that it is usedsolely for evaluation of the Software and not in conjunction with the development or deployment of anyapplication in production. You may not use Applications developed using Trial versions of theSoftware for any commercial purposes. Upon expiration of the Trial Period, the Software must beuninstalled, all its copies and all accompanying written materials must be destroyed.

7. WARRANTY

The Software and documentation are provided "AS IS" without warranty of any kind.Devart makes nowarranties, expressed or implied, including, but not limited to, the implied warranties ofmerchantability 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 downloadimprovements and enhancement from Devart's web site as they become available, during the activesubscription period. The initial subscription period is one year from the date of purchase of thelicense. The subscription is automatically activated upon purchase, and may be subsequentlyrenewed by Devart, subject to receipt applicable fees. Licensed users of the Software with an activesubscription may request technical assistance with using the Software over email from the Softwaredevelopment. Devart shall use its reasonable endeavors to answer queries raised, but does notguarantee that your queries or problems will be fixed or solved.

General Information 8

© 2015-2016 Devart

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 byinternational copyright laws and treaty provisions. You may not remove the copyright notice from anycopy 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 otheragreements, written, oral, expressed, or implied.

2.6 Getting Support

This document lists several ways you can find help with using Devart ODBC Driver for SugarCRMdescribes the Priority Support program.

Support OptionsThere are a number of resources for finding help on installing and using Devart ODBC Driver forSugarCRM:

You can find out more about Devart ODBC Driver for SugarCRM installation or licensing byconsulting 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 Devart ODBC Driver for SugarCRM developersthrough the Devart ODBC Driver for SugarCRM Priority Support program.

SubscriptionsThe Devart ODBC Driver for SugarCRM Subscription program is an annual maintenance and supportservice for Devart ODBC Driver for SugarCRM users.

Users with a valid Devart ODBC Driver for SugarCRM Subscription get the following benefits:

Product support through the Devart ODBC Driver for SugarCRM Priority Support program

Access to new versions of Devart ODBC Driver for SugarCRM when they are released

Access to all Devart ODBC Driver for SugarCRM updates and bug fixes

Notifications about new product versions

Priority SupportDevart ODBC Driver for SugarCRM Priority Support is an advanced product support service for gettingexpedited individual assistance with Devart ODBC Driver for SugarCRM-related questions from theDevart ODBC Driver for SugarCRM developers themselves. Priority Support is carried out over emailand has a two business day response policy. Priority Support is available for users with an activeDevart ODBC Driver for SugarCRM Subscription.

To get help through the Devart ODBC Driver for SugarCRM Priority Support program, please send anemail to [email protected] describing the problem you are having. Make sure to include the followinginformation in your message:

Devart ODBC Driver for SugarCRM9

© 2015-2016 Devart

Your Devart ODBC Driver for SugarCRM Registration number.

Full Devart ODBC Driver for SugarCRM edition name and version number. You can find the versionnumber in DLL version information.

Versions of the SugarCRM server and client you are using.

A detailed problem description.

If possible, ODBC Administrator Log, scripts for creating and filling in database objects, and theapplication using Devart ODBC Driver for SugarCRM.

If you have any questions regarding licensing or subscriptions, please see the FAQ or contact [email protected]

3 Using ODBC Driver

1. Installation

2. Driver Configuration

3. Connection Options

4. Supported Data Types

5. Supported ODBC API Functions

3.1 Installation

Devart ODBC Driver for SugarCRM currently supports such platforms as: Windows, both 32-bit and64-bit.

See how to install Devart ODBC Driver for SugarCRM on:

Windows

3.1.1 Windows

Devart Devart ODBC Driver for SugarCRM currently supports such platforms as: Windows 32-bit and64-bit.

Installation on Windows

Important Note

Before installing the ODBC driver, make sure that another version of Devart ODBC Driver forSugarCRM is not installed on the PC, since more than one version cannot be installedsimultaneously on one PC.

1. Run the installer executive file. In an explorer it must look like the following:

where XX is the driver version.

Using ODBC Driver 10

© 2015-2016 Devart

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 isinstalled, you will get a warning. Click Yes to overwrite the old files with the current installation, butit is recommended to completely uninstall the previous driver version first, and then install the newone.

4. On the Select Components page you can select whether to install the 64-bit version of the driver ornot. 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.

Devart ODBC Driver for SugarCRM11

© 2015-2016 Devart

5. On the License Information page, you should select the license type and activate the product.

Using ODBC Driver 12

© 2015-2016 Devart

Read the Product Registration article for more details about this step. Click Next.

6. Click Install. Click Finish.

7. Then you need to configure the driver.

3.2 Product Registration

Driver Activation During Installation

Driver Activation After Installation

3.2.1 Driver Activation During Installation

To activate your driver during installation, run ODBC Driver installer. Follow the steps:

1. On the License Information page, select Licensed Key option.

2. Copy the license key from the registration email carefully and paste it to the Licensed key editbox.

3. If you have the license key file, click the Load License button and browse to the license file.

Devart ODBC Driver for SugarCRM13

© 2015-2016 Devart

4. Click Next.

5. Click Install.

3.2.2 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.

Using ODBC Driver 14

© 2015-2016 Devart

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

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

Devart ODBC Driver for SugarCRM15

© 2015-2016 Devart

5. Copy the license key from the registration email carefully and paste it to the Input Licensed Keyedit box.

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

7. Click OK.

3.2.3 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

Using ODBC Driver 16

© 2015-2016 Devart

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

3. Select the driver and click Finish

Devart ODBC Driver for SugarCRM17

© 2015-2016 Devart

4. In the appeared dialogue, select the License tab

See also

Using ODBC Driver 18

© 2015-2016 Devart

Product Registration

3.3 Driver Configuration

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

2. Now you have to add the Devart ODBC Driver for SugarCRM to the list of System Data Sources orUser Data Sources or File Data Sources using the ODBC Data Source Administrator dialog.

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

Select Devart ODBC Driver for SugarCRM and click Finish.

Devart ODBC Driver for SugarCRM19

© 2015-2016 Devart

Then you will be suggested to configure the driver.

4. To activate the driver via ODBC Administrator, refer to the Product Registration article for moredetails.

5. In the appeared connection dialog, you can set the connection options.

Using ODBC Driver 20

© 2015-2016 Devart

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

3.4 Connection Options

The following table describes the options that you can include in the connection string:

Option Description

Server The server address to connect to.

logonUsed to supply a unique User ID for connect to a Sugar CRMaccount.

Password Used to supply a password for logging in to Sugar CRM.

Proxy HostIf you are using Proxy for connection to your network, specify theProxy server address in this option. To learn your Proxy serveraddress, open Internet Explorer->Settings->Internet

Devart ODBC Driver for SugarCRM21

© 2015-2016 Devart

Options->Connections->LAN settings.

ProxyPortSpecify the Proxy port here. You can learn Proxy Port in the sameway as described above for the host.

Proxy UIDIf Proxy User authorization is used, specify Proxy user name (ID) inthis option.

Proxy PWDIf Proxy User authorization is used, specify Proxy user password inthis option.

Sample connection string

URL: https://example.com.sugaropencloud.eu;logon: admin;Admin user password:********

3.5 Supported Data Types

Devart ODBC Driver for SugarCRM supports all the SugarCRM data types.

The complete list of SugarCRM data types is available in the SugarCRM documentation.

Data Type MappingThe following table describes how ODBC data types are mapped to SugarCRM data types.

SugarCRM Data Types ODBC Data Types

BINARY SQL_VARBINARY

STRING

SQL_VARCHAR

SQL_LONGVARCHAR

SQL_WVARCHAR

SQL_WLONGVARCHAR

BOOLEAN SQL_BIT

Using ODBC Driver 22

© 2015-2016 Devart

BYTE SQL_TINYINT

INTEGER

SQL_INTEGER

SQL_SMALLINT

DOUBLE

SQL_FLOAT

SQL_DOUBLE

TIME SQL_TYPE_TIME

DATE SQL_TYPE_DATE

DATETIME SQL_TYPE_TIMESTAMP

3.6 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 Devart ODBCDriver for SugarCRM. To obtain information about support for a specific function in the driver, anapplication can call SQLGetFunctions.

Important Note

For backward compatibility, Devart ODBC Driver for SugarCRM supports all deprecatedfunctions.

The following tables list Devart ODBC Driver for SugarCRM calls grouped by task:

ODBC API Calls for Connecting to a Data Source

FunctionName

Support

Standard

Purpose

Devart ODBC Driver for SugarCRM23

© 2015-2016 Devart

SQLAllocHandle

ISO92

Obtains an environment, connection, statement, ordescriptor handle.

SQLConnect

ISO92

Connects to a specific driver by data source name,user ID, and password.

SQLDriverConnect

ODBC

Connects to a specific driver by connection string orrequests that the Driver Manager and driver displayconnection dialog boxes for the user.

SQLAllocEnv

Deprecated

Obtains an environment handle allocated from driver.

SQLAllocConnect

Deprecated

Obtains a connection handle

ODBC API Calls for Obtaining Information about a Driver andData Source

FunctionName

Support

Standard

Purpose

SQLDataSources

ISO92

Returns the list of available data sources, handled bythe Driver Manager

SQLDrivers

ODBC

Returns the list of installed drivers and theirattributes, handles by Driver Manager

SQLGetInfo

ISO92

Returns information about a specific driver and datasource.

SQLGetFunctio

ISO92

Returns supported driver functions.

Using ODBC Driver 24

© 2015-2016 Devart

ns

SQLGetTypeInfo

ISO92

Returns information about supported data types.

ODBC API Calls for Setting and Retrieving Driver Attributes

FunctionName

Support

Standard

Purpose

SQLSetConnectAttr

ISO92

Sets a connection attribute.

SQLGetConnectAttr

ISO92

Returns the value of a connection attribute.

SQLSetConnectOption

Deprecated

Sets a connection option

SQLGetConnectOption

Deprecated

Returns the value of a connection option

SQLSetEnvAttr

ISO92

Sets an environment attribute.

SQLGetEnvAttr

ISO92

Returns the value of an environment attribute.

SQLSet IS Sets a statement attribute.

Devart ODBC Driver for SugarCRM25

© 2015-2016 Devart

StmtAttr

O92

SQLGetStmtAttr

ISO92

Returns the value of a statement attribute.

SQLSetStmtOption

Deprecated

Sets a statement option

SQLGetStmtOption

Deprecated

Returns the value of a statement option

ODBC API Calls for Preparing SQL Requests

FunctionName

Support

Standard

Purpose

SQLAllocStmt

Deprecated

Allocates a statement handle

SQLPrepare

ISO92

Prepares an SQL statement for later execution.

SQLBindParameter

ODBC

Assigns storage for a parameter in an SQLstatement.

SQLGetCursorName

ISO92

Returns the cursor name associated with astatement handle.

Using ODBC Driver 26

© 2015-2016 Devart

SQLSetCursorName

ISO92

Specifies a cursor name.

SQLSetScrollOptions

ODBC

Sets options that control cursor behavior.

ODBC API Calls for Submitting Requests

FunctionName

Support

Standard

Purpose

SQLExecute

ISO92

Executes a prepared statement.

SQLExecDirect

ISO92

Executes a statement

SQLNativeSql

ODBC

Returns the text of an SQL statement as translatedby the driver.

SQLDescribeParam

ODBC

Returns the description for a specific parameter in astatement.

SQLNumParams

ISO92

Returns the number of parameters in a statement.

SQLParamData

ISO92

Used in conjunction with SQLPutData to supplyparameter data at execution time. (Useful for longdata values.)

SQLPutData

ISO92

Sends part or all of a data value for a parameter.(Useful for long data values.)

Devart ODBC Driver for SugarCRM27

© 2015-2016 Devart

ODBC API Calls for Retrieving Results and Information aboutResults

FunctionName

Support

Standard

Purpose

SQLRowCount

ISO92

Returns the number of rows affected by an insert,update, or delete request.

SQLNumResultCols

ISO92

Returns the number of columns in the result set.

SQLDescribeCol

ISO92

Describes a column in the result set.

SQLColAttribute

ISO92

Describes attributes of a column in the result set.

SQLColAttributes

Deprecated

Describes attributes of a column in the result set.

SQLFetch

ISO92

Returns multiple result rows.

SQLFetchScroll

ISO92

Returns scrollable result rows.

SQLExtendedFetch

Deprecated

Returns scrollable result rows.

SQLSetPos

ODBC

Positions a cursor within a fetched block of data andenables an application to refresh data in the rowset or

Using ODBC Driver 28

© 2015-2016 Devart

to update or delete data in the result set.

SQLBulkOperations

ODBC

Performs bulk insertions and bulk bookmarkoperations, including update, delete, and fetch bybookmark.

ODBC API Calls for Retrieving Error or Diagnostic Information

FunctionName

Support

Standard

Purpose

SQLError

Deprecated

Returns additional error or status information

SQLGetDiagField

ISO92

Returns additional diagnostic information (a singlefield of the diagnostic data structure).

SQLGetDiagRec

ISO92

Returns additional diagnostic information (multiplefields of the diagnostic data structure).

ODBC API Calls for Obtaining Information about the DataSource's System Tables (Catalog Functions) Item

FunctionName

Support

Standard

Purpose

SQLColumnPrivileges

ODBC

Returns a list of columns and associated privilegesfor one or more tables.

Devart ODBC Driver for SugarCRM29

© 2015-2016 Devart

SQLColumns

X/Open

Returns the list of column names in specified tables.

SQLForeignKeys

ODBC

Returns a list of column names that make up foreignkeys, if they exist for a specified table.

SQLPrimaryKeys

ODBC

Returns the list of column names that make up theprimary key for a table.

SQLSpecialColumns

X/Open

Returns information about the optimal set of columnsthat uniquely identifies a row in a specified table, orthe columns that are automatically updated when anyvalue in the row is updated by a transaction.

SQLStatistics

ISO92

Returns statistics about a single table and the list ofindexes associated with the table.

SQLTablePrivileges

ODBC

Returns a list of tables and the privileges associatedwith each table.

SQLTables

X/Open

Returns the list of table names stored in a specificdata source.

ODBC API Calls for Performing Transactions

FunctionName

Support

Standard

Purpose

SQLTransact

Deprecated

Commits or rolls back a transaction

Using ODBC Driver 30

© 2015-2016 Devart

SQLEndTran

ISO92

Commits or rolls back a transaction.

ODBC API Calls for Terminating a Statement

FunctionName

Support

Standard

Purpose

SQLFreeStmt

ISO92

Ends statement processing, discards pending results,and, optionally, frees all resources associated withthe statement handle.

SQLCloseCursor

ISO92

Closes a cursor that has been opened on a statementhandle.

SQLCancel

ISO92

Cancels an SQL statement.

ODBC API Calls for Terminating a Connection

FunctionName

Support

Standard

Purpose

SQLDisconnect

ISO92

Closes the connection.

SQLFreeHandle

ISO92

Releases an environment, connection, statement, ordescriptor handle.

Devart ODBC Driver for SugarCRM31

© 2015-2016 Devart

SQLFreeConnect

Deprecated

Releases connection handle.

SQLFreeEnv

Deprecated

Releases an environment handle.