[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-19 Thread asfgit 
Github user asfgit closed the pull request at:

https://github.com/apache/incubator-hawq-docs/pull/23


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-19 Thread dyozie 
Github user dyozie commented on a diff in the pull request:

https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r84117499
  
--- 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
+
+## 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).
+
+### 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.
--- End diff --

Ok - thanks.  I think in other cases PDFs of the actual docs are included.  
This might only be in the Windows downloads.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread lisakowen 
Github user lisakowen commented on a diff in the pull request:

https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r83977371
  
--- 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
+
+## 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).
+
+### 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.
--- End diff --

users will download the readme from pivnet.  the link at the end of the 
readme points to a datadirect page from which one could navigate to the links i 
have included.

i don't see any other docs when i untar the download package.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread lisakowen 
Github user lisakowen commented on a diff in the pull request:

https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r83976521
  
--- 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
+
+## 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).
+
+### 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.
+
+ 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

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread dyozie 
Github user dyozie commented on a diff in the pull request:

https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r83974367
  
--- 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
+
+## 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).
+
+### 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.
--- End diff --

Are you sure the datadirect link contains the same info available in the 
HAWQ ODBC download?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread dyozie 
Github user dyozie commented on a diff in the pull request:

https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r83974918
  
--- 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
+
+## 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).
+
+### 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.
+
+ 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

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread dyozie 
Github user dyozie commented on a diff in the pull request:

https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r83974424
  
--- 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
+
+## 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).
+
+### 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.
+
+ 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   
|
--- End diff --

Let's initial-capitalize the second column.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread dyozie 
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
+
+## 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).
+
+### 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.
+
+ 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

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread dyozie 
Github user dyozie commented on a diff in the pull request:

https://github.com/apache/incubator-hawq-docs/pull/23#discussion_r83974668
  
--- 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
+
+## 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).
+
+### 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.
+
+ 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

[GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs

2016-10-18 Thread lisakowen 
GitHub user lisakowen opened a pull request:

https://github.com/apache/incubator-hawq-docs/pull/23

HAWQ-1095 - enhance database api docs

add content for jdbc, odbc, libpq


You can merge this pull request into a Git repository by running:

$ git pull https://github.com/lisakowen/incubator-hawq-docs 
feature/dbapiinfo

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/incubator-hawq-docs/pull/23.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #23


commit 2c0f4b19bb2baef545467c9d39f097344c6358b2
Author: Lisa Owen 
Date:   2016-10-04T19:25:29Z

restructure db API section; add libpq and links to driver and api docs

commit f066326f0241050a22a8b592fcaae3aab037c504
Author: Lisa Owen 
Date:   2016-10-04T20:36:41Z

clarify some statements

commit fbb0571df9cdb1ba05a2ba970b560cb6388b72eb
Author: Lisa Owen 
Date:   2016-10-04T23:11:07Z

hawq supports datadirect drivers

commit df2aaed3aab20b9d0fffa0c62df8a23c33864065
Author: Lisa Owen 
Date:   2016-10-04T23:26:02Z

update driver names

commit 245633e69bd0017f43a5cc20e82c9a5fc23b4079
Author: Lisa Owen 
Date:   2016-10-05T21:56:36Z

provide locations of libpq lib and include file

commit 57d76d2b86014f772754ca70cab95e4c337a71a2
Author: Lisa Owen 
Date:   2016-10-07T16:02:22Z

add jdbc connection string and example

commit 70e45af7d24a6699840eec176603b4b835121bef
Author: Lisa Owen 
Date:   2016-10-07T23:48:39Z

flesh out jdbc section; add connection URL specs

commit 3288da3e8ce51482e1d6e6913a237cbf5fc0bc8e
Author: Lisa Owen 
Date:   2016-10-10T19:08:48Z

db drivers and apis - flesh out odbc section




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---