{"author":"Yongjie Zhao","author_email":"yongjie.zhao@kyligence.io","bugtrack_url":null,"classifiers":["Environment :: Console","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 2.7","Programming Language :: Python :: 3"],"description":".. image:: https://img.shields.io/pypi/v/kylinpy.svg\n :target: https://pypi.python.org/pypi/kylinpy\n.. image:: https://img.shields.io/github/license/kyligence/kylinpy.svg\n :target: https://pypi.python.org/pypi/kylinpy\n.. image:: https://img.shields.io/pypi/pyversions/kylinpy.svg\n :target: https://pypi.python.org/pypi/kylinpy\n.. image:: https://img.shields.io/pypi/dm/kylinpy.svg\n :target: https://pypi.python.org/pypi/kylinpy\n.. image:: https://codecov.io/gh/zhaoyongjie/kylinpy/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/zhaoyongjie/kylinpy\n\nApache Kylin Python Client Library\n==================================\nApache Kylin Python Client Library is a python-based Apache Kylin client.\n\nAny application that uses SQLAlchemy can now query Apache Kylin with this Apache Kylin dialect installed.\n\n\nInstallation\n------------\n\nThe easiest way to install Apache Kylin Python Client Library is to use pip::\n\n pip install kylinpy\n\nalternative, install by offline tarball package::\n\n # download from https://pypi.org/project/kylinpy/#files\n pip install kylinpy-.tar.gz\n\n\nApache Kylin dialect for SQLAlchemy\n-----------------------------------\nAny application that uses SQLAlchemy can now query Apache Kylin with this Apache Kylin dialect installed.\n\nYou may use below template to build DSN to connect Apache Kylin::\n\n kylin://:@:/?=&=\n\n\n============================= ================= =======================\nDSN Fields Default Allow omitted\n============================= ================= =======================\nusername null false\n----------------------------- ----------------- -----------------------\npassword null false\n----------------------------- ----------------- -----------------------\nhostname null false\n----------------------------- ----------------- -----------------------\nport 7070 true\n----------------------------- ----------------- -----------------------\nproject null false\n============================= ================= =======================\n\n\nDSN query string config is as follows\n\n\n=========== ================== ================= ==================\n Fields Default Value Optional value Description\n=========== ================== ================= ==================\nis_ssl 0 0|1 Is the Kylin cluster enabled for https\n----------- ------------------ ----------------- ------------------\nprefix /kylin/api string Kylin cluster API prefix\n----------- ------------------ ----------------- ------------------\ntimeout 30 integer > 0 HTTP timeout with Kylin cluster\n----------- ------------------ ----------------- ------------------\nversion v1 v1|v2|v4 v1 == using Apache Kylin API\n\n v2 == using Kyligence Enterprise 3 API\n\n v4 == using Kyligence Enterprise 4 API\n----------- ------------------ ----------------- ------------------\nis_pushdown 0 0|1 If enabled, viewing a project table will use the hive source table\n----------- ------------------ ----------------- ------------------\nis_debug 0 0|1 Whether to enable debug mode\n=========== ================== ================= ==================\n\n\n\nFrom SQLAlchemy access Apache Kylin\n--------------------------------------\n::\n\n $ python\n >>> import sqlalchemy as sa\n >>> kylin_engine = sa.create_engine('kylin://ADMIN:KYLIN@sandbox/learn_kylin?timeout=60&is_debug=1')\n >>> results = kylin_engine.execute('SELECT count(*) FROM KYLIN_SALES')\n >>> [e for e in results]\n [(4953,)]\n >>> kylin_engine.table_names()\n [u'KYLIN_ACCOUNT',\n u'KYLIN_CAL_DT',\n u'KYLIN_CATEGORY_GROUPINGS',\n u'KYLIN_COUNTRY',\n u'KYLIN_SALES',\n u'KYLIN_STREAMING_TABLE']\n\nFrom Pandas access Apache Kylin\n------------------------------------\n::\n\n $ python\n >>> import sqlalchemy as sa\n >>> import pandas as pd\n >>> kylin_engine = sa.create_engine('kylin://ADMIN:KYLIN@sandbox/learn_kylin?timeout=60&is_debug=1')\n >>> sql = 'select * from kylin_sales limit 10'\n >>> pd.read_sql(sql, kylin_engine)\n\n\nFrom Superset access Apache Kylin\n-------------------------------------\n\nNow you can configure the DSN in your application to establish the connection with Apache Kylin.\n\nFor example, you may install Apache Kylin Python Client Library in your Superset environment and configure connection to Apache Kylin in Superset\n\n.. image:: https://raw.githubusercontent.com/Kyligence/kylinpy/master/docs/picture/superset1.png\n\nthen you may be able to query Apache Kylin one table at a time from Superset\n\n.. image:: https://raw.githubusercontent.com/Kyligence/kylinpy/master/docs/picture/superset2.png\n\nyou may also be able to query detail data\n\n.. image:: https://raw.githubusercontent.com/Kyligence/kylinpy/master/docs/picture/superset3.png\n\nAlternatively, you may also be able to query multiple tables from Apache Kylin by using SQL Lab in Superset.\n\n.. image:: https://raw.githubusercontent.com/Kyligence/kylinpy/master/docs/picture/superset4.png","description_content_type":"text/x-rst","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/Kyligence/kylinpy","keywords":"apache kylin,kylin,kap,kyligence,kyligence enterprise,cli,sqlalchemy dialect","license":"MIT License","license_expression":null,"license_files":null,"maintainer":"Yongjie Zhao","maintainer_email":"yongjie.zhao@kyligence.io","name":"kylinpy","package_url":"https://pypi.org/project/kylinpy/","platform":"","project_url":"https://pypi.org/project/kylinpy/","project_urls":{"Homepage":"https://github.com/Kyligence/kylinpy"},"provides_extra":null,"release_url":"https://pypi.org/project/kylinpy/2.8.4/","requires_dist":null,"requires_python":"","summary":"Apache Kylin Python Client Library","version":"2.8.4","yanked":false,"yanked_reason":null}

Package search

kylinpy

project_urls

Dependencies

All package metadata

Releases