miniSheetDB v2

Pustaka untuk Google Apps Script (GAS) yang memberdayakan Google Spreadsheet menjadikan seolah-olah sebagai database aplikasi.

Ini adalah penerus dari versi lama miniSheetDB v1 yang mana proyek yang awalnya berada pada repository pribadi bangHasan sekarang dialihkan menjadi repository organisasi.

Update

Untuk mendapatkan notifikasi update di Telegram @GASIndonesia

Keuntungan

• Secara umum syntax tidak jauh berbeda dengan miniSheetDB v1
• Lebih mudah mengelola spreadsheet
• Penggunaan tidak hanya peruntukkan bot telegram, bisa untuk berbagai kebutuhan script
• Sekarang lebih banyak method, variable dan pilihan opsi pengelolaan data yang fleksibel
• Disertakan posisi kolom dan baris pada hasil pencarian, sehingga tidak ribet untuk pengolahan berikutnya
• Open Source, aman bisa dilihat, diteliti dan dikembangkan bersama.
• Struktur class yang jauh lebih rapi, mudah dipergunakan, dipelajari dan atau diturunkan

Peringatan

Hasil dari v2 ini tidak kompatible dengan v1, meskipun secara syntax memiliki banyak kemiripan.

Selalu cek log hasil methodnya untuk memastikan.

Pemakaian

ID

• Legacy: MbEHC24_R5YUoHX8iCbUEAaZTb1melOAr
• New Editor: 1wMvpNwIL8fCMS7gN5XKPY7P-w4MmKT9yt_g2eXDGBtDErOIPq2vcNxIN

Start

var ssid = 'idsheet';
var db = new miniSheetDB2.init(ssid);

function getAll() {
    let result = db.getAll();
    Logger.log(result);
}

function getKey() {
    let result = db.key('112233');
    Logger.log(result);
}

Referensi

Inisiasi

init(id, tab = 0, options = {})

• id (string) bisa berupa sheet ID atau URL
• tab (number atau sting), default adalah tab sheet dengan index 0 (yang pertama). Nilai bisa berupa nomor index sheet, atau nama sheet. Misalnya 'Sheet1'
• options pilihan operasional pada database. Periksa dibawah ini.

Options

variable	tipe	default	keterangan
col_start	number	1	sheet kolom dimulai
col_length	number	2	rentang sheet panjang kolom
row_start	number	1	baris dimulainya pemrosesan sheet
json	boolean	false	Secara default (spreadsheet), hasil method getAll adalah bertipe Array. Maka, jika options json diisi true hasilnya akan diubah menjadi bertipe json. Konsekuensi nya adalah: Key kosong diubah menjadi key bernilai ___ Value yang dipakai adalah value yang ditemukan oleh key paling akhir

Contoh Pemakaian:

var ssid = '1B8JSBXqV0sIFZsuwDHQ8wOADFIAxgB7WDpJRh1JUei8';
// atau:
var ssid = 'https://docs.google.com/spreadsheets/d/1B8JSBXqV0sIFZsuwDHQ8wOADFIAxgB7WDpJRh1JUei8/edit';

var db = new miniSheetDB2.init(ssid, 'Sheet1', {    
    col_length: 5,
    row_start: 2,
    json: true
});

Option bisa juga diset sesudah diinisiasi

Misalnya:

db.col_length = 10;

Method

Berikut list method, accessor, maupun field / tipe yang berada dalam class miniSheetDB2.

Method	Params	Keterangan
id	-	mendapatkan / memasukkanid yang telah diinput
ssid	-	mendapatkan ssid yang aktif sekarang dipakai
type	-	mendapatkan tipe ssid yang aktif, hasil berupa string bernilai http atau id sesuai tipe ssid yang diinput
url	-	mendapatkan url yang aktif sekarang dipakai
name	-	mendapatkan nama sheet (title) dari tab yang saat ini dipakai
sheet	-	Pointer utama pengoperasian sheet. Cek method-method pada spreadsheet
last_row	-	Mendapatkan posisi terakhir baris sheet
versi	-	informasi versi library
version	-	alias dari versi
data_range	-	Mendapatkan data range dalam A1Notation
range()	a1Notation, kolom, baris	Mendapatkan pointer range untuk pengolahan selanjutnya. Cek method-method pada range
add(data)	array atau data	Menambahkan data.
getValue()	a1Notation, kolom, baris	mendapatkan isi suatu range
getValues()	a1Notation, kolom, baris	mendapatkan isi suatu range secara massal
setValue()	a1Notation, kolom, baris	mengisi nilai suatu range
setValues()	a1Notation, kolom, baris	mengisi nilai suatu range secara massal
getAll()	boolean	mendapatkan seluruh isi sheet, sesuai parameter awal
key()	id (string atau number)	Pencarian isi suatu range berdasarkan id / kunci
keys()	[id1, id2, ...id]	Pencarian isi suatu range berdasarkan id / kunci secara massal
search()	String atau regexp	pencarian berdasarkan key menggunakan string atau reguler expression
searchAll()	String atau regexp	pencarian jamak berdasarkan key, jika ketemu akan tetep dilanjutkan ke field berikutnya

Penjelasan Detail

Penjelasan detail untuk beberapa method penting dan beberapa kasus, disertai berbagai contoh.

add

Menambahkan data.

var db = new miniSheetDB2.init('a1b2c3');

// add with array type
var result = db.add(['kunci', 'isi']);
// or normal methode
var result = db.add('kunci', 'isi');

Contoh lain jika panjang kolom berbeda:

var db = new miniSheetDB2.init('a1b2c3', 'Sheet1', { col_length: 3 });

// add with array type
var data = ['kunci', 'isi 1', 'isi 2'];
var result = db.add(data);
// or normal methode
var result = db.add('kunci', 'isi 1', 'isi 2');

Akan error jika panjang kolom tidak sesuai dengan data:

var db = new miniSheetDB2.init('a1b2c3', 'Sheet1', { col_length: 3 });

// ERROR :
var result = db.add('kunci', 'isi 1', 'isi 2', 'isi 3', 'isi 4'); // len = 5

key

mendapatkan data berdasarkan id.

id harus sama identik dengan key.

jika ditemukan, ada field range untuk pengolahan advance.

// id = hasanudin
// id = 12345
var result = db.key(12345);  // ketemu
var result = db.key('hasanudin'); // ketemu
var result = db.key('hasan'); // tidak ketemu

keys

mendapatkan data berdasarkan id secara massal (lebih dari satu)

// penjelasan idem dengan method key
var result = db.keys([111, 222, 333]);
var result = db.keys(['hasan', 'amir']);

search

Mendapatkan data berdasarkan id menggunakan reguler expression.

id bisa berupa number, string atau regex

Perbedaan jika menggunakan method key jika bertipe string:

• method search data parsial tetap ditemukan
• method key harus bertipe eksak (sama persis).

jika ditemukan, ada field range untuk pengolahan advance.

Terdapat juga field match yang merupakan hasil regex.

// id = Hasanudin
// id = ikhsan
var result = db.search('hasan'); // ketemu
var result = db.search(/^hasan$/); // tidak ketemu
var result = db.search(/san$/i); // ketemu

searchAll

Serupa dengan method search diatas.

Contoh kasus, ingin menemukan semua kunci yang berawalan angka depan 71

Hasil berupa array.

// id key = 700, 711, 712, 811, 812
var result = db.searchAll(/^71/); // 711, 712

getValue

Ref: getValue

mendapatkan isi sebuah range

var result = db.getValue('Sheet1!A1');
var result = db.getValue('A1');
var result = db.getValue(1,1);

getValues

Ref: getValues

mendapatkan isi range secara jamak

var result = db.getValues('A1');
var result = db.getValues('Sheet1!A1');
var result = db.getValues('Sheet1!A1:C4');
var result = db.getValues(1,1);
var result = db.getValues(1,1,2);
var result = db.getValues(1,1,2,10);

setValue

Ref: setValue

mengisi nilai suatu range, jika berhasil result berupa object range.

var result = db.setValue('rules!A1', 'Test');

db.setValue('A1', 'Test');
db.setValue(1, 1, 'Test');

setValues

Ref: setValues

Mengisi nilai beberapa range sekaligus, dengan value bertipe array.

Contoh beberapa variasi:

var resulit = db.setValues('rules!A1', [['Test A1']]);

db.setValues('A10:A11', [['Baris 1'], ['Baris 2']]);
db.setValues('A10:B11', [['Baris 1', 'Samping 1'], ['Baris 2', 'Samping 2']]);

db.setValues(10, 1, [['Test A10']] );
db.setValues(10, 1, 2, [['Baris 1'], ['Baris 2']] );
db.setValues(10, 1, 2, 2, [['Baris 1', 'Samping 1'], ['Baris 2', 'Samping 2']] );

getAll

Untuk mendapatkan semua data sheet aktif:

// tipe array
// semua data tampil apa adanya
var resArray = db.getAll();

// untuk tipe JSON
// key kosong diubah ___
// jika key sama, data terakhir akan menimpa
var resJSON = db.getAll(true);

sheet

Bikin Baru

db.app.insertSheet();
db.app.insertSheet(1); // sheet baru posisi ke-2
db.app.insertSheet('Sheet Baru');
db.app.insertSheet('Sheet Baru Paling Depan', 0);

Hapus

Ref: deleteRow

Menghapus baris (row) :

// hapus baris 2
db.sheet.deleteRow(2);

// hapus 5 baris sekaligus dimulai dari baris ke 2
db.sheet.deleteRow(2, 5);

Hapus baris pada posisi yang ditemukan

// cari key
var hasil = db.key('id');
if (hasil) {
    // hapus baris ditempat key ditemukan
    db.sheet.deleteRow(hasil.row);
}

v2.4

var hasil = db.del('id');

Clear

Membersihkan range .

// dibersihkan seluruhnya, isi dan format
db.range('A1:B1').clear();
// bersihkan isinya saja
db.range('A1:B1').clear({contentsOnly: true});

// membersihkan format saja
db.range('A1:B1').clearFormat();
// membersihkan isinya saja
db.range('A1:B1').clearContent();

findText

Tersedia di release: v2.5

Ref:

• text finder
• blog bangHasan

Berfungsi untuk mencari suatu text atau pola tertentu.

Tidak direkomendasikan untuk data spreadsheet yang besar. karena akan jadi lemot.

• Syntax: findText(text, regex = false, ...ranges)
• Hasil: berupa array, Notasi A1.

Contoh:

// menemukan nama Andi pada sheet aktif
db.findText('andi');

// menemukan nama Andi pada kolom A
db.findText('andi', false, 'A1:A');

// menemukan nama yang berawalan huruf A pada kolom A
// menggunakan regex
db.findText('^A', true, 'A1:A');

// menemukan nama berawalan huruf A, menggunakan regex
// pada area range 1,1,3,10 (A1:C10)
db.findText('^A', true, 1, 1, 3, 10);

Data Range

Menghasilkan jangkuan data yang telah dipakai.

vat dataRange = db.data_range; // misal: A1:E217

Checkbox

Ref: checkbox

vat result = db.range('A1').insertCheckboxes();
vat result = db.range('A1').insertCheckboxes('yes');

Style

db.range('C1:D1').setFontColor("red");
db.range('A1:A2').setBackground("black");

var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .setFontColor("red")
    .build();
db.range('A1:B1').setTextStyle(style);

Kontribusi

• Silakan di fork dan pull request
• Ada masalah atau saran pengembangan? silakan buat issue baru.