DataSource
Bu dokümantasyon, Synergy IDE'deki DataSource klasörü ve içerisinde yer alan dosyaların kullanımını ve yapılandırmasını açıklamaktadır.
DataSource Nedir?
DataSource, Synergy IDE tarafından desteklenen bir özelliktir ve geliştiricilere veri tabanı sorgularını REST çağrılarıyla gerçekleştirme imkanı sunar. Proje oluşturulduğunda, klasik bir proje formatı içerisinde DataSource klasörü oluşturulur. Bu klasör, kullanıcıların veri tabanı sorgularını saklayabilecekleri bir alandır.
DataSource Klasör Yapısı
DataSource klasörü, aşağıdaki dosya ve klasörlerden oluşur:
- Query Dosyaları: Kullanıcılar tarafından oluşturulan veri tabanı sorguları, bu klasörün altında saklanır. Her bir sorgu, ayrı bir dosya olarak temsil edilir.
Query Dosyası Yapısı
Her bir query dosyası, aşağıdaki bilgileri içerebilir:
- Sorgu Adı: Query dosyasının bir ismi vardır ve bu isim, sorgunun amacını açık bir şekilde ifade etmelidir (örneğin: "GetDepartments"). Sorgu İçeriği: Sorgu dosyasının içinde, gerçekleştirilmek istenen veri tabanı sorgusu yer alır. Örnek olarak: "SELECT * FROM OSDEPARTMENTS".
- Kolonlar: Sorgunun sonucunda dönen kolonlar ve ilgili veri tipleri, query dosyasında saklanır. Bu bilgiler, sorgunun çıktısı hakkında bilgi sağlar. Bağlantı Ayarları: Query dosyası, hangi veri tabanına bağlanacağını ve bağlantı özelliklerini tanımlar. Örneğin, veri tabanı türü (MSSQL), bağlantı URL'i, kimlik doğrulama bilgileri vb.
- Cache Ayarları: Eğer gerekiyorsa, query sonuçları cache'de saklanabilir. Bu ayarlar, cache süresini (milisaniye cinsinden) ve cache yapılıp yapılmayacağını belirler.
- Açıklama: Query dosyası için bir açıklama girilebilir. Bu açıklama, sorgunun amacını, kullanımını veya diğer önemli bilgileri açıklayabilir.
Query Dosyası Düzenleme
Kullanıcılar, varolan query dosyalarını düzenleyebilir ve değişiklikleri kaydedebilirler. Örneğin, bir sorgunun sonuna WHERE şartı eklemek veya diğer değişiklikleri yapmak mümkündür. Bu değişikliklerin önceki kayıt edilen dosya ile karşılaştırılması da sağlanabilir.
- İşaretli ikon seçilerek en son kayıt edilen dosya ile şu anki dosya arasındaki farklar görülebilir. Sol tarafta açılan bölüm, son kayıt edilen dosyayı, sağ tarafta açılan bölüm ise şu anki dosyayı ifade etmektedir.
Sağ tarafta bulunan panele baktığımızda 2.satırda bir + iareti görülmektedir. Bu işaretin anlamı ise önceki kayıta göre bu dosyada yeni bir satır eklendiğini ifade etmektedir.
Query Dosyası Dışarı Aktarma ve İçeri Aktarma
Synergy IDE, kullanıcılara query dosyalarını dışarı aktarma ve başka bir projede içeri aktarma imkanı sağlar. Bu özellik, query dosyalarını kolayca paylaşma ve yeniden kullanma fırsatı sunar. Dışarı aktarılan query dosyaları, bağımsız dosyalar olarak saklanır ve başka projelerde kullanılabilir.
DataSource klasörü üzerinde sağ tıklanarak dışarı aktar seçeneği seçilir.
Aktarılacak projede DataSource klasörü üzerinde sağ tıklanarak içeri aktar seçeneği seçilir, ardından açılan pencerede json uzantılı dosya seçilerek içeri aktarılır.
Parametreler
Query dosyaları, sorgularda kullanılacak parametreleri destekler. Parametreler, sorgu içinde {{ParametreAdi}} formatında tanımlanır. Kullanıcılar, bu parametreleri query dosyalarında tanımlayabilir ve sorgulama sırasında değerlerini belirtebilirler. Bu özellik, sorguların daha esnek ve dinamik olmasını sağlar. Parametre kullanımları için çift süslü parentez arasına yazılan anahtar kelime ile birlikte otomatik olarak parametre eklenmektedir. Parametrelerin varsayılan değerleri tanımlarak sorgular tamamlanır.
Örnek Kullanım :
Dosya Adı: GetDepartments
Sorgu İçeriği:
SELECT * FROM OSDEPARTMENTS WHERE ID = {{DEPARTMENTID}}
Kolonlar:
- ID: INTEGER
- CODE: String
- DESCRIPTION: String
Parametreler
-ADI : DEPARTMENTID, TÜRÜ : STRING, VARSAYILAN DEĞER : 0
Özellikler:
- Açıklama : Bu query, departmanları ID parametresine göre filtreleyerek getirir.
- Bağlantı : Danismanlik
- Zaman aşımı : 60
- Çalıştırma tipi : ExecuteDataAdapter
- Komut tipi : TSQL
Önbellek:
- Önbelleğe al : Evet
- Önbellki tipi: Memory
- Önbellek süresi: 6000 (ms)
Bu örnek, GetDepartments query'sini MSSQL veri tabanına bağlanarak gerçekleştirir. Sorgunun sonucunda dönen kolonlar ID,CODE,DESCRIPTION,....'dır. Sorguda DEPARTMENTID parametresi kullanılmıştır ve bu parametre sorgulama sırasında belirtilmelidir. Ayrıca, sonuçlar 6000 milisaniye boyunca cache'de saklanır.
Sorgunun Çalıştırılması
Yazılan sorguyu çalıştırmak için üst panelde seçilmiş olan yıldırım ikonuna tıklanarak srogu çalıştırılır.
