{"id":21702396,"url":"https://github.com/aphp/hiveqlkernel","last_synced_at":"2026-03-17T19:29:22.727Z","repository":{"id":57437402,"uuid":"149886021","full_name":"aphp/HiveQLKernel","owner":"aphp","description":"HiveQL Jupyter Kernel","archived":false,"fork":false,"pushed_at":"2022-08-05T14:33:17.000Z","size":63,"stargazers_count":10,"open_issues_count":8,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-12T00:33:10.455Z","etag":null,"topics":["hive","hiveql","jupyter","kernel","notebook"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aphp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-22T14:46:10.000Z","updated_at":"2022-08-05T14:33:21.000Z","dependencies_parsed_at":"2022-09-11T02:51:06.224Z","dependency_job_id":null,"html_url":"https://github.com/aphp/HiveQLKernel","commit_stats":null,"previous_names":["eds-aphp/hiveqlkernel"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aphp%2FHiveQLKernel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aphp%2FHiveQLKernel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aphp%2FHiveQLKernel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aphp%2FHiveQLKernel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aphp","download_url":"https://codeload.github.com/aphp/HiveQLKernel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586256,"owners_count":21128995,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hive","hiveql","jupyter","kernel","notebook"],"created_at":"2024-11-25T21:15:12.081Z","updated_at":"2026-03-17T19:29:22.663Z","avatar_url":"https://github.com/aphp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HiveQL Kernel\n\n### Requirements\n\nIf you are going to connect using kerberos:\n\n```\nsudo apt-get install python3-dev libsasl2-dev libsasl2-2 libsasl2-modules-gssapi-mit\n```\n\n### Installation\n\nTo install the kernel:\n\n```\npip install --upgrade hiveqlKernel\njupyter hiveql install --user\n```\n\n### Connection configuration\n\nTwo methods are available to connect to a Hive server:\n\n* Directly inside the notebook\n* Using a configuration file\n\nIf the configuration file is present, everytime you run a new HiveQL kernel it uses it, else you must configure your connection inside the notebook. The configuration in the notebook overwrites the one in the configuration file if present.\n\n#### Configure directly in the notebook cells\n\nInside a Notebook cell, copy\u0026paste this, change the configuration to match your needs, and run it.\n\n```\n$$ url=hive://\u003ckerberos-username\u003e@\u003chive-host\u003e:\u003chive-port\u003e/\u003cdb-name\u003e\n$$ connect_args={\"auth\": \"KERBEROS\", \"kerberos_service_name\": \"hive\", \"configuration\": {\"tez.queue.name\": \"myqueue\"}}\n$$ pool_size=5\n$$ max_overflow=10\n```\n\nThese args are passed to sqlalchemy, who registered pyHive as the 'hive' SQL back-end.\nSee [github.com/dropbox/PyHive](https://github.com/dropbox/PyHive/#sqlalchemy).\n\n#### Configure using a configuration file\n\nThe HiveQL kernel is looking for the configuration file at `~/.hiveql_kernel.conf` by default. You can specify another path using `HIVE_KERNEL_CONF_FILE`.\n\nThe contents must be like this (in json format):\n\n```\n{ \"url\": \"hive://\u003ckerberos-username\u003e@\u003chive-host\u003e:\u003chive-port\u003e/\u003cdb-name\u003e\", \"connect_args\" : { \"auth\": \"KERBEROS\", \"kerberos_service_name\":\"hive\", \"configuration\": {\"tez.queue.name\": \"myqueue\"}}, \"pool_size\": 5, \"max_overflow\": 10, \"default_limit\": 20, \"display_mode\": \"be\" }\n```\n\n\n### Usage\n\nInside a HiveQL kernel you can type HiveQL directly in the cells and it displays a HTML table with the results.\n\nYou also have other options, like changing the default display limit (=20) like this :\n\n```\n$$ default_limit=50\n```\n\nSome hive functions are extended. They allow to filter with some patterns.\n\n```\nSHOW TABLES \u003cpattern\u003e\nSHOW DATABASES \u003cpattern\u003e\n```\n\n\n### Run tests\n\n```\npython -m pytest\n```\n\n\nHave fun!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faphp%2Fhiveqlkernel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faphp%2Fhiveqlkernel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faphp%2Fhiveqlkernel/lists"}