{"author":"Jing Wang","author_email":"jing@dropbox.com","bugtrack_url":null,"classifiers":["Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: OS Independent","Topic :: Database :: Front-Ends"],"description":"================================\nProject is currently unsupported\n================================\n\n\n\n\n.. image:: https://travis-ci.org/dropbox/PyHive.svg?branch=master\n :target: https://travis-ci.org/dropbox/PyHive\n.. image:: https://img.shields.io/codecov/c/github/dropbox/PyHive.svg\n\n======\nPyHive\n======\n\nPyHive is a collection of Python `DB-API `_ and\n`SQLAlchemy `_ interfaces for `Presto `_ ,\n`Hive `_ and `Trino `_.\n\nUsage\n=====\n\nDB-API\n------\n.. code-block:: python\n\n from pyhive import presto # or import hive or import trino\n cursor = presto.connect('localhost').cursor() # or use hive.connect or use trino.connect\n cursor.execute('SELECT * FROM my_awesome_data LIMIT 10')\n print cursor.fetchone()\n print cursor.fetchall()\n\nDB-API (asynchronous)\n---------------------\n.. code-block:: python\n\n from pyhive import hive\n from TCLIService.ttypes import TOperationState\n cursor = hive.connect('localhost').cursor()\n cursor.execute('SELECT * FROM my_awesome_data LIMIT 10', async=True)\n\n status = cursor.poll().operationState\n while status in (TOperationState.INITIALIZED_STATE, TOperationState.RUNNING_STATE):\n logs = cursor.fetch_logs()\n for message in logs:\n print message\n\n # If needed, an asynchronous query can be cancelled at any time with:\n # cursor.cancel()\n\n status = cursor.poll().operationState\n\n print cursor.fetchall()\n\nIn Python 3.7 `async` became a keyword; you can use `async_` instead:\n\n.. code-block:: python\n\n cursor.execute('SELECT * FROM my_awesome_data LIMIT 10', async_=True)\n\n\nSQLAlchemy\n----------\nFirst install this package to register it with SQLAlchemy, see ``entry_points`` in ``setup.py``.\n\n.. code-block:: python\n\n from sqlalchemy import *\n from sqlalchemy.engine import create_engine\n from sqlalchemy.schema import *\n # Presto\n engine = create_engine('presto://localhost:8080/hive/default')\n # Trino\n engine = create_engine('trino+pyhive://localhost:8080/hive/default')\n # Hive\n engine = create_engine('hive://localhost:10000/default')\n\n # SQLAlchemy < 2.0\n logs = Table('my_awesome_data', MetaData(bind=engine), autoload=True)\n print select([func.count('*')], from_obj=logs).scalar()\n\n # Hive + HTTPS + LDAP or basic Auth\n engine = create_engine('hive+https://username:password@localhost:10000/')\n logs = Table('my_awesome_data', MetaData(bind=engine), autoload=True)\n print select([func.count('*')], from_obj=logs).scalar()\n\n # SQLAlchemy >= 2.0\n metadata_obj = MetaData()\n books = Table(\"books\", metadata_obj, Column(\"id\", Integer), Column(\"title\", String), Column(\"primary_author\", String))\n metadata_obj.create_all(engine)\n inspector = inspect(engine)\n inspector.get_columns('books')\n\n with engine.connect() as con:\n data = [{ \"id\": 1, \"title\": \"The Hobbit\", \"primary_author\": \"Tolkien\" }, \n { \"id\": 2, \"title\": \"The Silmarillion\", \"primary_author\": \"Tolkien\" }]\n con.execute(books.insert(), data[0])\n result = con.execute(text(\"select * from books\"))\n print(result.fetchall())\n\nNote: query generation functionality is not exhaustive or fully tested, but there should be no\nproblem with raw SQL.\n\nPassing session configuration\n-----------------------------\n\n.. code-block:: python\n\n # DB-API\n hive.connect('localhost', configuration={'hive.exec.reducers.max': '123'})\n presto.connect('localhost', session_props={'query_max_run_time': '1234m'})\n trino.connect('localhost', session_props={'query_max_run_time': '1234m'})\n # SQLAlchemy\n create_engine(\n 'presto://user@host:443/hive',\n connect_args={'protocol': 'https',\n 'session_props': {'query_max_run_time': '1234m'}}\n )\n create_engine(\n 'trino+pyhive://user@host:443/hive',\n connect_args={'protocol': 'https',\n 'session_props': {'query_max_run_time': '1234m'}}\n )\n create_engine(\n 'hive://user@host:10000/database',\n connect_args={'configuration': {'hive.exec.reducers.max': '123'}},\n )\n # SQLAlchemy with LDAP\n create_engine(\n 'hive://user:password@host:10000/database',\n connect_args={'auth': 'LDAP'},\n )\n\nRequirements\n============\n\nInstall using\n\n- ``pip install 'pyhive[hive]'`` or ``pip install 'pyhive[hive_pure_sasl]'`` for the Hive interface\n- ``pip install 'pyhive[presto]'`` for the Presto interface\n- ``pip install 'pyhive[trino]'`` for the Trino interface\n\nNote: ``'pyhive[hive]'`` extras uses `sasl `_ that doesn't support Python 3.11, See `github issue `_.\nHence PyHive also supports `pure-sasl `_ via additional extras ``'pyhive[hive_pure_sasl]'`` which support Python 3.11.\n\nPyHive works with\n\n- Python 2.7 / Python 3\n- For Presto: `Presto installation `_\n- For Trino: `Trino installation `_\n- For Hive: `HiveServer2 `_ daemon\n\nChangelog\n=========\nSee https://github.com/dropbox/PyHive/releases.\n\nContributing\n============\n- Please fill out the Dropbox Contributor License Agreement at https://opensource.dropbox.com/cla/ and note this in your pull request.\n- Changes must come with tests, with the exception of trivial things like fixing comments. See .travis.yml for the test environment setup.\n- Notes on project scope:\n\n - This project is intended to be a minimal Hive/Presto client that does that one thing and nothing else.\n Features that can be implemented on top of PyHive, such integration with your favorite data analysis library, are likely out of scope.\n - We prefer having a small number of generic features over a large number of specialized, inflexible features.\n For example, the Presto code takes an arbitrary ``requests_session`` argument for customizing HTTP calls, as opposed to having a separate parameter/branch for each ``requests`` option.\n\nTips for test environment setup\n================================\nYou can setup test environment by following ``.travis.yaml`` in this repository. It uses `Cloudera's CDH 5 `_ which requires username and password for download.\nIt may not be feasible for everyone to get those credentials. Hence below are alternative instructions to setup test environment.\n\nYou can clone `this repository `_ which has Docker Compose setup for Presto and Hive.\nYou can add below lines to its docker-compose.yaml to start Trino in same environment::\n \n trino:\n image: trinodb/trino:351 \n ports: \n - \"18080:18080\" \n volumes: \n - ./trino:/etc/trino\n\nNote: ``./trino`` for docker volume defined above is `trino config from PyHive repository `_\n\nThen run::\n docker-compose up -d\n\nTesting\n=======\n.. image:: https://travis-ci.org/dropbox/PyHive.svg\n :target: https://travis-ci.org/dropbox/PyHive\n.. image:: http://codecov.io/github/dropbox/PyHive/coverage.svg?branch=master\n :target: http://codecov.io/github/dropbox/PyHive?branch=master\n\nRun the following in an environment with Hive/Presto::\n\n ./scripts/make_test_tables.sh\n virtualenv --no-site-packages env\n source env/bin/activate\n pip install -e .\n pip install -r dev_requirements.txt\n py.test\n\nWARNING: This drops/creates tables named ``one_row``, ``one_row_complex``, and ``many_rows``, plus a\ndatabase called ``pyhive_test_database``.\n\nUpdating TCLIService\n====================\n\nThe TCLIService module is autogenerated using a ``TCLIService.thrift`` file. To update it, the\n``generate.py`` file can be used: ``python generate.py ``. When left blank, the\nversion for Hive 2.3 will be downloaded.\n","description_content_type":"","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/dropbox/PyHive","keywords":"","license":"Apache License, Version 2.0","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"PyHive","package_url":"https://pypi.org/project/PyHive/","platform":null,"project_url":"https://pypi.org/project/PyHive/","project_urls":{"Homepage":"https://github.com/dropbox/PyHive"},"provides_extra":null,"release_url":"https://pypi.org/project/PyHive/0.7.0/","requires_dist":null,"requires_python":"","summary":"Python interface to Hive","version":"0.7.0","yanked":false,"yanked_reason":null}

Package search

PyHive

project_urls

Dependencies

All package metadata

Releases