docs.aws.amazon.com
Open in
urlscan Pro
52.222.174.51
Public Scan
Submitted URL: https://docs.aws.amazon.com/redshift/latest/mgmt/install-odbc-driver-windows.html
Effective URL: https://docs.aws.amazon.com/redshift/latest/mgmt/configure-odbc-connection.html
Submission: On August 14 via manual from US — Scanned from DE
Effective URL: https://docs.aws.amazon.com/redshift/latest/mgmt/configure-odbc-connection.html
Submission: On August 14 via manual from US — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
SELECT YOUR COOKIE PREFERENCES
We use essential cookies and similar tools that are necessary to provide our
site and services. We use performance cookies to collect anonymous statistics so
we can understand how customers use our site and make improvements. Essential
cookies cannot be deactivated, but you can click “Customize cookies” to decline
performance cookies.
If you agree, AWS and approved third parties will also use cookies to provide
useful site features, remember your preferences, and display relevant content,
including relevant advertising. To continue without accepting these cookies,
click “Continue without accepting.” To make more detailed choices or learn more,
click “Customize cookies.”
Accept all cookiesContinue without acceptingCustomize cookies
CUSTOMIZE COOKIE PREFERENCES
We use cookies and similar tools (collectively, "cookies") for the following
purposes.
ESSENTIAL
Essential cookies are necessary to provide our site and services and cannot be
deactivated. They are usually set in response to your actions on the site, such
as setting your privacy preferences, signing in, or filling in forms.
PERFORMANCE
Performance cookies provide anonymous statistics about how customers navigate
our site so we can improve site experience and performance. Approved third
parties may perform analytics on our behalf, but they cannot use the data for
their own purposes.
Allow performance category
Allowed
FUNCTIONAL
Functional cookies help us provide useful site features, remember your
preferences, and display relevant content. Approved third parties may set these
cookies to provide certain site features. If you do not allow these cookies,
then some or all of these services may not function properly.
Allow functional category
Allowed
ADVERTISING
Advertising cookies may be set through our site by us or our advertising
partners and help us deliver relevant marketing content. If you do not allow
these cookies, you will experience less relevant advertising.
Allow advertising category
Allowed
Blocking some types of cookies may impact your experience of our sites. You may
review and change your choices at any time by clicking Cookie preferences in the
footer of this site. We and selected third-parties use cookies or similar
technologies as specified in the AWS Cookie Notice.
CancelSave preferences
UNABLE TO SAVE COOKIE PREFERENCES
We will only store essential cookies at this time, because we were unable to
save your cookie preferences.
If you want to change your cookie preferences, try again later using the link in
the AWS console footer, or contact support if the problem persists.
Dismiss
Contact Us
English
Create an AWS Account
1. AWS
2. ...
3. Documentation
4. Amazon Redshift
5. Management Guide
Feedback
Preferences
AMAZON REDSHIFT
MANAGEMENT GUIDE
* What Is Amazon Redshift?
* Amazon Redshift Serverless feature overview
* Amazon Redshift provisioned clusters overview
* Comparing Amazon Redshift Serverless to an Amazon Redshift provisioned
data warehouse
* Amazon Redshift Serverless
* What is Amazon Redshift Serverless?
* Amazon Redshift Serverless console
* Considerations when using Amazon Redshift Serverless
* Compute capacity for Amazon Redshift Serverless
* Billing for Amazon Redshift Serverless
* Connecting to Amazon Redshift Serverless
* Defining database roles to grant to federated users in Amazon Redshift
Serverless
* Identity and access management in Amazon Redshift Serverless
* Migrating a provisioned cluster to Amazon Redshift Serverless
* Overview of Amazon Redshift Serverless workgroups and namespaces
* Managing Amazon Redshift Serverless using the console
* Setting up Amazon Redshift Serverless for the first time
* Working with workgroups
* Creating a workgroup with a namespace
* Viewing properties for a workgroup
* Deleting a workgroup
* Working with namespaces
* Editing security and encryption
* Changing the AWS KMS key for a namespace
* Deleting a namespace
* Managing usage limits, query limits, and other administrative tasks
* Monitoring queries and workloads with Amazon Redshift Serverless
* Audit logging for Amazon Redshift Serverless
* Working with snapshots and recovery points
* Data sharing in Amazon Redshift Serverless
* Tagging resources overview
* Clusters
* Managing clusters overview
* Managing usage limits
* Managing cluster relocation
* Configuring Multi-AZ deployment (preview)
* Managing Multi-AZ deployment
* Managing Multi-AZ using the console
* Using a custom domain name for client connections
* Security for a custom domain name
* Setting up a custom domain name
* Working with Redshift-managed VPC endpoints
* Managing clusters using the console
* Managing clusters using the AWS CLI and Amazon Redshift API
* Managing clusters using the AWS SDK for Java
* Managing clusters in a VPC
* Creating a cluster in a VPC
* Managing VPC security groups for a cluster
* Configuring security group communication settings for Amazon Redshift
clusters
* Cluster subnet groups
* Managing cluster subnet groups using the console
* Managing cluster subnet groups using the AWS SDK for Java
* Manage cluster subnet groups using the AWS CLI and Amazon Redshift
API
* Cluster version history
* Working with Amazon Aurora zero-ETL integrations (preview)
* Preview limitations
* Getting started with zero-ETL integrations
* Creating destination databases
* Querying and sharing data in Amazon Redshift
* Viewing zero-ETL integrations
* Monitoring zero-ETL integrations
* Troubleshooting zero-ETL integrations
* Querying a database
* Querying a database using the Amazon Redshift query editor v2
* Configuring your AWS account
* Working with query editor v2
* Loading data into a database
* Authoring and running queries
* Authoring and running notebooks
* Querying the AWS Glue Data Catalog
* Querying a data lake
* Working with datashares
* Scheduling a query
* Visualizing results
* Collaborating and sharing as a team
* Querying a database using the query editor
* Scheduling a query
* Connecting to a cluster using SQL client tools
* Configuring connections in Amazon Redshift
* Configuring a JDBC driver version 2.1 connection
* Download the Amazon Redshift JDBC driver, version 2.1
* Installing the Amazon Redshift JDBC driver, version 2.1
* Referencing the JDBC driver libraries
* Registering the driver class
* Getting the JDBC URL
* Building the connection URL
* Configuring your JDBC connection with Apache Maven
* Configuring authentication and SSL
* Configuring logging
* Converting data types
* Using prepared statement support
* Differences between the 2.1 and 1.x versions of the JDBC driver
* Creating initialization (.ini) files for JDBC driver version 2.1
* Options for JDBC driver version 2.1 configuration
* Previous versions of JDBC driver version 2.1
* Configuring the Amazon Redshift Python connector
* Installing the Python connector
* Configuration options for the Python connector
* Importing the Python connector
* Importing NumPy and connecting to Amazon Redshift
* Integrating the Python connector with NumPy
* Integrating the Python connector with pandas
* Using identity provider plugins
* Examples
* API reference
* Amazon Redshift integration for Apache Spark
* Authentication with the Spark connector
* Performance improvements with pushdown
* Other configuration options
* Supported data types
* Configuring an ODBC driver version 2.x connection
* Getting the ODBC URL
* Installing and configuring the Amazon Redshift ODBC driver on
Microsoft Windows
* Installing and configuring the Amazon Redshift ODBC driver on
Linux
* Configuring authentication
* Converting data types
* Configuring ODBC driver options
* Previous ODBC driver versions
* Configuring an ODBC connection
* Configuring security options for connections
* Transitioning to ACM certificates for SSL connections
* Connecting from client tools and code
* Connecting with Amazon Redshift RSQL
* Getting started with Amazon Redshift RSQL
* Amazon Redshift RSQL change log
* Connect to a cluster with Amazon Redshift RSQL
* Amazon Redshift RSQL meta commands
* Amazon Redshift RSQL variables
* Amazon Redshift RSQL error codes
* Amazon Redshift RSQL environment variables
* Connecting with SQL Workbench/J
* Connect to your cluster programmatically
* Using an authentication profile to connect to Amazon Redshift
* Troubleshooting connection issues in Amazon Redshift
* Connecting from outside of Amazon EC2—firewall timeout issue
* Connection is refused or fails
* Client and driver are incompatible
* Queries appear to hang and sometimes fail to reach the cluster
* Using the Data API
* Authorizing access
* Calling the Data API
* Troubleshooting Data API issues
* Scheduling Data API operations with Amazon EventBridge
* Monitoring the Data API
* Monitoring Data API events in Amazon EventBridge
* Enhanced VPC routing
* Working with VPC endpoints
* Enhanced VPC routing
* Redshift Spectrum and enhanced VPC routing
* Parameter groups
* Configuring workload management
* Managing parameter groups using the console
* Managing parameter groups using the AWS SDK for Java
* Managing parameter groups using the AWS CLI and Amazon Redshift API
* Snapshots and backups
* Managing snapshots using the console
* Managing snapshots using the AWS SDK for Java
* Managing snapshots using the AWS CLI and Amazon Redshift API
* Working with AWS Backup
* Managing AWS Backup with Amazon Redshift
* Integrating with an AWS Partner
* Purchasing reserved nodes
* Purchasing a reserved node offering with the console
* Purchasing a reserved node offering using Java
* Purchasing a reserved node offering using the AWS CLI and Amazon Redshift
API
* Security
* Data protection
* Data encryption
* Encryption at rest
* Database encryption
* Changing Cluster Encryption
* Configuring database encryption using the console
* Configuring database encryption using the Amazon Redshift API
and AWS CLI
* Encryption in transit
* Key management
* Data tokenization
* Internetwork traffic privacy
* Identity and access management
* Overview of managing access
* Using identity-based policies (IAM policies)
* Native identity provider (IdP) federation for Amazon Redshift
* Amazon Redshift API permissions reference
* Using service-linked roles
* Using IAM authentication to generate database user credentials
* Overview
* Creating temporary IAM credentials
* Create an IAM role for IAM single sign-on access
* Configure SAML assertions for your IdP
* Create an IAM role with permissions to call GetClusterCredentials
* Create a database user and database groups
* Configure a JDBC or ODBC connection to use IAM credentials
* Options for providing IAM credentials
* JDBC and ODBC Options for Creating Database User Credentials
* Generating IAM database credentials using the Amazon Redshift CLI
or API
* Authorizing Amazon Redshift to access AWS services
* Authorizing COPY, UNLOAD, CREATE EXTERNAL FUNCTION, and CREATE
EXTERNAL SCHEMA operations using IAM roles
* Creating an IAM role as default for Amazon Redshift
* Using a federated identity to manage Amazon Redshift access to local
resources and Amazon Redshift Spectrum external tables
* Logging and monitoring
* Database audit logging
* Configuring auditing using the console
* Configuring logging by using the AWS CLI and Amazon Redshift API
* Logging with CloudTrail
* Compliance validation
* Resilience
* Infrastructure security
* Security groups
* Connecting using an interface VPC endpoint
* Configuration and vulnerability analysis
* Using the Amazon Redshift management interfaces
* Using the AWS SDK for Java
* Signing an HTTP request
* Setting up the Amazon Redshift CLI
* Getting started with the AWS Command Line Interface
* Monitoring cluster performance
* Performance data
* Working with performance data
* Viewing cluster performance data
* Viewing query history data
* Viewing database performance data
* Viewing workload concurrency and concurrency scaling data
* Viewing queries and loads
* Viewing query details
* Analyzing query execution
* Viewing cluster performance as queries run
* Viewing cluster metrics during load operations
* Analyzing workload performance
* Managing alarms
* Working with performance metrics in the CloudWatch console
* Events
* Event notifications
* Managing cluster event notifications
* Quotas and limits
* Tagging
* Managing resource tags using the console
* Managing tags using the Amazon Redshift API
* Cluster versions
* Document history
Configuring an ODBC connection - Amazon Redshift
AWSDocumentationAmazon RedshiftManagement Guide
Obtain the ODBC URL for your clusterInstall and configure the Amazon Redshift
ODBC driver on Microsoft WindowsInstall the Amazon Redshift ODBC driver on
LinuxInstall the Amazon Redshift ODBC driver on macOS XUse an ODBC driver
manager to configure the driver on Linux and macOS X operating systemsConfigure
ODBC driver optionsPrevious ODBC driver versions
CONFIGURING AN ODBC CONNECTION
PDFRSS
You can use an ODBC connection to connect to your Amazon Redshift cluster from
many third-party SQL client tools and applications. To do this, set up the
connection on your client computer or Amazon EC2 instance. If your client tool
supports JDBC, you might choose to use that type of connection rather than ODBC
due to the ease of configuration that JDBC provides. However, if your client
tool doesn't support JDBC, follow the steps in this section to configure an ODBC
connection.
Amazon Redshift provides 64-bit ODBC drivers for Linux, Windows, and macOS X
operating systems. The 32-bit ODBC drivers are discontinued. Further updates
will not be released, except for urgent security patches.
For the latest information about ODBC driver functionality and prerequisites,
see Amazon Redshift ODBC driver release notes.
For installation and configuration information for Amazon Redshift ODBC drivers,
see the Amazon Redshift ODBC connector installation and configuration guide.
If you want to use an ODBC connection, take the following steps.
TOPICS
* Obtain the ODBC URL for your cluster
* Install and configure the Amazon Redshift ODBC driver on Microsoft Windows
* Install the Amazon Redshift ODBC driver on Linux
* Install the Amazon Redshift ODBC driver on macOS X
* Use an ODBC driver manager to configure the driver on Linux and macOS X
operating systems
* Configure ODBC driver options
* Previous ODBC driver versions
OBTAIN THE ODBC URL FOR YOUR CLUSTER
Amazon Redshift displays the ODBC URL for your cluster in the Amazon Redshift
console. This URL contains the information to set up the connection between your
client computer and the database.
An ODBC URL has the following format:
Driver={driver};Server=endpoint;Database=database_name;UID=user_name;PWD=password;Port=port_number
The fields of the format shown preceding have the following values.
Field Value Driver
The name of the 64-bit ODBC driver to use: Amazon Redshift (x64).
The name of the 32-bit ODBC driver: Amazon Redshift (x86).
Server The endpoint of the Amazon Redshift cluster. Database The database that
you created for your cluster. UID The user name of a user account that has
permission to connect to the database. This value is a database permission, not
an Amazon Redshift permission, although you can use the admin user account that
you set up when you launched the cluster. PWD The password for the user account
to connect to the database. Port The port number that you specified when you
launched the cluster. If you have a firewall, ensure that this port is open for
you to use.
The fields in the preceding tables can contain the following special characters:
[]{}(),;?*=!@
If you use these special characters you must enclose the value in curly braces.
For example, the password value Your;password123 in a connection string is
represented as PWD={Your;password123};.
Since Field=value pairs are separated by semicolon, the combination of } and ;
with any number of spaces in between is considered the end of a Field={value};
pair. We recommend you avoid the sequence }; in your field values. For example,
if you set your password value as PWD={This is a passwor} ;d};, your password
would be This is a passwor} ; and the URL would error out.
The following is an example ODBC URL.
Driver={Amazon Redshift (x64)};
Server=examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com;
Database=dev;
UID=adminuser;
PWD=insert_your_admin_user_password_here;
Port=5439
For information about how to get your ODBC connection, see Finding your cluster
connection string.
INSTALL AND CONFIGURE THE AMAZON REDSHIFT ODBC DRIVER ON MICROSOFT WINDOWS
SYSTEM REQUIREMENTS
You install the Amazon Redshift ODBC driver on client computers accessing an
Amazon Redshift data warehouse. Each computer where you install the driver must
meet a list of minimum system requirements. For information about minimum system
requirements, see the Amazon Redshift ODBC connector installation and
configuration guide.
INSTALLING THE AMAZON REDSHIFT DRIVER ON WINDOWS OPERATING SYSTEMS
Use the following procedure to download the Amazon Redshift ODBC drivers for
Windows operating systems. Only use a driver other than these if you're running
a third-party application that is certified for use with Amazon Redshift and
that requires a specific driver.
TO INSTALL THE ODBC DRIVER
1. Download one of the following, depending on the system architecture of your
SQL client tool or application:
* 64-bit ODBC driver version 1.4.65
The name for this driver is Amazon Redshift (x64).
* 32-bit ODBC driver version 1.4.52
The name for this driver is Amazon Redshift (x86). The 32-bit ODBC
drivers are discontinued. Further updates will not be released, except
for urgent security patches.
NOTE
Download the MSI package that corresponds to the system architecture of your
SQL client tool or application. For example, if your SQL client tool is
64-bit, install the 64-bit driver.
Then download and review the Amazon Redshift ODBC and JDBC driver license
agreement.
2. Double-click the .msi file, and then follow the steps in the wizard to
install the driver.
CREATING A SYSTEM DSN ENTRY FOR AN ODBC CONNECTION ON MICROSOFT WINDOWS
After you download and install the ODBC driver, add a data source name (DSN)
entry to the client computer or Amazon EC2 instance. SQL client tools use this
data source to connect to the Amazon Redshift database.
We recommend that you create a system DSN instead of a user DSN. Some
applications load the data using a different user account. These applications
might not be able to detect user DSNs that are created under another user
account.
NOTE
For authentication using AWS Identity and Access Management (IAM) credentials or
identity provider (IdP) credentials, additional steps are required. For more
information, see Configure a JDBC or ODBC connection to use IAM credentials.
For information about how to create a system DSN entry, see the Amazon Redshift
ODBC connector installation and configuration guide.
TO CREATE A SYSTEM DSN ENTRY FOR AN ODBC CONNECTION ON WINDOWS
1. In the Start menu, open ODBC Data Sources.
Make sure that you choose the ODBC Data Source Administrator that has the
same bitness as the client application that you are using to connect to
Amazon Redshift.
2. In the ODBC Data Source Administrator, choose the Driver tab and locate the
driver folder:
* Amazon Redshift ODBC Driver (64-bit)
* Amazon Redshift ODBC Driver (32-bit)
3. Choose the System DSN tab to configure the driver for all users on the
computer, or the User DSN tab to configure the driver for your user account
only.
4. Choose Add. The Create New Data Source window opens.
5. Choose the Amazon Redshift ODBC driver, and then choose Finish. The Amazon
Redshift ODBC Driver DSN Setup window opens.
6. Under Connection Settings, enter the following information:
DATA SOURCE NAME
Enter a name for the data source. You can use any name that you want to
identify the data source later when you create the connection to the
cluster. For example, if you followed the Amazon Redshift Getting Started
Guide, you might type exampleclusterdsn to make it easy to remember the
cluster that you associate with this DSN.
SERVER
Specify the endpoint for your Amazon Redshift cluster. You can find this
information in the Amazon Redshift console on the cluster's details page.
For more information, see Configuring connections in Amazon Redshift.
PORT
Enter the port number that the database uses. Use the port that the cluster
was configured to use when it was launched or modified.
DATABASE
Enter the name of the Amazon Redshift database. If you launched your
cluster without specifying a database name, enter dev. Otherwise, use the
name that you chose during the launch process. If you followed the Amazon
Redshift Getting Started Guide, enter dev.
7. Under Authentication, specify the configuration options to configure
standard or IAM authentication. For information about authentication
options, see "Configuring Authentication on Windows" in Amazon Redshift
ODBC Connector Installation and Configuration Guide.
8. Under SSL Settings, specify a value for the following:
SSL AUTHENTICATION
Choose a mode for handling Secure Sockets Layer (SSL). In a test
environment, you might use prefer. However, for production environments and
when secure data exchange is required, use verify-ca or verify-full. For
more information about using SSL on Windows, see "Configuring SSL
Verification on Windows" in Amazon Redshift ODBC Connector Installation and
Configuration Guide.
9. Under Additional Options, specify options on how to return query results to
your SQL client tool or application. For more information, see "Configuring
Additional Options on Windows" in Amazon Redshift ODBC Connector
Installation and Configuration Guide.
10. In Logging Options, specify values for the logging option. For more
information, see "Configuring Logging Options on Windows" in Amazon
Redshift ODBC Connector Installation and Configuration Guide.
Then choose OK.
11. Under Data Type Options, specify values for data types. For more
information, see "Configuring Data Type Options on Windows" in Amazon
Redshift ODBC Connector Installation and Configuration Guide.
Then choose OK.
12. Choose Test. If the client computer can connect to the Amazon Redshift
database, you see the following message: Connection successful.
If the client computer fails to connect to the database, you can
troubleshoot possible issues. For more information, see Troubleshooting
connection issues in Amazon Redshift.
13. Configure TCP keepalives on Windows to prevent connections from timing out.
For information about how to configure TCP keepalives on Windows, see
Amazon Redshift ODBC Connector Installation and Configuration Guide.
14. To help troubleshooting, configure logging. For information about how to
configure logging on Windows, see Amazon Redshift ODBC Connector
Installation and Configuration Guide.
INSTALL THE AMAZON REDSHIFT ODBC DRIVER ON LINUX
SYSTEM REQUIREMENTS
You install the Amazon Redshift ODBC driver on client computers accessing an
Amazon Redshift data warehouse. Each computer where you install the driver must
meet a list of minimum system requirements. For information about minimum system
requirements, see the Amazon Redshift ODBC connector installation and
configuration guide.
INSTALLING THE AMAZON REDSHIFT DRIVER ON LINUX OPERATING SYSTEMS
Use the steps in this section to download and install the Amazon Redshift ODBC
drivers on a supported Linux distribution. The installation process installs the
driver files in the following directories:
* /opt/amazon/redshiftodbc/lib/64 (for the 64-bit driver)
* /opt/amazon/redshiftodbc/ErrorMessages
* /opt/amazon/redshiftodbc/Setup
* /opt/amazon/redshiftodbc/lib/32 (for the 32-bit driver)
TO INSTALL THE AMAZON REDSHIFT ODBC DRIVER
1. Download one of the following, depending on the system architecture of your
SQL client tool or application:
* 64-bit RPM driver version 1.4.65
* 64-bit Debian driver version 1.4.65
* 32-bit RPM driver version 1.4.52
* 32-bit Debian driver version 1.4.52
The name for each of these drivers is Amazon Redshift ODBC driver. The
32-bit ODBC drivers are discontinued. Further updates will not be released,
except for urgent security patches.
NOTE
Download the package that corresponds to the system architecture of your SQL
client tool or application. For example, if your client tool is 64-bit,
install a 64-bit driver.
Then download and review the Amazon Redshift ODBC and JDBC driver license
agreement.
2. Go to the location where you downloaded the package, and then run one of the
following commands. Use the command that corresponds to your Linux
distribution.
* On RHEL and CentOS operating systems, run the following command.
yum --nogpgcheck localinstall RPMFileName
Replace RPMFileName with the RPM package file name. For example, the
following command demonstrates installing the 64-bit driver.
yum --nogpgcheck localinstall AmazonRedshiftODBC-64-bit-1.x.xx.xxxx-x.x86_64.rpm
* On SLES, run the following command.
zypper install RPMFileName
Replace RPMFileName with the RPM package file name. For example, the
following command demonstrates installing the 64-bit driver.
zypper install AmazonRedshiftODBC-1.x.x.xxxx-x.x86_64.rpm
* On Debian, run the following command.
sudo apt install ./DEBFileName.deb
Replace DEBFileName.deb with the Debian package file name. For example,
the following command demonstrates installing the 64-bit driver.
sudo apt install ./AmazonRedshiftODBC-1.x.x.xxxx-x.x86_64.deb
IMPORTANT
When you have finished installing the drivers, configure them for use on your
system. For more information on driver configuration, see Use an ODBC driver
manager to configure the driver on Linux and macOS X operating systems.
INSTALL THE AMAZON REDSHIFT ODBC DRIVER ON MACOS X
SYSTEM REQUIREMENTS
You install the driver on client computers accessing an Amazon Redshift data
warehouse. Each computer where you install the driver must meet a list of
minimum system requirements. For information about minimum system requirements,
see the Amazon Redshift ODBC connector installation and configuration guide.
INSTALLING THE AMAZON REDSHIFT ODBC DRIVER ON MACOS X
Use the steps in this section to download and install the Amazon Redshift ODBC
driver on a supported version of macOS X. The installation process installs the
driver files in the following directories:
* /opt/amazon/redshift/lib/universal
* /opt/amazon/redshift/ErrorMessages
* /opt/amazon/redshift/Setup
TO INSTALL THE AMAZON REDSHIFT ODBC DRIVER ON MACOS X
1. If your macOS X system uses Intel architecture, download the macOS X Intel
driver version 1.4.65. If your system uses ARM architecture, download the
macOS X ARM driver version 1.4.65. In both cases, the name for this driver
is Amazon Redshift ODBC driver.
Then download and review the Amazon Redshift ODBC and JDBC driver license
agreement.
2. Double-click AmazonRedshiftODBC.dmg to mount the disk image.
3. Double-click AmazonRedshiftODBC.pkg to run the installer.
4. Follow the steps in the installer to complete the driver installation
process. To perform the installation, agree to the terms of the license
agreement.
IMPORTANT
When you have finished installing the driver, configure it for use on your
system. For more information on driver configuration, see Use an ODBC driver
manager to configure the driver on Linux and macOS X operating systems.
USE AN ODBC DRIVER MANAGER TO CONFIGURE THE DRIVER ON LINUX AND MACOS X
OPERATING SYSTEMS
On Linux and macOS X operating systems, you use an ODBC driver manager to
configure the ODBC connection settings. ODBC driver managers use configuration
files to define and configure ODBC data sources and drivers. The ODBC driver
manager that you use depends on the operating system that you use:
* unixODBC driver manager (for Linux operating systems)
* iODBC driver manager (for macOS X operating system)
For more information about the supported ODBC driver managers to configure the
Amazon Redshift ODBC drivers, see System requirements for Linux operating
systems and System requirements for macOS X operating systems. Also, see
"Specifying ODBC Driver Managers on Non- Windows Machines" in the Amazon
Redshift ODBC connector installation and configuration guide.
Three files are required for configuring the Amazon Redshift ODBC driver:
amazon.redshiftodbc.ini, odbc.ini, and odbcinst.ini.
If you installed to the default location, the amazon.redshiftodbc.ini
configuration file is located in one of the following directories:
* /opt/amazon/redshiftodbc/lib/64 (for the 64-bit driver on Linux operating
systems)
* /opt/amazon/redshiftodbc/lib/32 (for the 32-bit driver on Linux operating
systems)
* /opt/amazon/redshift/lib (for the driver on macOS X)
Additionally, under /opt/amazon/redshiftodbc/Setup on Linux or
/opt/amazon/redshift/Setup on macOS X, there are sample odbc.ini and
odbcinst.ini files. You can use these files as examples for configuring the
Amazon Redshift ODBC driver and the data source name (DSN).
We don't recommend using the Amazon Redshift ODBC driver installation directory
for the configuration files. The sample files in the Setup directory are for
example purposes only. If you reinstall the Amazon Redshift ODBC driver at a
later time, or upgrade to a newer version, the installation directory is
overwritten. You then lose any changes that you might have made to those files.
To avoid this, copy the amazon.redshiftodbc.ini file to a directory other than
the installation directory. If you copy this file to the user's home directory,
add a period (.) to the beginning of the file name to make it a hidden file.
For the odbc.ini and odbcinst.ini files, either use the configuration files in
the user's home directory or create new versions in another directory. By
default, your Linux or macOS X operating system should have an odbc.ini file and
an odbcinst.ini file in the user's home directory (/home/$USER or ~/.). These
default files are hidden files, which is indicated by the dot (.) in front of
each file name. These files display only when you use the -a flag to list the
directory contents.
Whichever option you choose for the odbc.ini and odbcinst.ini files, modify the
files to add driver and DSN configuration information. If you create new files,
you also need to set environment variables to specify where these configuration
files are located.
By default, ODBC driver managers are configured to use hidden versions of the
odbc.ini and odbcinst.ini configuration files (named .odbc.ini and
.odbcinst.ini) located in the home directory. They also are configured to use
the amazon.redshiftodbc.ini file in the /lib subfolder of the driver
installation directory. If you store these configuration files elsewhere, set
the environment variables described following so that the driver manager can
locate the files. For more information, see "Specifying the Locations of the
Driver Configuration Files" in the Amazon Redshift ODBC connector installation
and configuration guide.
CREATING A DATA SOURCE NAME ON LINUX AND MACOS X OPERATING SYSTEMS
When connecting to your data store using a data source name (DSN), configure the
odbc.ini file to define DSNs. Set the properties in the odbc.ini file to create
a DSN that specifies the connection information for your data store.
For information about how to configure the odbc.ini file, see "Creating a Data
Source Name on a Non-Windows Machine" in the Amazon Redshift ODBC connector
installation and configuration guide
Use the following format on Linux operating systems.
[ODBC Data Sources]
driver_name=dsn_name
[dsn_name]
Driver=path/driver_file
Host=cluster_endpoint
Port=port_number
Database=database_name
locale=locale
The following example shows the configuration for odbc.ini with the 64-bit ODBC
driver on Linux operating systems.
[ODBC Data Sources]
Amazon_Redshift_x64=Amazon Redshift (x64)
[Amazon Redshift (x64)]
Driver=/opt/amazon/redshiftodbc/lib/64/libamazonredshiftodbc64.so
Host=examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com
Port=5932
Database=dev
locale=en-US
The following example shows the configuration for odbc.ini with the 32-bit ODBC
driver on Linux operating systems.
[ODBC Data Sources]
Amazon_Redshift_x32=Amazon Redshift (x86)
[Amazon Redshift (x86)]
Driver=/opt/amazon/redshiftodbc/lib/32/libamazonredshiftodbc32.so
Host=examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com
Port=5932
Database=dev
locale=en-US
Use the following format on macOS X operating systems.
[ODBC Data Sources]
driver_name=dsn_name
[dsn_name]
Driver=path/lib/amazonredshiftodbc.dylib
Host=cluster_endpoint
Port=port_number
Database=database_name
locale=locale
The following example shows the configuration for odbc.ini on macOS X operating
systems.
[ODBC Data Sources]
Amazon_Redshift_dylib=Amazon Redshift DSN for macOS X
[Amazon Redshift DSN for macOS X]
Driver=/opt/amazon/redshift/lib/amazonredshiftodbc.dylib
Host=examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com
Port=5932
Database=dev
locale=en-US
CONFIGURING A CONNECTION WITHOUT A DSN ON LINUX AND MACOS X OPERATING SYSTEMS
To connect to your data store through a connection that doesn't have a DSN,
define the driver in the odbcinst.ini file. Then provide a DSN-less connection
string in your application.
For information about how to configure the odbcinst.ini file in this case, see
"Configuring a DSN-less Connection on a Non-Windows Machine" in the Amazon
Redshift ODBC connector installation and configuration guide.
Use the following format on Linux operating systems.
[ODBC Drivers]
driver_name=Installed
...
[driver_name]
Description=driver_description
Driver=path/driver_file
...
The following example shows the odbcinst.ini configuration for the 64-bit driver
installed in the default directories on Linux operating systems.
[ODBC Drivers]
Amazon Redshift (x64)=Installed
[Amazon Redshift (x64)]
Description=Amazon Redshift ODBC Driver (64-bit)
Driver=/opt/amazon/redshiftodbc/lib/64/libamazonredshiftodbc64.so
The following example shows the odbcinst.ini configuration for the 32-bit driver
installed in the default directories on Linux operating systems.
[ODBC Drivers]
Amazon Redshift (x86)=Installed
[Amazon Redshift (x86)]
Description=Amazon Redshift ODBC Driver (32-bit)
Driver=/opt/amazon/redshiftodbc/lib/32/libamazonredshiftodbc32.so
Use the following format on macOS X operating systems.
[ODBC Drivers]
driver_name=Installed
...
[driver_name]
Description=driver_description
Driver=path/lib/amazonredshiftodbc.dylib
...
The following example shows the odbcinst.ini configuration for the driver
installed in the default directory on macOS X operating systems.
[ODBC Drivers]
Amazon RedshiftODBC DSN=Installed
[Amazon RedshiftODBC DSN]
Description=Amazon Redshift ODBC Driver for macOS X
Driver=/opt/amazon/redshift/lib/amazonredshiftodbc.dylib
CONFIGURING ENVIRONMENT VARIABLES
Use the correct ODBC driver manager to load the correct driver. To do this, set
the library path environment variable. For more information, see "Specifying
ODBC Driver Managers on Non-Windows Machines" in the Amazon Redshift ODBC
connector installation and configuration guide.
By default, ODBC driver managers are configured to use hidden versions of the
odbc.ini and odbcinst.ini configuration files (named .odbc.ini and
.odbcinst.ini) located in the home directory. They also are configured to use
the amazon.redshiftodbc.ini file in the /lib subfolder of the driver
installation directory. If you store these configuration files elsewhere, the
environment variables so that the driver manager can locate the files. For more
information, see "Specifying the Locations of the Driver Configuration Files" in
Amazon Redshift ODBC Connector Installation and Configuration Guide.
CONFIGURING CONNECTION FEATURES
You can configure the following connection features for your ODBC setting:
* Configure the ODBC driver to provide credentials and authenticate the
connection to the Amazon Redshift database.
* Configure the ODBC driver to connect to a socket enabled with Secure Sockets
Layer (SSL), if you are connecting to an Amazon Redshift server that has SSL
enabled.
* Configure the ODBC driver to connect to Amazon Redshift through a proxy
server.
* Configure the ODBC driver to use a query processing mode to prevent queries
from consuming too much memory.
* Configure the ODBC driver to pass IAM authentication processes through a
proxy server.
* Configure the ODBC driver to use TCP keepalives to prevent connections from
timing out.
For information about these connection features, see the Amazon Redshift ODBC
connector installation and configuration guide.
CONFIGURE ODBC DRIVER OPTIONS
You can use configuration options to control the behavior of the Amazon Redshift
ODBC driver.
In Microsoft Windows, you typically set driver options when you configure a data
source name (DSN). You can also set driver options in the connection string when
you connect programmatically, or by adding or changing registry keys in
HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\your_DSN. For more information about
configuring a DSN, see Install and configure the Amazon Redshift ODBC driver on
Microsoft Windows. For an example of setting driver options in a connection
string, see Connect to your cluster programmatically.
In Linux and macOS X, you set driver configuration options in your odbc.ini and
amazon.redshiftodbc.ini files, as described in Use an ODBC driver manager to
configure the driver on Linux and macOS X operating systems. Configuration
options set in an amazon.redshiftodbc.ini file apply to all connections. In
contrast, configuration options set in an odbc.ini file are specific to a
connection. Configuration options set in odbc.ini take precedence over
configuration options set in amazon.redshiftodbc.ini.
For information about how to set up ODBC driver configuration options, see the
Amazon Redshift ODBC connector installation and configuration guide.
PREVIOUS ODBC DRIVER VERSIONS
Download a previous version of the Amazon Redshift ODBC driver only if your tool
requires a specific version of the driver.
USE PREVIOUS ODBC DRIVER VERSIONS FOR WINDOWS
The following are the 64-bit drivers:
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.62.1000/AmazonRedshiftODBC64-1.4.62.1000.msi
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.59.1000/AmazonRedshiftODBC64-1.4.59.1000.msi
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.56.1000/AmazonRedshiftODBC64-1.4.56.1000.msi
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.53.1000/AmazonRedshiftODBC64-1.4.53.1000.msi
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.52.1000/AmazonRedshiftODBC64-1.4.52.1000.msi
32-bit drivers are discontinued and previous versions are not supported.
USE PREVIOUS ODBC DRIVER VERSIONS FOR LINUX
The following are the versions of the 64-bit driver:
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.62.1000/AmazonRedshiftODBC-64-bit-1.4.62.1000-1.x86_64.rpm
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.59.1000/AmazonRedshiftODBC-64-bit-1.4.59.1000-1.x86_64.rpm
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.59.1000/AmazonRedshiftODBC-64-bit-1.4.59.1000-1.x86_64.deb
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.56.1000/AmazonRedshiftODBC-64-bit-1.4.56.1000-1.x86_64.rpm
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.56.1000/AmazonRedshiftODBC-64-bit-1.4.56.1000-1.x86_64.deb
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.52.1000/AmazonRedshiftODBC-64-bit-1.4.52.1000-1.x86_64.rpm
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.52.1000/AmazonRedshiftODBC-64-bit-1.4.52.1000-1.x86_64.deb
32-bit drivers are discontinued and previous versions are not supported.
USE PREVIOUS ODBC DRIVER VERSIONS FOR MACOS X
The following are the versions of the Amazon Redshift ODBC driver for macOS X:
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.62.1000/AmazonRedshiftODBC-1.4.62.1000.dmg
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.59.1000/AmazonRedshiftODBC-1.4.59.1000.dmg
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.56.1000/AmazonRedshiftODBC-1.4.56.1000.dmg
* https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.4.52.1000/AmazonRedshiftODBC-1.4.52.1000.dmg
Javascript is disabled or is unavailable in your browser.
To use the Amazon Web Services Documentation, Javascript must be enabled. Please
refer to your browser's Help pages for instructions.
Document Conventions
Previous ODBC driver versions
Configuring security options for connections
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of
it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
Did this page help you?
Yes
No
Provide feedback
Next topic:Configuring security options for connections
Previous topic:Previous ODBC driver versions
Need help?
* Try AWS re:Post
* Connect with an AWS IQ expert
PrivacySite termsCookie preferences
© 2023, Amazon Web Services, Inc. or its affiliates. All rights reserved.
ON THIS PAGE
* Obtain the ODBC URL for your cluster
* Install and configure the Amazon Redshift ODBC driver on Microsoft Windows
* Install the Amazon Redshift ODBC driver on Linux
* Install the Amazon Redshift ODBC driver on macOS X
* Use an ODBC driver manager to configure the driver on Linux and macOS X
operating systems
* Configure ODBC driver options
* Previous ODBC driver versions
DID THIS PAGE HELP YOU? - NO
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
Feedback