You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hawq.apache.org by yo...@apache.org on 2016/10/19 17:26:27 UTC
[01/10] incubator-hawq-docs git commit: restructure db API section;
add libpq and links to driver and api docs
Repository: incubator-hawq-docs
Updated Branches:
refs/heads/develop 0b4e1daf8 -> 8c10c5509
restructure db API section; add libpq and links to driver and api docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/2c0f4b19
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/2c0f4b19
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/2c0f4b19
Branch: refs/heads/develop
Commit: 2c0f4b19bb2baef545467c9d39f097344c6358b2
Parents: e169704
Author: Lisa Owen <lo...@pivotal.io>
Authored: Tue Oct 4 12:25:29 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Tue Oct 4 12:25:29 2016 -0700
----------------------------------------------------------------------
...-database-application-interfaces.html.md.erb | 31 ++++++++++++++++++--
1 file changed, 28 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/2c0f4b19/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index 6694f65..eb58559 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -1,8 +1,33 @@
---
-title: ODBC/JDBC Application Interfaces
+title: HAWQ Database Drivers and 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.
-ODBC/JDBC drivers are available as a separate download via Pivotal Network [Pivotal Network](https://network.pivotal.io/products/pivotal-hdb).
+HAWQ provides the following connectivity tools for connecting to the HAWQ database:
+
+ - `psqlODBC` - PostgreSQL ODBC driver
+ - PostgreSQL JDBC Interface - PostgreSQL JDBC driver
+ - `libpq` - PostgreSQL C API
+
+## <a id="dbdriver"></a>PostgreSQL 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="psqlodbc_driver"></a>psqlODBC Driver
+`psqlODBC` is the official PostgreSQL ODBC Driver. The driver is currently maintained by a number of contributors to the [PostgreSQL ODBC driver project](https://odbc.postgresql.org/). `psqlODBC` is released under the Library General Public Licence, or LGPL.
+
+### <a id="postgresjdbc_driver"></a>PostgreSQL JDBC Driver
+The JDBC API specifies a standard set of interfaces to SQL-compliant databases.
+
+PostgreSQL provides a type 4 JDBC driver. Type 4 indicates that the driver is written in Pure Java, and communicates in the database system's own network protocol. The driver is currently maintained by a number of contributors to the [PostgreSQL JDBC driver project](http://jdbc.postgresql.org). The PostgreSQL JDBC Interface has not been modified from the original PostgreSQL distribution.
+
+For additional information on using the PostgreSQL JDBC driver, refer to [The PostgreSQL JDBC Interface](https://jdbc.postgresql.org/documentation/82/index.html) documentation.
+
+## <a id="libpq_api"></a>libpq API
+`libpq` is the C API to PostgreSQL/HAWQ. This API provides a set of library functions enabling client programs to pass queries to the PostgreSQL backend server and to receive the results of those queries.
+
+`libpq` is included in your HAWQ distribution.
+
+For additional information on using the `libpq` API, refer to [libpq - C Library](https://www.postgresql.org/docs/8.2/static/libpq.html) in the PostgreSQL documentation.
+
[04/10] incubator-hawq-docs git commit: update driver names
Posted by yo...@apache.org.
update driver names
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/df2aaed3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/df2aaed3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/df2aaed3
Branch: refs/heads/develop
Commit: df2aaed3aab20b9d0fffa0c62df8a23c33864065
Parents: fbb0571
Author: Lisa Owen <lo...@pivotal.io>
Authored: Tue Oct 4 16:26:02 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Tue Oct 4 16:26:02 2016 -0700
----------------------------------------------------------------------
clientaccess/g-database-application-interfaces.html.md.erb | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/df2aaed3/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index ebd9282..4331940 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -6,8 +6,8 @@ You may want to deploy your existing Business Intelligence (BI) or Analytics app
HAWQ provides the following connectivity tools for connecting to the HAWQ database:
- - `psqlODBC` - PostgreSQL ODBC driver
- - PostgreSQL JDBC Interface - PostgreSQL JDBC driver
+ - ODBC driver
+ - JDBC driver
- `libpq` - PostgreSQL C API
## <a id="dbdriver"></a>HAWQ Drivers
[02/10] incubator-hawq-docs git commit: clarify some statements
Posted by yo...@apache.org.
clarify some statements
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/f066326f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/f066326f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/f066326f
Branch: refs/heads/develop
Commit: f066326f0241050a22a8b592fcaae3aab037c504
Parents: 2c0f4b1
Author: Lisa Owen <lo...@pivotal.io>
Authored: Tue Oct 4 13:36:41 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Tue Oct 4 13:36:41 2016 -0700
----------------------------------------------------------------------
clientaccess/g-database-application-interfaces.html.md.erb | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/f066326f/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index eb58559..e125536 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -2,7 +2,7 @@
title: HAWQ Database Drivers and 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.
+You may want to deploy your existing Business Intelligence (BI) or Analytics applications with HAWQ. The database application programming interfaces most commonly used with HAWQ are the ODBC and JDBC APIs.
HAWQ provides the following connectivity tools for connecting to the HAWQ database:
@@ -15,10 +15,13 @@ HAWQ provides the following connectivity tools for connecting to the HAWQ databa
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="psqlodbc_driver"></a>psqlODBC Driver
+
+The ODBC API specifies a standard set of C interfaces for accessing database management systems.
+
`psqlODBC` is the official PostgreSQL ODBC Driver. The driver is currently maintained by a number of contributors to the [PostgreSQL ODBC driver project](https://odbc.postgresql.org/). `psqlODBC` is released under the Library General Public Licence, or LGPL.
### <a id="postgresjdbc_driver"></a>PostgreSQL JDBC Driver
-The JDBC API specifies a standard set of interfaces to SQL-compliant databases.
+The JDBC API specifies a standard set of Java interfaces to SQL-compliant databases.
PostgreSQL provides a type 4 JDBC driver. Type 4 indicates that the driver is written in Pure Java, and communicates in the database system's own network protocol. The driver is currently maintained by a number of contributors to the [PostgreSQL JDBC driver project](http://jdbc.postgresql.org). The PostgreSQL JDBC Interface has not been modified from the original PostgreSQL distribution.
[10/10] incubator-hawq-docs git commit: Merge branch
'feature/dbapiinfo' of https://github.com/lisakowen/incubator-hawq-docs into
develop
Posted by yo...@apache.org.
Merge branch 'feature/dbapiinfo' of https://github.com/lisakowen/incubator-hawq-docs into develop
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/8c10c550
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/8c10c550
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/8c10c550
Branch: refs/heads/develop
Commit: 8c10c5509c408e049193b83c6797ef71b4152376
Parents: 0b4e1da d6e8966
Author: David Yozie <yo...@apache.org>
Authored: Wed Oct 19 10:26:20 2016 -0700
Committer: David Yozie <yo...@apache.org>
Committed: Wed Oct 19 10:26:20 2016 -0700
----------------------------------------------------------------------
...-database-application-interfaces.html.md.erb | 94 +++++++++++++++++++-
1 file changed, 91 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
[05/10] incubator-hawq-docs git commit: provide locations of libpq
lib and include file
Posted by yo...@apache.org.
provide locations of libpq lib and include file
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/245633e6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/245633e6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/245633e6
Branch: refs/heads/develop
Commit: 245633e69bd0017f43a5cc20e82c9a5fc23b4079
Parents: df2aaed
Author: Lisa Owen <lo...@pivotal.io>
Authored: Wed Oct 5 14:56:36 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Wed Oct 5 14:56:36 2016 -0700
----------------------------------------------------------------------
clientaccess/g-database-application-interfaces.html.md.erb | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/245633e6/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index 4331940..945f6cb 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -4,7 +4,7 @@ title: HAWQ Database Drivers and APIs
You may want to deploy your existing Business Intelligence (BI) or Analytics applications with HAWQ. The database application programming interfaces most commonly used with HAWQ are the ODBC and JDBC APIs.
-HAWQ provides the following connectivity tools for connecting to the HAWQ database:
+HAWQ provides the following connectivity tools for connecting to the database:
- ODBC driver
- JDBC driver
@@ -21,7 +21,7 @@ The ODBC API specifies a standard set of C interfaces for accessing database man
HAWQ supports the DataDirect ODBC Driver. Installation instructions for this driver are provided on the Pivotal Network download page.
### <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 JDBC API with PostgreSQL drivers, refer to [The PostgreSQL JDBC Interface](https://jdbc.postgresql.org/documentation/82/index.html) documentation.
+The JDBC API specifies a standard set of Java interfaces to SQL-compliant databases. For additional information on using the JDBC API with PostgreSQL drivers, refer to [The PostgreSQL JDBC Interface](https://jdbc.postgresql.org/documentation/82/index.html) documentation.
HAWQ supports the DataDirect JDBC Driver. Installation instructions for this driver are provided on the Pivotal Network download page.
@@ -29,7 +29,7 @@ HAWQ supports the DataDirect JDBC Driver. Installation instructions for this dri
## <a id="libpq_api"></a>libpq API
`libpq` is the C API to PostgreSQL/HAWQ. This API provides a set of library functions enabling client programs to pass queries to the PostgreSQL backend server and to receive the results of those queries.
-`libpq` is included in your HAWQ distribution.
+`libpq` is included in the `lib/` directory of your HAWQ distribution. `libpq-fe.h`, the header file required for developing frontend PostgreSQL applications can be found in the `/include` directory.
For additional information on using the `libpq` API, refer to [libpq - C Library](https://www.postgresql.org/docs/8.2/static/libpq.html) in the PostgreSQL documentation.
[03/10] incubator-hawq-docs git commit: hawq supports datadirect
drivers
Posted by yo...@apache.org.
hawq supports datadirect drivers
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/fbb0571d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/fbb0571d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/fbb0571d
Branch: refs/heads/develop
Commit: fbb0571df9cdb1ba05a2ba970b560cb6388b72eb
Parents: f066326
Author: Lisa Owen <lo...@pivotal.io>
Authored: Tue Oct 4 16:11:07 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Tue Oct 4 16:11:07 2016 -0700
----------------------------------------------------------------------
.../g-database-application-interfaces.html.md.erb | 15 +++++++--------
1 file changed, 7 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/fbb0571d/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index e125536..ebd9282 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -10,22 +10,21 @@ HAWQ provides the following connectivity tools for connecting to the HAWQ databa
- PostgreSQL JDBC Interface - PostgreSQL JDBC driver
- `libpq` - PostgreSQL C API
-## <a id="dbdriver"></a>PostgreSQL Drivers
+## <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="psqlodbc_driver"></a>psqlODBC Driver
+### <a id="odbc_driver"></a>ODBC Driver
-The ODBC API specifies a standard set of C interfaces for accessing database management systems.
+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.
-`psqlODBC` is the official PostgreSQL ODBC Driver. The driver is currently maintained by a number of contributors to the [PostgreSQL ODBC driver project](https://odbc.postgresql.org/). `psqlODBC` is released under the Library General Public Licence, or LGPL.
+HAWQ supports the DataDirect ODBC Driver. Installation instructions for this driver are provided on the Pivotal Network download page.
-### <a id="postgresjdbc_driver"></a>PostgreSQL JDBC Driver
-The JDBC API specifies a standard set of Java interfaces to SQL-compliant databases.
+### <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 JDBC API with PostgreSQL drivers, refer to [The PostgreSQL JDBC Interface](https://jdbc.postgresql.org/documentation/82/index.html) documentation.
-PostgreSQL provides a type 4 JDBC driver. Type 4 indicates that the driver is written in Pure Java, and communicates in the database system's own network protocol. The driver is currently maintained by a number of contributors to the [PostgreSQL JDBC driver project](http://jdbc.postgresql.org). The PostgreSQL JDBC Interface has not been modified from the original PostgreSQL distribution.
+HAWQ supports the DataDirect JDBC Driver. Installation instructions for this driver are provided on the Pivotal Network download page.
-For additional information on using the PostgreSQL JDBC driver, refer to [The PostgreSQL JDBC Interface](https://jdbc.postgresql.org/documentation/82/index.html) documentation.
## <a id="libpq_api"></a>libpq API
`libpq` is the C API to PostgreSQL/HAWQ. This API provides a set of library functions enabling client programs to pass queries to the PostgreSQL backend server and to receive the results of those queries.
[07/10] incubator-hawq-docs git commit: flesh out jdbc section;
add connection URL specs
Posted by yo...@apache.org.
flesh out jdbc section; add connection URL specs
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/70e45af7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/70e45af7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/70e45af7
Branch: refs/heads/develop
Commit: 70e45af7d24a6699840eec176603b4b835121bef
Parents: 57d76d2
Author: Lisa Owen <lo...@pivotal.io>
Authored: Fri Oct 7 16:48:39 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Fri Oct 7 16:48:39 2016 -0700
----------------------------------------------------------------------
...-database-application-interfaces.html.md.erb | 37 +++++++++++++++-----
1 file changed, 28 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/70e45af7/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index b68a3b6..944c93b 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -2,7 +2,7 @@
title: HAWQ Database Drivers and APIs
---
-You may want to deploy your existing Business Intelligence (BI) or Analytics applications with HAWQ. The database application programming interfaces most commonly used with HAWQ are the ODBC and JDBC 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 ODBC and JDBC APIs.
HAWQ provides the following connectivity tools for connecting to the database:
@@ -18,30 +18,49 @@ ODBC and JDBC drivers for HAWQ are available as a separate download from Pivotal
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 download page.
+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 stored in a data source. ODBC data sources can be defined at the system level or the user level.
+
+Certain environment variables must be set when using the HAWQ ODBC driver. On Linux this includes `$ODBCINI`, which points to the fully-qualified path to the ODBC system information file, typically named `odbc.ini`.
+
+Depending on your platform, you may use GUI or command line editor tools to create your data source definition.
+
### <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 with PostgreSQL drivers, refer to [The PostgreSQL JDBC Interface](https://jdbc.postgresql.org/documentation/82/index.html) documentation.
+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 download page.
+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.
-The connection URL for accessing the HAWQ DataDirect JDBC driver is of the following format:
+#### <a id="jdbc_driver_connurl"></a>Connection URL
+Connection URLs for accessing the HAWQ DataDirect JDBC driver must be in the following format:
``` shell
-jdbc:pivotal:greenplum://host:port;DatabaseName=<name>;
+jdbc:pivotal:greenplum://host:port[;<property>=<value>[;...]]
```
-For example:
+Commonly-specified HAWQ JDBC connection properties include:
+
+| Property Name | Value Description |
+|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| DatabaseName | name of the database to which you want to connect |
+| User | username used to connect to the specified database |
+| Password | password used to connect to the specified database |
+
+Refer to [Connection Properties](http://media.datadirect.com/download/docs/jdbc/alljdbc/help.html#page/jdbcconnect%2FConnection_Properties_10.html%23) for a list of JDBC connection properties supported by the HAWQ DataDirect JDBC driver.
+
+Example HAWQ JDBC connection string:
``` shell
-jdbc:pivotal:greenplum://hdm1:5432;DatabaseName=gpadmin;
+jdbc:pivotal:greenplum://hdm1:5432;DatabaseName=gpadmin;User=hdbuser;Password=hdbpass
```
## <a id="libpq_api"></a>libpq API
`libpq` is the C API to PostgreSQL/HAWQ. This API provides a set of library functions enabling client programs to pass queries to the PostgreSQL backend server and to receive the results of those queries.
-`libpq` is included in the `lib/` directory of your HAWQ distribution. `libpq-fe.h`, the header file required for developing frontend PostgreSQL applications can be found in the `/include` directory.
+`libpq` is installed in the `lib/` directory of your HAWQ distribution. `libpq-fe.h`, the header file required for developing front-end PostgreSQL applications, can be found in the `include/` directory.
For additional information on using the `libpq` API, refer to [libpq - C Library](https://www.postgresql.org/docs/8.2/static/libpq.html) in the PostgreSQL documentation.
[09/10] incubator-hawq-docs git commit: table entries to start with
initial caps
Posted by yo...@apache.org.
table entries to start with initial caps
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/d6e89660
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/d6e89660
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/d6e89660
Branch: refs/heads/develop
Commit: d6e8966025994d156ea7107bf884fffe196d67ed
Parents: 3288da3
Author: Lisa Owen <lo...@pivotal.io>
Authored: Tue Oct 18 17:07:58 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Tue Oct 18 17:07:58 2016 -0700
----------------------------------------------------------------------
.../g-database-application-interfaces.html.md.erb | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/d6e89660/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index 93ef5e8..29e22c5 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -27,12 +27,12 @@ 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 |
+| 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.
@@ -75,9 +75,9 @@ Commonly-specified HAWQ JDBC connection properties include:
| Property Name | Value Description |
|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| DatabaseName | name of the database to which you want to connect |
-| User | username used to connect to the specified database |
-| Password | password used to connect to the specified database |
+| DatabaseName | Name of the database to which you want to connect. |
+| User | Username used to connect to the specified database. |
+| Password | Password used to connect to the specified database. |
Refer to [Connection Properties](http://media.datadirect.com/download/docs/jdbc/alljdbc/help.html#page/jdbcconnect%2FConnection_Properties_10.html%23) for a list of JDBC connection properties supported by the HAWQ DataDirect JDBC driver.
[06/10] incubator-hawq-docs git commit: add jdbc connection string
and example
Posted by yo...@apache.org.
add jdbc connection string and example
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/57d76d2b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/57d76d2b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/57d76d2b
Branch: refs/heads/develop
Commit: 57d76d2b86014f772754ca70cab95e4c337a71a2
Parents: 245633e
Author: Lisa Owen <lo...@pivotal.io>
Authored: Fri Oct 7 09:02:22 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Fri Oct 7 09:02:22 2016 -0700
----------------------------------------------------------------------
.../g-database-application-interfaces.html.md.erb | 12 ++++++++++++
1 file changed, 12 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/57d76d2b/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index 945f6cb..b68a3b6 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -25,6 +25,18 @@ The JDBC API specifies a standard set of Java interfaces to SQL-compliant databa
HAWQ supports the DataDirect JDBC Driver. Installation instructions for this driver are provided on the Pivotal Network download page.
+The connection URL for accessing the HAWQ DataDirect JDBC driver is of the following format:
+
+``` shell
+jdbc:pivotal:greenplum://host:port;DatabaseName=<name>;
+```
+
+For example:
+
+``` shell
+jdbc:pivotal:greenplum://hdm1:5432;DatabaseName=gpadmin;
+```
+
## <a id="libpq_api"></a>libpq API
`libpq` is the C API to PostgreSQL/HAWQ. This API provides a set of library functions enabling client programs to pass queries to the PostgreSQL backend server and to receive the results of those queries.
[08/10] incubator-hawq-docs git commit: db drivers and apis - flesh
out odbc section
Posted by yo...@apache.org.
db drivers and apis - flesh out odbc section
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/3288da3e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/3288da3e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/3288da3e
Branch: refs/heads/develop
Commit: 3288da3e8ce51482e1d6e6913a237cbf5fc0bc8e
Parents: 70e45af
Author: Lisa Owen <lo...@pivotal.io>
Authored: Mon Oct 10 12:08:48 2016 -0700
Committer: Lisa Owen <lo...@pivotal.io>
Committed: Mon Oct 10 12:08:48 2016 -0700
----------------------------------------------------------------------
...-database-application-interfaces.html.md.erb | 42 +++++++++++++++++---
1 file changed, 36 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/3288da3e/clientaccess/g-database-application-interfaces.html.md.erb
----------------------------------------------------------------------
diff --git a/clientaccess/g-database-application-interfaces.html.md.erb b/clientaccess/g-database-application-interfaces.html.md.erb
index 944c93b..93ef5e8 100644
--- a/clientaccess/g-database-application-interfaces.html.md.erb
+++ b/clientaccess/g-database-application-interfaces.html.md.erb
@@ -2,7 +2,7 @@
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 ODBC and JDBC 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.
HAWQ provides the following connectivity tools for connecting to the database:
@@ -21,12 +21,43 @@ The ODBC API specifies a standard set of C interfaces for accessing database man
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 stored in a data source. ODBC data sources can be defined at the system level or the user level.
+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`.
-Certain environment variables must be set when using the HAWQ ODBC driver. On Linux this includes `$ODBCINI`, which points to the fully-qualified path to the ODBC system information file, typically named `odbc.ini`.
+Commonly-specified HAWQ ODBC data source connection properties include:
-Depending on your platform, you may use GUI or command line editor tools to create your data source definition.
+| 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.
@@ -53,10 +84,9 @@ Refer to [Connection Properties](http://media.datadirect.com/download/docs/jdbc/
Example HAWQ JDBC connection string:
``` shell
-jdbc:pivotal:greenplum://hdm1:5432;DatabaseName=gpadmin;User=hdbuser;Password=hdbpass
+jdbc:pivotal:greenplum://hdm1:5432;DatabaseName=getstartdb;User=hdbuser;Password=hdbpass
```
-
## <a id="libpq_api"></a>libpq API
`libpq` is the C API to PostgreSQL/HAWQ. This API provides a set of library functions enabling client programs to pass queries to the PostgreSQL backend server and to receive the results of those queries.