Merge pull request #1353 from EnterpriseDB/ODBC_12.0.0.2_May11

Former-commit-id: e9f8a43

Author: robert-stringer

product_docs/docs/odbc_connector/12.0.0.2/02_requirements_overview.mdx

@@ -0,0 +1,43 @@
+---
+title: "Requirements Overview"
+
+legacyRedirectsGenerated:
+  # This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
+  - "/edb-docs/d/edb-postgres-odbc-connector/user-guides/odbc-guide/12.2.0.2/requirements_overview.html"
+---
+
+## Supported Versions
+
+The EDB ODBC Connector is certified with Advanced Server version 9.4 and above.
+
+## Supported Platforms
+
+The EDB ODBC Connector native packages are supported on the following platforms:
+
+64 bit Linux:
+
+-   Red Hat Enterprise Linux (x86_64) 8.x and 7.x
+-   CentOS (x86_64) 8.x and 7.x
+-   OEL Linux 7.x
+-   PPC-LE 8 running RHEL or CentOS 7.x
+-   SLES 12.x
+-   Debian 9.x
+-   Ubuntu 18.04 LTS
+
+!!! Note
+    EDB ODBC Connector, version 12.00.0000.02 is no longer supported on CentOS/RHEL/OEL 6.x platforms. It is strongly recommended that EDB products running on these platforms be migrated to a supported platform
+
+The EDB ODBC Connector graphical installers are supported on the following Windows platforms:
+
+64-bit Windows:
+
+-   Windows Server 2019
+-   Windows Server 2016
+-   Windows Server 2012 R2
+-   Windows 10
+-   Windows 8
+
+32-bit Windows:
+
+-   Windows 10
+-   Windows 8

product_docs/docs/odbc_connector/12.0.0.2/03_edb-odbc_overview/01_installing_edb-odbc.mdx

@@ -0,0 +1,266 @@
+---
+title: "Installing EDB-ODBC"
+
+legacyRedirectsGenerated:
+  # This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
+  - "/edb-docs/d/edb-postgres-odbc-connector/user-guides/odbc-guide/12.2.0.2/installing_edb-odbc.html"
+---
+
+The EDB ODBC Connector is distributed and installed with the EDB Postgres Advanced Server graphical or RPM installer.
+
+## Installing the Connector with an RPM Package
+
+### On RHEL 7
+
+Before installing the ODBC connector, you must:
+
+Install the epel-release package:
+
+-  On RHEL or CentOS 7:
+    ```text
+    yum -y install https://dl.fedoraproject.org/pub/epel/
+    epel-release-latest-7.noarch.rpm
+    ```
+-  On RHEL or CentOS 8:
+    ```text
+    dnf -y install https://dl.fedoraproject.org/pub/epel/
+    epel-release-latest-7.noarch.rpm
+    ```
+
+!!! Note
+    You may need to enable the `[extras]` repository definition in the CentOS-Base.repo file (located in `/etc/yum.repos.d`).
+
+You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit:
+
+ <https://info.enterprisedb.com/rs/069-ALB-339/images/Repository%20Access%2004-09-2019.pdf>
+
+After receiving your repository credentials you can:
+
+1.  Create the repository configuration file.
+2.  Modify the file, providing your user name and password.
+3.  Install `edb-odbc`.
+
+**Creating a Repository Configuration File**
+
+To create the repository configuration file, assume superuser privileges, and invoke the following command:
+
+-  On RHEL or CentOS 7:
+
+```text
+yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm
+```
+
+-  On RHEL or CentOS 8:
+
+```text
+dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm
+```
+
+The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`.
+
+**Modifying the file, providing your user name and password**
+
+After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user.
+
+```text
+[edb]
+name=EnterpriseDB RPMs $releasever - $basearch
+baseurl=https://<username>:<password>@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch
+enabled=1
+gpgcheck=1
+gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY
+```
+
+**Installing ODBC Connector**
+
+After saving your changes to the configuration file, use the following commands to install the ODBC Connector:
+
+-  On RHEL or CentOS 7:
+
+```text
+yum install edb-odbc
+
+yum install edb-odbc-devel
+```
+
+-  On RHEL or CentOS 8:
+
+```text
+dnf install edb-odbc
+
+dnf install edb-odbc-devel
+```
+
+When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue.
+
+During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve.
+
+<div id="rhel8" class="registered_link"></div>
+
+### Updating an RPM Installation
+
+If you have an existing EDB ODBC connector RPM installation, you can use yum or dnf to upgrade your repository configuration file and update to a more recent product version. To update the `edb.repo` file, assume superuser privileges and enter:
+
+-   On RHEL or CentOS 7:
+
+    ```text
+    yum upgrade edb-repo
+    ```
+
+-   On RHEL or CentOS 8:
+
+    ```text
+    dnf upgrade edb-repo
+    ```
+
+yum or dnf will update the `edb.repo` file to enable access to the current EDB repository, configured to connect with the credentials specified in your `edb.repo` file. Then, you can use yum or dnf to upgrade any installed packages:
+
+-   On RHEL or CentOS 7:
+
+    ```text
+    yum upgrade edb-odbc
+
+    yum upgrade edb-odbc-devel
+    ```
+
+-   On RHEL or CentOS 8:
+
+    ```text
+    dnf upgrade edb-odbc
+
+    dnf upgrade edb-odbc-devel
+    ```
+
+## Installing the Connector on an SLES 12 Host
+
+You can use the zypper package manager to install the connector on an SLES 12 host. zypper will attempt to satisfy package dependencies as it installs a package, but requires access to specific repositories that are not hosted at EDB. Before installing the connector, use the following commands to add EDB repository configuration files to your SLES host:
+
+```txt
+zypper addrepo
+https://zypp.enterprisedb.com/suse/epas12-sles.repo
+zypper addrepo
+https://zypp.enterprisedb.com/suse/epas-sles-tools.repo
+zypper addrepo
+https://zypp.enterprisedb.com/suse/epas-sles-dependencies.repo
+```
+
+Each command creates a repository configuration file in the `/etc/zypp/repos.d directory`. The files are named:
+
+- `Edbas12suse.repo`
+- `edbasdependencies.repo`
+- `edbastools.repo`
+
+After creating the repository configuration files, use the zypper refresh command to refresh the metadata on your SLES host to include the EDB repositories.
+
+```txt
+/etc/zypp/repos.d # zypper refresh
+```
+
+When prompted for a `User Name` and `Password`, provide your connection credentials for the EDB repository. To request credentials for the repository, visit [the EDB website](https://www.enterprisedb.com/repository-access-request).
+
+Before installing EDB Postgres Advanced Server or supporting components, you must also add SUSEConnect and the SUSE Package Hub extension to the SLES host, and register the host with SUSE, allowing access to SUSE repositories. Use the commands:
+
+```txt
+zypper install SUSEConnect  
+SUSEConnect -p PackageHub/12/x86_64  
+SUSEConnect -p sle-sdk/12/x86_64
+```
+
+For detailed information about registering a SUSE host, visit the [SUSE website](https://www.suse.com/support/kb/doc/?id=7016626).
+
+Then, you can use the zypper utility to install the connector:
+
+```txt
+zypper install edb-odbc
+
+zypper install edb-odbc-devel
+```
+
+## Installing the Connector on a Debian or Ubuntu Host
+
+To install a DEB package on a Debian or Ubuntu host, you must have credentials that allow access to the EDB repository. To request credentials for the repository, visit the [EDB website](https://www.enterprisedb.com/repository-access-request/).
+
+The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+
+1.  Assume superuser privileges:
+
+    ```text
+    sudo su –
+    ```
+
+2.  Configure the EDB repository:
+
+    ```text
+    sh -c 'echo "deb https://username:[email protected]/$(lsb_release -cs)-edb/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/edb-$(lsb_release -cs).list'
+    ```
+
+3.  Add support to your system for secure APT repositories:
+
+    ```text
+    apt-get install apt-transport-https
+    ```
+
+4.  Add the EDB signing key:
+
+    ```text
+    wget -q -O - https://<username>:<password>@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
+    ```
+
+5.  Update the repository metadata:
+
+    ```text
+    apt-get update
+    ```
+
+6.  Install DEB package:
+
+    ```text
+    apt-get install edb-odbc
+    apt-get install edb-odbc-dev
+    ```
+
+## Using the Graphical Installer to Install the Connector
+
+You can use the EDB Connectors Installation wizard to add the ODBC connector to your system; the wizard is available at the [EDB website](https://www.enterprisedb.com/software-downloads-postgres/).
+
+Download the installer, and then, right-click on the installer icon, and select `Run As Administrator` from the context menu.
+
+When the `Language Selection` popup opens, select an installation language and click `OK` to continue to the `Setup` window (shown in Figure below).
+
+![The ODBC Connectors Installation wizard.](../images/odbc_installation_wizard.png)
+
+The ODBC Connectors Installation wizard.
+
+Click `Next` to continue.
+
+![The Installation dialog.](../images/odbc_installation_dialog.png)
+
+The Installation dialog
+
+Use the `Installation Directory` dialog to specify the directory in which the connector will be installed, and click `Next` to continue.
+
+![The Ready to Install dialog.](../images/ready_to_install.png)
+
+The Ready to Install dialog.
+
+Click `Next` on the `Ready to Install` dialog to start the installation; popup dialogs confirm the progress of the installation wizard.
+
+![The installation is complete.](../images/odbc_installation_complete.png)
+ß
+he installation is complete.
+
+When the wizard informs you that it has completed the setup, click the `Finish` button to exit the dialog.
+
+You can also use StackBuilder Plus to add or update the connector on an existing Advanced Server installation; to open StackBuilder Plus, select `StackBuilder Plus` from the `Windows Apps` menu or through Linux `Start` menu.
+
+![Starting StackBuilder Plus](../images/starting_stackbuilder_plus.png)
+
+Starting StackBuilder Plus
+
+When StackBuilder Plus opens, follow the onscreen instructions. Select the `EnterpriseDB ODBC Connector` option from the `Database Drivers` node of the tree control.
+
+![Selecting the Connectors installer.](../images/selecting_the_connectors_installer.png)
+
+Selecting the Connectors installer.
+
+Follow the directions of the onscreen wizard to add or update an installation of the EDB Connectors.

product_docs/docs/odbc_connector/12.0.0.2/03_edb-odbc_overview/index.mdx

@@ -0,0 +1,26 @@
+---
+title: "EDB-ODBC Overview"
+
+legacyRedirectsGenerated:
+  # This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
+  - "/edb-docs/d/edb-postgres-odbc-connector/user-guides/odbc-guide/12.2.0.2/edb-odbc_overview.html"
+---
+
+EDB ODBC is an interface that allows an ODBC compliant client application to connect to an Advanced Server database. The EDB-ODBC connector allows an application that was designed to work with other databases to run on Advanced Server; EDB ODBC provides a way for the client application to establish a connection, send queries and retrieve results from Advanced Server.
+
+While EDB ODBC provides a level of application portability, it should be noted that the portability is limited; EDB ODBC provides a connection, but does not guarantee command compatibility. Commands that are acceptable in another database, may not work in Advanced Server.
+
+The major components in a typical ODBC application are:
+
+-   The client application - written in a language that has a binding for ODBC
+-   The ODBC Administrator - handles named connections for Windows or Linux
+-   The database specific ODBC driver - EDB ODBC
+-   The ODBC compliant server - EDB Postgres Advanced Server
+
+Client applications can be written in any language that has a binding for ODBC; C, MS-Access, and C++ are just a few.
+
+<div class="toctree" maxdepth="3">
+
+installing_edb-odbc
+
+</div>

product_docs/docs/odbc_connector/12.0.0.2/04_creating_a_data_source.mdx

@@ -0,0 +1,37 @@
+---
+title: "Creating a Data Source"
+
+legacyRedirectsGenerated:
+  # This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
+  - "/edb-docs/d/edb-postgres-odbc-connector/user-guides/odbc-guide/12.2.0.2/creating_a_data_source.html"
+---
+
+When a client application tries to establish a connection with a server, it typically provides a data source name (also known as a "DSN"). The driver manager looks through the ODBC configuration database for a data source whose name matches the DSN provided by the application.
+
+On a Linux or Unix host, data sources are defined in a file; that file is usually named /etc/odbc.ini, but the name (and location) may vary. Use the following command to find out where unixODBC is searching for data source definitions:
+
+`$ odbc_config --odbcini --odbcinstini`
+
+On a Windows host, data sources are typically defined in the Windows registry.
+
+You can also store a data source definition (called a "File DSN") in a plain-text file of your choice. A typical data source definition for the EDB-ODBC driver looks like this:
+
+```text
+$ cat /etc/odbc.ini
+[EnterpriseDB]
+Description = EnterpriseDB DSN
+Driver = EnterpriseDB
+Trace = yes
+TraceFile = /tmp/odbc.log
+Database = edb
+Servername = localhost
+UserName = enterprisedb
+Password = manager
+Port = 5444
+```
+
+The first line in the data source is the data source name. The name is a unique identifier, enclosed in square brackets. The data source name is followed by a series of `'keyword=value'` pairs that identify individual connection properties that make up the data source.
+
+The ODBC administrator utility creates named data sources for ODBC connections. In most cases, an ODBC administrator utility is distributed with the operating system (if you’re using Windows or unixODBC, the tool is called the `ODBC Data Source Administrator`). If your operating system doesn’t include an ODBC administrator, third-party options are available online.
+
+Sections `Adding a Data Source Definition in Windows` and `Adding a Data Source Definition in Linux` walk you through adding a data source in Windows and Linux using the graphical tools available for each operating system. During the process of defining a data source, you’ll be asked to specify a set of connection properties. Section `EDB-ODBC Connection Properties` contains information about `optional` data source connection properties; you can specify connection properties with graphical tools or edit the `odbc.ini` file with a text editor.