https://github.com/databendcloud/databend-py

Databend Cloud Python Driver with native interface support
https://github.com/databendcloud/databend-py

database databend driver python

Last synced: 30 days ago
JSON representation

Databend Cloud Python Driver with native interface support

• Host: GitHub
• URL: https://github.com/databendcloud/databend-py
• Owner: datafuselabs
• License: apache-2.0
• Created: 2022-10-24T04:28:35.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-08T03:04:54.000Z (about 1 month ago)
• Last Synced: 2024-08-17T23:01:45.379Z (about 1 month ago)
• Topics: database, databend, driver, python
• Language: Python
• Homepage:
• Size: 193 KB
• Stars: 19
• Watchers: 6
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# databend-py

Databend Cloud Python Driver with native http interface support

[![image](https://img.shields.io/pypi/v/databend-py.svg)](https://pypi.org/project/databend-py)

[![image](https://coveralls.io/repos/github/databendcloud/databend-py/badge.svg?branch=master)](https://coveralls.io/github/databendcloud/databend-py?branch=master)

[![image](https://img.shields.io/pypi/l/databend-py.svg)](https://pypi.org/project/databend-py)

[![image](https://img.shields.io/pypi/pyversions/databend-py.svg)](https://pypi.org/project/databend-py)

# Installation

pip install databend-py

# Usage

Use the next code to check connection:

> ``` python

> >>> from databend_py import Client

> >>> client = Client(

>     host='tenant--warehouse.ch.datafusecloud.com',

>     database="default",

>     user="user",

>     port="443",

>     secure=True,

>     password="password",settings={"copy_purge":True,"force":True})

> >>> print(client.execute("SELECT 1"))

> ```

The [host]{.title-ref}, [user]{.title-ref}, [password]{.title-ref} info

will be found in databend cloud warehouse connect page as flows:

Pure Client example:

> ``` python

> >>> from databend_py import Client

> >>>

> >>> client = Client.from_url('http://root@localhost:8000/db?secure=False&copy_purge=True')

> >>>

> >>> client.execute('SHOW TABLES')

> [[], [('test',)]]

> >>> client.execute("show tables",with_column_types=True)

> [[('Tables_in_default', 'String')], [('test',)]] # [[(column_name, column_type)], [(data,)]]

> >>> client.execute('DROP TABLE IF EXISTS test')

> []

> >>> client.execute('CREATE TABLE test (x Int32)')

> []

> >>> client.execute(

> ...     'INSERT INTO test (x) VALUES', [(1,)]

> ... )

> 1

> >>> client.execute('INSERT INTO test (x) VALUES', [(200,)])

> 1

> ```

More usages examples find [here](./examples).

# Features

-   Basic SQL.

-   TLS support.

-   Query settings.

-   Types support:

    -   Float32/64

    -   \[U\]Int8/16/32/64/128/256

    -   Date/Date32/DateTime(\'timezone\')/DateTime64(\'timezone\')

    -   String

    -   Array(T)

    -   Nullable(T)

    -   Bool

# Compatibility

-   If databend version \>= v0.9.0 or later, you need to use databend-py

    version \>= v0.3.0.

# License

Databend Python Driver is distributed under the [Apache

license]{.title-ref}.