prestogres 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*~
+*.pyc
+.bundle
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org/'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    prestogres (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (0.9.6)
+    rake-compiler (0.8.3)
+      rake
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  prestogres!
+  rake (~> 0.9.2)
+  rake-compiler (~> 0.8.3)

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,22 @@
+Prestogres is licensed under Apache License, Version 2.0.
+Copyright (C) 2014 Sadayuki Furuhashi.
+
+Ruby is copyrighted free software by Yukihiro Matsumoto.
+
+pgpool-II is developed by PgPool Global Development Group.
+Permission to use, copy, modify, and distribute this software and
+its documentation for any purpose and without fee is hereby
+granted, provided that the above copyright notice appear in all
+copies and that both that copyright notice and this permission
+notice appear in supporting documentation, and that the name of the
+author not be used in advertising or publicity pertaining to
+distribution of the software without specific, written prior
+permission. The author makes no representations about the
+suitability of this software for any purpose.  It is provided "as
+is" without express or implied warranty.
+
+PostgreSQL is released under the PostgreSQL License, a liberal Open
+Source license, similar to the BSD or MIT licenses.
+Portions Copyright (c) 1996-2014, The PostgreSQL Global Development Group
+Portions Copyright (c) 1994, The Regents of the University of California
+

data/README.md

@@ -0,0 +1,217 @@
+# ![Prestogres](https://gist.github.com/frsyuki/8328440/raw/6c3a19b7132fbbf975155669f308854f70fff1e8/prestogres.png)
+## PostgreSQL protocol gateway for Presto
+
+**Prestogres** is a gateway server that allows clients to use PostgreSQL protocol to run Presto queries.
+
+* [Presto, a distributed SQL query engine for big data](https://github.com/facebook/presto)
+
+With Prestogres, you can use PostgreSQL clients to run queries on Presto:
+
+* `psql` command
+* [PostgreSQL ODBC driver](http://psqlodbc.projects.pgfoundry.org/)
+* [PostgreSQL JDBC driver](http://jdbc.postgresql.org/)
+* other PostgreSQL client libraries
+
+Prestogres also offers password-based authorization (Presto doesn't have authorization by default).
+
+## How it works?
+
+```
+       PostgreSQL protocol                     Presto protocol (HTTP)
+            /                                      /
+           /  +-----------+      +------------+   /  +--------+
+  client ---> | pgpool-II | ---> | PostgreSQL | ---> | Presto |
+              +-----------+      +------------+      +--------+
+                       \                   \
+                    rewrite queries       run custom functions
+            |                                   |
+            +-----------------------------------+
+                         Prestogres
+```
+
+1. **Client** sends a query to a patched pgpool-II
+2. **pgpool-II** rewrites the query to `SELECT run_presto_as_temp_table(..., '...original SELECT query...')` + `SELECT * FROM presto_result`.
+3. **PostgreSQL** runs `run_presto_as_temp_table`. This custom function runs a query on Presto and writes results into a temporary table `presto_result`.
+
+## Limitation
+
+* Extended query is not supported ([PostgreSQL Frontend/Backend Protocol](http://www.postgresql.org/docs/9.3/static/protocol.html))
+  * ODBC driver needs to set **UseServerSidePrepare=0** (Server side prepare: no) property
+  * JDBC driver needs to set **protocolVersion=2** property
+* DECLARE/FETCH is not supported
+
+## Installation
+
+```
+$ gem install prestogres --no-ri --no-rdoc
+```
+
+Prestogres package installs patched pgpool-II but doesn't install PostgreSQL. You need to install PostgreSQL server (with python support) separately.
+
+* If you don't have **gem** command, install Ruby >= 1.9.0 first
+* If installation failed, you may need to install following packages using apt or yum:
+  * basic toolchain (gcc, make, etc.)
+  * OpenSSL (Debian/Ubuntu: **libssl-dev**, RedHat/CentOS: **openssl-dev**)
+  * PostgreSQL server (Debian/Ubuntu: **postgresql-server-dev**, RedHat/CentOS: **postgresql-devel**)
+
+## Runing servers
+
+You need to run 2 server programs: pgpool-II and PostgreSQL. You can use `prestogres` command to setup & run them.
+
+1. Create a data directory:
+```
+$ prestogres -D pgdata setup
+```
+
+2. Configure **presto_server** and **presto_catalog** parameters at least in pgpool.conf file:
+```
+$ vi ./pgdata/pgpool/pgpool.conf
+```
+
+3. Run patched pgpool-II:
+```
+$ prestogres -D pgdata pgpool
+```
+
+4. Run PostgreSQL:
+```
+$ prestogres -D pgdata pg_ctl start
+```
+
+5. Finally, you can connect to pgpool-II using `psql` command:
+```
+$ psql -h localhost -p 9900 -U pg postgres
+```
+
+If configuration is correct, you can run `SELECT * FROM sys.node;` query. Otherwise, see log files in **./pgdata/log/** directory.
+
+#### Mac OS X
+
+You need to run following commands before running PostgreSQL on Mac OS X:
+
+```
+$ sudo sysctl -w kern.sysv.shmmax=1073741824
+$ sudo sysctl -w kern.sysv.shmall=1073741824
+```
+
+if you got following log messages:
+
+```
+FATAL:  could not create shared memory segment: Cannot allocate memory
+DETAIL:  Failed system call was shmget(key=6432001, size=3809280, 03600).
+HINT:  This error usually means that PostgreSQL's request for a shared memory segment exceeded available memory or swap space, or exceeded your kernel's SHMALL parameter.  You can either reduce the request size or reconfigure the kernel with larger SHMALL.  To reduce the request size (currently 3809280 bytes), reduce PostgreSQL's shared memory usage, perhaps by reducing shared_buffers or max_connections.
+```
+
+## Configuration
+
+### pgool.conf file
+
+Please read [pgpool-II documentation](http://www.pgpool.net/docs/latest/pgpool-en.html) for most of parameters.
+Following parameters are unique to Prestogres:
+
+* **presto_server**: Default address:port of Presto server.
+* **presto_catalog**: Default catalog (connector) name of Presto such as `hive-cdh4`, `hive-hadoop1`, etc.
+* **presto_schema**: Default schema name of Presto. You can read other schemas by qualified name like `FROM myschema.table1`
+* **presto_external_auth_prog**: Default path to an external authentication program used by `prestogres_external` authentication moethd. See following Authentication section for details.
+
+You can overwrite these parameters for each connecting users. See also following *pool_hba.conf* section.
+
+### pool_hba.conf file
+
+By default configuration, Prestogres accepts all connections from localhost without password and rejects any other connections. You can change this behavior by updating **\<data_dir\>/pgpool2/pool_hba.conf** file.
+
+See [sample pool_hba.conf file](https://github.com/treasure-data/prestogres/blob/master/config/pool_hba.conf) for details. Basic syntax is:
+
+```conf
+# TYPE   DATABASE   USER   CIDR-ADDRESS                  METHOD                OPTIONS
+host     all        all    127.0.0.1/32                  trust
+host     all        all    127.0.0.1/32,192.168.0.0/16   prestogres_md5
+host     altdb      pg     0.0.0.0/0                     prestogres_md5        server:localhost:8190,user:prestogres
+host     all        all    0.0.0.0/0                     prestogres_external   auth_prog:/opt/prestogres/auth.py
+```
+
+#### prestogres_md5 method
+
+This authentication method uses a password file **\<data_dir\>/pgpool2/pool_passwd** to authenticate an user. You can use `prestogres passwd` command to add an user to this file:
+
+```sh
+$ prestogres -D pgdata passwd myuser
+password: (enter password here)
+```
+
+In pool_hba.conf file, you can set following options to OPTIONS field:
+
+* **server**: Address:port of Presto server, which overwrites `presto_servers` parameter in pgpool.conf.
+* **catalog**: Catalog (connector) name of Presto, which overwrites `presto_catalog` parameter in pgpool.conf.
+* **schema**: Schema name of Presto, which overwrites `presto_schema` parameter in pgpool.conf.
+* **user**: User name to run queries on Presto. By default, Prestogres uses the same user name used to login to pgpool-II.
+
+
+#### prestogres_external method
+
+This authentication method uses an external file to authentication an user.
+
+- Note: This method is still experimental (because performance is slow). Interface could be changed.
+- Note: This method requires clients to send password in clear text. It's recommended to enable SSL in pgpool.conf.
+
+You need to set `presto_external_auth_prog` parameter in pgpool.conf or `auth_prog` option in pool_hba.conf. Prestogres runs the program every time when an user connects. The program receives following data through STDIN:
+
+```
+user:USER_NAME
+password:PASSWORD
+database:DATABASE
+address:IPADDR
+
+```
+
+If you want to allow this connection, the program optionally prints following lines to STDOUT, and exists with status code 0:
+
+```
+server:PRESTO_SERVER_ADDRESS
+catalog:PRESTO_CATALOG_NAME
+schema:PRESTO_SCHEMA_NAME
+
+```
+
+If you want to reject this connection, the program exists with non-0 status code.
+
+
+### prestogres command
+
+Usage of `prestogres` command:
+
+```
+usage: prestogres -D <data dir> <command>
+commands:
+  setup                 setup <data dir>
+  pgpool                start pgpool as a daemon process
+  pgpool stop           stop  pgpool daemon process
+  pgpool -n             start pgpool as a foreground process
+  pg_ctl start          start postgres server as a daemon process
+  pg_ctl stop           stop  postgres server daemon process
+  postgres              start postgres server as a foreground process
+  passwd <USER NAME>    add new md5 password entry for an user
+```
+
+## Development
+
+To install git HEAD, use following command to build:
+
+```sh
+# 1. clone prestogres repository:
+$ git clone https://github.com/treasure-data/prestogres.git
+$ cd prestogres
+
+# 2. install bundler gem and run it:
+$ gem install bundler
+$ bundle
+# if you don't have gem command, you need to install Ruby first
+
+# 3. create a gem package:
+$ bundle exec rake
+
+# 4. install the created package:
+$ gem install --no-ri --no-rdoc pkg/prestogres-0.1.0.gem
+# if this command failed, you may need to install toolchain (gcc, etc.) to build pgpool-II
+```
+