hawq-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lisakowen <...@git.apache.org>
Subject [GitHub] incubator-hawq-docs pull request #23: HAWQ-1095 - enhance database api docs
Date Wed, 19 Oct 2016 00:06:21 GMT
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
    +
    +## <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>[;...]]
    --- End diff --
    
    i think the driver name is the full path to the driver library.  this will differ based
on what the user enters for the install location when they run the install script.  it is
not a set driver name like with jdbc.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message