Skip to main content

A Python wrapper for the KSql REST API

Project description

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

Build Status

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}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ksql-0.2.1.tar.gz (3.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page