aws / aws/amazon-redshift-odbc-driver
"Latest" documentation on docs.aws.amazon.com is out of date.
- Dominant language
- C
- Stars
- 25
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
First, let me say you've been doing great work on v2.0+ of this driver, we've had a number of performance and memory issues using the old 1.4.65 driver for ETL, and the new compression option is very promising for us.
## Problem description
Upgrading versions has been a struggle for us, because the "latest" documentation available for the ODBC driver is for v1.5.9.
Even if we start from https://docs.aws.amazon.com/redshift/latest/mgmt/odbc20-install.html - which is the page dedicated to ODBC driver version 2.x, the first link [Configuring an ODBC connection](https://docs.aws.amazon.com/redshift/latest/mgmt/configure-odbc-connection.html) leads to a page and the [Redshift ODBC configuration guide](https://s3.amazonaws.com/redshift-downloads/drivers/odbc/1.5.9.1011/Amazon+Redshift+ODBC+Connector+Install+Guide.pdf) which is for the older version.
For us, the biggest impact was that we tried following along this guide to set up the fetch size parameter described on page 113, but found that this option didn't exist in the latest installer. After a ton of searching, I came across [this documentation for the JDBC driver](https://docs.aws.amazon.com/redshift/latest/mgmt/jdbc_fetch_size.html) stating "Fetch size is not supported for ODBC.":

This seemed like a very odd regression to me (and a very misleading statement to make when the option did in fact exist in the older driver version). It wasn't until extensive searching that I came across this repo, and this issue: https://github.com/aws/amazon-redshift-odbc-driver/issues/15 wherein you mentioned "A similar option is available in 'Cursor' Tab under 'Streaming Cursor' section.". I don't think I'm exaggerating when I say this is the only place on the internet where this information has been imparted. It doesn't even appear on the [odbc20 configuration options](https://docs.aws.amazon.com/redshift/latest/mgmt/odbc20-configuration-options.html) page, which otherwise appears to mention many of the new options (like [compression](https://docs.aws.amazon.com/redshift/latest/mgmt/odbc20-configuration-options.html#odbc20-compression-option))
I know you might not have a ton of control over the content over at docs.aws.amazon.com, but I think it's appropriate to keep an issue open here as a reminder that someone somewhere needs to get on top of it.
Thanks again for your work
-----
Probably not relevant for purposes of this ticket, but this is me:
- Driver version: `2.1.3.0`
- Redshift version `PostgreSQL 8.0.2 on i686-pc-linux-gnu, compiled by GCC gcc (GCC) 3.4.2 20041017 (Red Hat 3.4.2-6.fc3), Redshift 1.0.71629`
- Client Operating System: `Windows Server 2019`
Contributor guide
Research direction
Start with the linked odbc20-install.html and odbc20-configuration-options.html pages, then compare their links and options with the older 1.5.9 configuration guide and the related issue #15. Confirm where the current documentation is maintained and update or redirect the outdated guidance so the v2.x streaming cursor/fetch-size behavior is accurately documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100