[
https://issues.apache.org/jira/browse/HAWQ-1095?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15587080#comment-15587080
]
ASF GitHub Bot commented on HAWQ-1095:
--------------------------------------
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r83974977
--- Diff: clientaccess/g-database-application-interfaces.html.md.erb ---
@@ -1,8 +1,96 @@
---
-title: ODBC/JDBC Application Interfaces
+title: HAWQ Database Drivers and APIs
---
+You may want to connect your existing Business Intelligence (BI) or
Analytics applications with HAWQ. The database application programming
interfaces most commonly used with HAWQ are the Postgres and ODBC and JDBC APIs.
-You may want to deploy your existing Business Intelligence (BI) or
Analytics applications with HAWQ. The most commonly used database application
programming interfaces with HAWQ are the ODBC and JDBC APIs.
+HAWQ provides the following connectivity tools for connecting to the
database:
+
+ - ODBC driver
+ - JDBC driver
+ - `libpq` - PostgreSQL C API
+
+## <a id="dbdriver"></a>HAWQ Drivers
+
+ODBC and JDBC drivers for HAWQ are available as a separate download from
Pivotal Network [Pivotal
Network](https://network.pivotal.io/products/pivotal-hdb).
+
+### <a id="odbc_driver"></a>ODBC Driver
+
+The ODBC API specifies a standard set of C interfaces for accessing
database management systems. For additional information on using the ODBC API,
refer to the [ODBC Programmer's
Reference](https://msdn.microsoft.com/en-us/library/ms714177(v=vs.85).aspx)
documentation.
+
+HAWQ supports the DataDirect ODBC Driver. Installation instructions for
this driver are provided on the Pivotal Network driver download page. Refer to
[HAWQ ODBC
Driver](http://media.datadirect.com/download/docs/odbc/allodbc/#page/odbc%2Fthe-greenplum-wire-protocol-driver.html%23)
for HAWQ-specific ODBC driver information.
+
+#### <a id="odbc_driver_connurl"></a>Connection Data Source
+The information required by the HAWQ ODBC driver to connect to a database
is typically stored in a named data source. Depending on your platform, you may
use
[GUI](http://media.datadirect.com/download/docs/odbc/allodbc/index.html#page/odbc%2FData_Source_Configuration_through_a_GUI_14.html%23)
or [command
line](http://media.datadirect.com/download/docs/odbc/allodbc/index.html#page/odbc%2FData_Source_Configuration_in_the_UNIX_2fLinux_odbc_13.html%23)
tools to create your data source definition. On Linux, ODBC data sources are
typically defined in a file named `odbc.ini`.
+
+Commonly-specified HAWQ ODBC data source connection properties include:
+
+| Property Name | Value
Description
|
+|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Database | name of the database to which you want to connect |
+| Driver | full path to the ODBC driver library file
|
+| HostName | HAWQ master host name
|
+| MaxLongVarcharSize | maximum size of columns of type long varchar
|
+| Password | password used to connect to the specified
database
|
+| PortNumber | HAWQ master database port number
|
+
+Refer to [Connection Option
Descriptions](http://media.datadirect.com/download/docs/odbc/allodbc/#page/odbc%2Fgreenplum-connection-option-descriptions.html%23)
for a list of ODBC connection properties supported by the HAWQ DataDirect ODBC
driver.
+
+Example HAWQ DataDirect ODBC driver data source definition:
+
+``` shell
+[HAWQ-201]
+Driver=/usr/local/hawq_drivers/odbc/lib/ddgplm27.so
+Description=DataDirect 7.1 Greenplum Wire Protocol - for HAWQ
+Database=getstartdb
+HostName=hdm1
+PortNumber=5432
+Password=changeme
+MaxLongVarcharSize=8192
+```
+
+The first line, `[HAWQ-201]`, identifies the name of the data source.
+
+ODBC connection properties may also be specified in a connection string
identifying either a data source name, the name of a file data source, or the
name of a driver. A HAWQ ODBC connection string has the following format:
+
+``` shell
+([DSN=<data_source_name>]|[FILEDSN=<filename.dsn>]|[DRIVER=<driver_name>])[;<attribute=<value>[;...]]
+```
+
+For additional information on specifying a HAWQ ODBC connection string,
refer to [Using a Connection
String](http://media.datadirect.com/download/docs/odbc/allodbc/index.html#page/odbc%2FUsing_a_Connection_String_16.html%23).
+
+### <a id="jdbc_driver"></a>JDBC Driver
+The JDBC API specifies a standard set of Java interfaces to SQL-compliant
databases. For additional information on using the JDBC API, refer to the [Java
JDBC API](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/)
documentation.
+
+HAWQ supports the DataDirect JDBC Driver. Installation instructions for
this driver are provided on the Pivotal Network driver download page. Refer to
[HAWQ JDBC
Driver](http://media.datadirect.com/download/docs/jdbc/alljdbc/help.html#page/jdbcconnect%2Fgreenplum-driver.html%23)
for HAWQ-specific JDBC driver information.
--- End diff --
Same question about URL - wondering if it's safer to ask readers to use the
docs included in the driver download.
> enhance database driver and API documentation
> ---------------------------------------------
>
> Key: HAWQ-1095
> URL: https://issues.apache.org/jira/browse/HAWQ-1095
> Project: Apache HAWQ
> Issue Type: Improvement
> Components: Documentation
> Reporter: Lisa Owen
> Assignee: David Yozie
> Priority: Minor
> Fix For: 2.0.1.0-incubating
>
>
> docs contain very brief references to JDBC/ODBC and none at all to libpq.
> add more content in these areas.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
