ksql 0.2.2.0

A Python wrapper for the KSql REST API

A python wrapper for the KSQL REST API. Easily interact with the KSQL REST API using this library.

Installation

pip install ksql

Or

git clone https://github.com/bryanyang0528/ksql-python
cd ksql-python
python setup.py install

Getting Started

This is the GITHUB page of KSQL. https://github.com/confluentinc/ksql

Setup

• Setup for the KSql API:

from ksql import KSQLAPI
client = KSQLAPI('http://ksql-server:8080')

Options

Option	Type	Required	Description
url	string	yes	Your ksql-server url. Example: http://ksql-server:8080
timeout	integer	no	Timout for Requests. Default: 5

Main Methods

ksql

client.ksql('show tables')

• Example Response [{'tables': {'statementText': 'show tables;', 'tables': []}}]

query

It will execute sql query and keep listening streaming data.

client.query('select * from table1')

• Example Response

  {"row":{"columns":[1512787743388,"key1",1,2,3]},"errorMessage":null}
  {"row":{"columns":[1512787753200,"key1",1,2,3]},"errorMessage":null}
  {"row":{"columns":[1512787753488,"key1",1,2,3]},"errorMessage":null}
  {"row":{"columns":[1512787753888,"key1",1,2,3]},"errorMessage":null}

Simplified API

create_stream/ create_table

client.create_stream(table_name=table_name,
                     columns_type=columns_type,
                     topic=topic,
                     value_format=value_format)

Options

Option	Type	Required	Description
table_name	string	yes	Your ksql-server url. Example: http://ksql-server:8080
columns_type	list	yes	ex:['viewtime bigint','userid varchar','pageid varchar']
topic	string	yes	Kafka topic
value_format	string	no	DELIMITED``(Default) or ``JSON

• Example Response

True:

If create table/stream succeed.

False:

If failed.