From teiid-commits at lists.jboss.org Mon Jul 19 18:06:04 2010 Content-Type: multipart/mixed; boundary="===============4805695517949426823==" MIME-Version: 1.0 From: teiid-commits at lists.jboss.org To: teiid-commits at lists.jboss.org Subject: [teiid-commits] teiid SVN: r2356 - in trunk/documentation/client-developers-guide/src/main/docbook/en-US: content and 1 other directories. Date: Mon, 19 Jul 2010 18:06:04 -0400 Message-ID: <201007192206.o6JM64No005025@svn01.web.mwc.hst.phx2.redhat.com> --===============4805695517949426823== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: rareddy Date: 2010-07-19 18:06:04 -0400 (Mon, 19 Jul 2010) New Revision: 2356 Added: trunk/documentation/client-developers-guide/src/main/docbook/en-US/conte= nt/odbc.xml trunk/documentation/client-developers-guide/src/main/docbook/en-US/image= s/ trunk/documentation/client-developers-guide/src/main/docbook/en-US/image= s/winsetup1.png trunk/documentation/client-developers-guide/src/main/docbook/en-US/image= s/winsetup2.png trunk/documentation/client-developers-guide/src/main/docbook/en-US/image= s/winsetup3.png trunk/documentation/client-developers-guide/src/main/docbook/en-US/image= s/winsetup4.png trunk/documentation/client-developers-guide/src/main/docbook/en-US/image= s/winsetup5.png Modified: trunk/documentation/client-developers-guide/src/main/docbook/en-US/main.= xml Log: TEIID-860: Adding ODBC support chapter to Client Developer's Guide. Added: trunk/documentation/client-developers-guide/src/main/docbook/en-US/c= ontent/odbc.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/documentation/client-developers-guide/src/main/docbook/en-US/cont= ent/odbc.xml (rev 0) +++ trunk/documentation/client-developers-guide/src/main/docbook/en-US/cont= ent/odbc.xml 2010-07-19 22:06:04 UTC (rev 2356) @@ -0,0 +1,234 @@ + + +%CustomDTD; +]> + + ODBC Support + = + Short for Open DataBase Connectivity, a standard database access= method developed by the SQL Access group in 1992. = + The goal of ODBC is to make it possible to access any data from any ap= plication, regardless of which database management = + system (DBMS) is handling the data. ODBC manages this by inserting a m= iddle layer, called a database driver , = + between an application and the DBMS. The purpose of this layer is to t= ranslate the application's data queries = + into commands that the DBMS understands. For this to work, both the ap= plication and the DBMS must be ODBC-compliant = + -- that is, the application must be capable of issuing ODBC commands a= nd the = + DBMS must be capable of responding to them + + Teiid provides the ODBC access to deployed VDBs in the Teiid run= time through = + PostgreSQL's ODBC d= river. This is possible by redirecting the ODBC commands = + from a client application to a different port than default PostgreSQL= port. + = + By default, ODBC on the Teiid is enabled and running on o= n port 35432. + = + Before your application can use the ODBC, you must first instal= l ODBC driver on same machine that = + your application is running and then create Data Source Name (DSN) fo= r that represents a connection profile for your Teiid VDB. + + + + Installing the ODBC Driver Client + The PostgreSQL ODBC driver that is needed to make the ODBC c= onnection to Teiid is not = + bundled with Teiid distribution. The driver needs be downloaded = + directly from PostgreSQL web site. We have tested with 8= .04.200 version of the ODBC driver for = + this release. + = + + Microsoft Windows + + Download the ODBC driver from + PostgreSQL download site. + Extract the contents of the ZIP file into = a temporary location on you system. For example: "c:\temp\pgodbc" + Double click on "psqlodbc.msi" file to sta= rt installation of the driver. + + The Wizard appears as +
+ Welcome Screen + +
+ Click "Next". + + + The next step of the wizard displays. +
+ End-User License Agreement + +
+ Carefully read it, and check the "I accept the t= erms in the License Agreement", = + if you are agreeing to the licensing terms. Then click= "Next". + + + The next step of the wizard displays. +
+ Setup + +
+ If you want to install in a different directory = than the default that is already selected, = + click the "Browse" button and select a directory if yo= u want install. = + Click "Next" to start installing in the selected direc= tory. + + + The next step of the wizard displays. +
+ Confirm the Install + +
+ This step summarizes the choices you have made i= n the wizard. Review this information. = + If you need to change anything, you can use the Back b= utton to return to previous steps. = + Click "Install" to proceed. + + + 1.The installation wizard copies the necessary f= iles to the location = + you specified. When it finishes, the following screen= displays. +
+ Finish + +
+ Click "Finish" to complete. + = + + + + Other *nix Platform Installations + For all other platforms other than Microsoft Windows, th= e ODBC driver needs compiled and built from the = + source files provided. Download the ODBC driver source files f= rom = + + PostgreSQL download site. Untar the files to a tem= porary location. For example: "~/tmp/pgodbc". = + Build and install the driver by running the commands below= . + You should use super user account or use "sudo" co= mmand for running the "make install" command. + + = + Make sure that there are no errors during the "make test= " phase. The the next step in the process is to create a + DSN for accessing the Teiid VDB. + + + = + + Configuring the Data Source Name (DSN) + + Windows Installation + Once you have installed the ODBC Driver Client software = on your workstation, you have to = + configure it to connect to a Teiid Runtime. Note that the fol= lowing instructions are specific = + to the Microsoft Windows Platform. + = + To do this, you must have logged into the workstation wi= th administrative rights, and you = + need to use the Control Panel=E2=80=99s Data Sources= (ODBC) applet to add a new data source name. = + + = + Each data source name you configure can only access one = VDB within a Teiid System. To make more than = + one VDB available, you need to configure more than one data so= urce name. + = + Follow the below steps in creating a data source name (D= SN) + + From the Start menu, select Settings > Con= trol Panel. + The Control Panel displays. Double click = Administrative Tools. + Then Double-click Data Sources (= ODBC). + The ODBC Data Source Administrator applet = displays. Click the tab = + associated with the type of DSN you want to add. + The Create New Data Source dialog box disp= lays. In the Select a driver for which you = + want to set up a data source table, select Postg= reSQL Unicode. + Click Finish + The PostgreSQL ODBC DSN Setup dialog box d= isplays. + = + +
+ Main Screen + +
= + In the Data Source Name edi= t box, type the name you want to assign to this data source. + In the Database edit box, t= ype the name of the virtual database you want to access through this data s= ource. = + In the Server edit box, typ= e the host name or IP address of your Teiid runtime. If connecting = + via a firewall or NAT address, the firewall address or= NAT address should be entered. + In the Port edit box, type the port number to wh= ich the Teiid System listens for ODBC requests. By default, Teiid = + listenes for ODBC requests on port 35432 + In the User Name and Password edit boxes, supply the user name and password + for the Teiid runtime access. + Leave SSL Mode to disabled.= SSL connections are currently not supported. + Provide any description about the data source in= the Description field. + + = + + Click on the Datasource but= ton, you will see this below figure. Configure options as shown. +
+ DSN Options Page-1 + +
= + = + Click on "page2" and make sure the options are s= elected as shown +
+ DSN Options Page-2 + +
= = + + = + Click "save" and you can optionally click= "test" to validate your = + connection if the Teiid is running. + + You have configured a Teiid's virtual database as a dat= a source for your ODBC applications. Now you can = + use applications such as Excel, Access to query the data in th= e VDB = + + = + + Other *nix Platform Installations + Before you can access Teiid using ODBC on any *nix platf= orms, you need to either install a ODBC driver manager or verify = + that one already exists. As the ODBC Driver manager Teiid reco= mmends unixODBC. = + If you are working with RedHat Linux or Fedora you can check t= he graphical "yum" installer to search, find and install unixODBC. + Otherwise you can download the unixODBC manager here. = + To install, simply untar the contents of the file to a tempora= ry location and execute the following commands as super user. + + Check unixODBC<= /ulink> website site for more information, if you = + run into any issues during the installation. = + = + Now, to o verify that PostgreSQL driver installed correc= tly from earlier step, execute the following command = + + = + That should show you all the ODBC drivers installed in y= our system. Now it is time to create a DSN. = + Edit "/etc/odbc.ini" file and add the following + = + ] + Driver =3D /usr/lib/psqlodbc.so + Description =3D PostgreSQL Data Source + Servername =3D + Port =3D 35432 = + Protocol =3D 7.4 + UserName =3D = + Password =3D + Database =3D + ReadOnly =3D no + ServerType =3D Postgres + ConnSettings =3D = + UseServerSidePrepare=3D1 + ByteaAsLongVarBinary=3D1 + Optimizer=3D0 + Ksqo=3D0 + Trace =3D No + TraceFile =3D /var/log/trace.log + Debug =3D No + DebugFile =3D /var/log/debug.log = + ]]> = + = + Note that you need "sudo" permissions to edit the "/etc/= odbc.ini" file. = + For all the available configurable options that you can use in= defining a DSN can be found + here on postgreSQL ODBC page. = + = + Once you are done with defining the DSN, you can verify = your DSN using the following command = + + [ ] < commands.sq= l = + ]]> = + = + where "commands.sql" file contains the SQL commands you = would like to execute. + + = + + \ No newline at end of file Property changes on: trunk/documentation/client-developers-guide/src/main/d= ocbook/en-US/content/odbc.xml ___________________________________________________________________ Name: svn:mime-type + text/plain Added: trunk/documentation/client-developers-guide/src/main/docbook/en-US/i= mages/winsetup1.png =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D (Binary files differ) Property changes on: trunk/documentation/client-developers-guide/src/main/d= ocbook/en-US/images/winsetup1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/documentation/client-developers-guide/src/main/docbook/en-US/i= mages/winsetup2.png =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D (Binary files differ) Property changes on: trunk/documentation/client-developers-guide/src/main/d= ocbook/en-US/images/winsetup2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/documentation/client-developers-guide/src/main/docbook/en-US/i= mages/winsetup3.png =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D (Binary files differ) Property changes on: trunk/documentation/client-developers-guide/src/main/d= ocbook/en-US/images/winsetup3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/documentation/client-developers-guide/src/main/docbook/en-US/i= mages/winsetup4.png =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D (Binary files differ) Property changes on: trunk/documentation/client-developers-guide/src/main/d= ocbook/en-US/images/winsetup4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/documentation/client-developers-guide/src/main/docbook/en-US/i= mages/winsetup5.png =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D (Binary files differ) Property changes on: trunk/documentation/client-developers-guide/src/main/d= ocbook/en-US/images/winsetup5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/documentation/client-developers-guide/src/main/docbook/en-U= S/main.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/documentation/client-developers-guide/src/main/docbook/en-US/main= .xml 2010-07-16 19:13:15 UTC (rev 2355) +++ trunk/documentation/client-developers-guide/src/main/docbook/en-US/main= .xml 2010-07-19 22:06:04 UTC (rev 2356) @@ -50,6 +50,7 @@ + = --===============4805695517949426823==--