Ipython ODBC SQL Magic

IPython Magic untuk menjalankan SQL menggunakan ODBC secara langsung pada notebook cell.

Pemasangan

$ pip3 install ipython-dawet-sql

Penggunaan

Load Ekstensi

Untuk dapat menggunakan, ekstensi harus di load terlebih dahulu ke notebook yang sedang digunakan.

%load_ext dawetsql

Database Connection

Membuka Koneksi

%dawetsql

Setelah line magic dieksekusi, selanjutnya isi form sesuai dengan konfigurasi ODBC. Username dan password optional jika sudah diset di konfigurasi ODBC sistem.

Untuk me-restart koneksi, cukup klik connect, dawetsql akan otomatis menutup koneksi terlebih dahulu sebelum membuka koneksi baru lagi.

Menutup Koneksi

%dawetsqlclose

Menjalankan SQL

%%dawetsql
SELECT * FROM tables
WHERE somecolumn = 'somevalue'

Preview hasil query ditampilkan menggunakan pandas.DataFrame dengan default limit 10 baris.

Available arguments

Contoh Penggunaan

Menyimpan Hasil query ke Python Variable

%%dawetsql --ouput variablename
SELECT * FROM tables
WHERE somecolumn = 'somevalue'

Menyimpan Hasil Query ke File

Cell Magic %%dawetsql akan otomatis menyimpan hasil query kedalam file jika nama output memiliki ekstensi .csv, .pkl, dan .xlsx

%%dawetsql --output filename.csv
SELECT * FROM tables
WHERE somecolumn = 'somevalue'

Widgets

Schema Explorer Widget

Widget ini digunakan untuk meng-explore database skema, tabel, kolom, dan tipe kolom.

%explorer [-f --force]

Table Detail

Query Builder

Table Data Preview

Settings

File konfigurasi dawetsql tersimpan pada direktori ~/.dawetsql.

Lain-lain

SQL Autocomplete

Cell magic %%dawetsql mendukung SQL Autocomplete. Fitur ini masih bersifat eksperimental. Autocomplete untuk nama tabel dan kolom tersedia setelah pengguna menjalankan magic %explore.

Legal

Package ini dirilis di bawah lisensi MIT.