Progress Datadirect for ODBC for Amazon Redshift Wire Protocol Driver Quick Start for UNIX/Linux
Total Page:16
File Type:pdf, Size:1020Kb
Progress DataDirect® for ODBC for Amazon Redshift™ Wire Protocol Driver Quick Start for UNIX/Linux Release 8.0.0 Quick Start: Progress DataDirect for ODBC for Amazon Redshift Wire Protocol Driver for UNIX/Linux This quick start provides basic information that allows you to install and test connect with your driver. To take full advantage of the features and functionality available for your driver, refer to the product documentation library at: Progress DataDirect Documentation Library Note: OEM CUSTOMERS: Refer to the Progress DataDirect for ODBC Drivers Distribution Guide for information on installing, branding, unlocking, and distributing your branded drivers. This quick start covers the following topics: • Before You Start on page 3 • Requirements and Support on page 4 • Downloading the Driver on page 4 • Installing the ODBC Driver on UNIX/Linux on page 4 • Environment Configuration on page 6 • Configuring a Data Source on page 7 • Testing the Connection on page 8 • Tuning for Performance on page 8 • Troubleshooting Setup/Connection Issues on page 10 • Additional Resources on page 11 Before You Start Before you get started, you need the following: • Appropriate user permissions to modify your environment and to read, write, and execute various files in the DataDirect for ODBC installation directory . • Connection information: • Database Name: The name of the database to which you want to connect. • Host Name: The endpoint for the Amazon Redshift cluster to which you want to connect. • Port Number: The port number of the server listener. enter product name here: Quick Start for UNIX/Linux: Version 8.0.0 3 Chapter 1: Quick Start: Progress DataDirect for ODBC for Amazon Redshift Wire Protocol Driver for UNIX/Linux • For licensed installations, you will also need the following information that was provided by Progress DataDirect: • IPE Key (control number) • Serial Number Requirements and Support Driver/Client Software Requirements: • The driver has no client requirements. Supported Data Sources: • Amazon Redshift For the latest information on supported data sources and requirements, visit the Progress DataDirect Supported Configurations page. Downloading the Driver To download the ODBC Amazon Redshift driver: 1. Visit the Progress DataDirect Connectors Download page. 2. Select Amazon Redshift from the list. 3. Select ODBC for the interface. 4. When prompted for your OS and architecture, select the bitness and platform your application runs on. 5. Fill in the registration form with your contact information. 6. Review the End User License Agreement. If you agree, select the corresponding box; then, click Download. The installer program has been downloaded. See "Installing the ODBC Driver on UNIX/Linux" for instructions on installing the driver. See also Installing the ODBC Driver on UNIX/Linux on page 4 Installing the ODBC Driver on UNIX/Linux This section provides instructions for installing your downloaded files from a command-line interface. Depending on your environment, you can also install using GUI or silent installation options. Refer to the Progress DataDirect for ODBC Drivers Installation Guide for complete installation instructions. 1. Download the appropriate product file from the Web site into a temporary directory, for example, /tmp. 2. Switch the temporary directory; then, choose one of the following: 4 enter product name here: Quick Start for UNIX/Linux: Version 8.0.0 Installing the ODBC Driver on UNIX/Linux 3. Extract the contents of the product file. Enter: tar -xvzf product_filename.tgz where product_filename is the name of the tarred product file name. The untarred files appear in the temporary directory. 4. Run the installer program by switching to the temporary directory that contains the untarred installer files and entering: ./installer_filename.bin –i console where: installer_filename is the full name of the installer's binary file you untarred in Step 3 on page 5 . 5. The Introduction step appears. Press ENTER. 6. The product license agreement appears. Press SPACEBAR to page to the end of the agreement. At the end, you are asked to accept the agreement: • Enter Y to accept the license agreement and continue with the installation. • Enter N to abort the installation. Note: You can exit the installer program at any time by typing quit or return to the previous step by typing previous. 7. You are prompted to enter the absolute path to the installation directory. The default is: For 32-bit installations: opt/Progress/DataDirect/ODBC_nn_32bit For 64-bit installations: opt/Progress/DataDirect/ODBC_nn_64bit If you do not have /opt directory permissions, the installer program installs the drivers to your home directory by default. For example, the directory for 32-bit installation would be: /home_directory/Progress/DataDirect/ODBC_nn_32bit where nn is the product version number. For example, this value is 80 for the 8.0 version of the product. home_directory is the home directory for the user who is installing the product. 8. You are prompted for the type of installation: • If you are installing an evaluation copy of the product (expires in 15 days), enter 1. Then, press Enter to confirm the evaluation information. Skip to Step 12 on page 6. • If you are installing a OEM or licensed copy of the product, enter 2. Proceed to the next step. enter product name here: Quick Start for UNIX/Linux: Version 8.0.0 5 Chapter 1: Quick Start: Progress DataDirect for ODBC for Amazon Redshift Wire Protocol Driver for UNIX/Linux Note: If you were issued multiple product keys, you can type them sequentially, separating the keys with a space. For example: xxxxkey1 xxxxkey2 xxxxkey3 9. You are prompted to enter the IPE key (control number) that was provided by Progress DataDirect. Type the IPE key (control number), including dashes, and then press ENTER. Proceed to the next step. 10. The DataDirect Installer Customer Experience Improvement Program step appears. By choosing to participate in the program, you permit the installer to gather data about your installation, such as environment information and error details, that will be used to improve our products. Choose one of the following: • If you would like to participate in the program, enter 1. • If you do not want to participate in the program, enter 2. For more information about data collection, refer to the Progress Privacy Policy. 11. The installer prompts you for product registration information. Enter your name, your company name, and the serial number provided by Progress DataDirect; then, press ENTER. 12. The Pre-Installation Summary step provides the opportunity for you to review the information you have entered, and you are prompted to accept or change the information: • Press ENTER to accept the information and begin the installation. • To change the information, type back and then press ENTER. You are prompted for the information again. • If you are installing with a licensed OEM IPE key, you are prompted for branding information. Please refer to the Progress DataDirect for ODBC Drivers Distribution Guide. 13. After completion of the installation, a message appears indicating that you have installed the software successfully. Press ENTER to close the installer. This completes the installation. After installation, you must do the following: • Configure your environment • Configure a data source See "Environment Configuration", "Setting the Library Path Environment Variable" and "Configuring a Data Source" for details. See also Environment Configuration on page 6 Configuring a Data Source on page 7 Environment Configuration After installing your driver, your first step in setting up and configuring the driver is to configure your environment variables. The following procedures require that you have the appropriate permissions to modify your environment and to read, write, and execute various files. You must log in as a user with full r/w/x permissions recursively on the entire DataDirect Connect Series for ODBC installation directory. To configure the environment: 6 enter product name here: Quick Start for UNIX/Linux: Version 8.0.0 Configuring a Data Source 1. Check your permissions: You must log in as a user with full r/w/x permissions recursively on the entire product installation directory. 2. From your login shell, determine which shell you are running by executing: echo $SHELL 3. Run one of the following product setup scripts from the installation directory to set variables: odbc.sh or odbc.csh. For Korn, Bourne, and equivalent shells, execute odbc.sh. For a C shell, execute odbc.csh. After running the setup script, execute: env to verify that the installation_directory/lib directory has been added to your shared library path. 4. Set the ODBCINI environment variable. The variable must point to the path from the root directory to the system information file where your data source resides. The system information file can have any name, but the product is installed with a default file called odbc.ini in the product installation directory. For example, if you use an installation directory of /opt/odbc and the default system information file, from the Korn or Bourne shell, you would enter: ODBCINI=/opt/odbc/odbc.ini; export ODBCINI From the C shell, you would enter: setenv ODBCINI /opt/odbc/odbc.ini Configuring a Data Source The default odbc.ini file installed in the installation directory is a template in which you create data source definitions. You enter your site-specific database connection information using a text editor. Each data source definition must include the keyword Driver=, which is the full path to the driver. The following examples show the minimum connection string options that must be set to complete a test connection, where xx represents iv for 32-bit or dd for 64-bit drivers, and yy represents the extension. The values for the options are samples and are not necessarily the ones you would use. [ODBC Data Sources] Amazon Redshift Wire Protocol=DataDirect 8.0 Amazon Redshift Wire Protocol Driver [Amazon Redshift Wire Protocol] Driver=ODBCHOME/lib/xxrsftyy.zz Database=Redshiftdb1 HostName=RedshiftServer PortNumber=5439 Connection Option Descriptions: • Database: The name of the database to which you want to connect by default.