Sql & Veritabanı İle Uygulamalar İçin Veri Sözlüğü Oluşturma Nasıl Yapılır?

Gereksinimler ve Ön Hazırlık

Veri sözlüğü oluşturma sürecine başlamadan önce, standart bir SQL veritabanı yönetim sistemine (PostgreSQL, MySQL veya SQL Server) ve temel SQL bilgisine ihtiyacınız vardır. Önerilen araçlar arasında, veritabanı şemasını görselleştiren ve dokümantasyon üreten araçlar (örneğin DBeaver, pgAdmin veya DBML formatını destekleyen araçlar) yer almaktadır.

• Veritabanı Yönetim Sistemi: PostgreSQL 16+ veya MySQL 8.4+ sürümü önerilir.
• SQL Editörü: Veritabanı sorgularını çalıştırmak için modern bir IDE.
• Dokümantasyon Standartları: Veri sözlüğünde bulunması gereken zorunlu alanlar: Sütun Adı, Veri Tipi, Uzunluk, Null Durumu, Varsayılan Değer ve Açıklama.

Adım 1: Veritabanı Meta Verilerini Yapılandırma

Veri sözlüğü oluşturmanın en profesyonel yolu, veritabanının kendi COMMENT (açıklama) özelliğini kullanmaktır. Bu yöntem, dokümantasyonun koddan kopmamasını sağlar. Aşağıdaki örnekte, bir kullanıcı tablosu için sütun seviyesinde açıklamalar ekliyoruz.

-- Kullanıcılar tablosu için sütun açıklamaları ekleme
COMMENT ON TABLE users IS 'Sistemdeki kayıtlı kullanıcıların temel bilgilerini tutar.';
COMMENT ON COLUMN users.id IS 'Birincil anahtar, benzersiz kullanıcı kimliği.';
COMMENT ON COLUMN users.email IS 'Kullanıcının giriş yaptığı doğrulanmış e-posta adresi.';
COMMENT ON COLUMN users.created_at IS 'Kayıt oluşturulma zaman damgası (UTC).';

Bu kod bloğu, veritabanı motoruna sütunların ne işe yaradığını anlatır. Böylece, başka bir geliştirici \d+ users komutunu çalıştırdığında, tablonun tüm dokümantasyonunu doğrudan terminalde görebilir.

Adım 2: Veri Sözlüğü İçin Merkezi Bir Tablo Oluşturma

Büyük projelerde, sadece sütun açıklamaları yeterli olmayabilir. İş kurallarını ve veri kısıtlamalarını merkezi bir tabloda tutmak, otomasyon araçları için büyük kolaylık sağlar. Aşağıdaki SQL yapısı, projenizdeki tüm tabloların sözlüğünü tutabileceğiniz bir tablo yapısını gösterir.

CREATE TABLE data_dictionary (
    id SERIAL PRIMARY KEY,
    table_name VARCHAR(100) NOT NULL,
    column_name VARCHAR(100) NOT NULL,
    data_type VARCHAR(50),
    business_rule TEXT,
    is_pii BOOLEAN DEFAULT FALSE, -- Kişisel Verilerin Korunması için işaretçi
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

Bu tablo, verilerinizin hangi iş kuralına göre işlendiğini ve kişisel veri (PII) içerip içermediğini takip etmenize olanak tanır. Bu, özellikle KVKK uyumluluğu gibi süreçlerde kritik bir rol oynar.

Adım 3: SQL Sorguları ile Veri Sözlüğünü Sorgulama

Veritabanı şemanızdan otomatik olarak veri sözlüğü oluşturmak için sistem tablolarını sorgulayabilirsiniz. PostgreSQL'de information_schema kullanarak mevcut yapınızı bir tabloya dökmek oldukça pratiktir.

SELECT 
    column_name, 
    data_type, 
    is_nullable, 
    column_default 
FROM information_schema.columns 
WHERE table_name = 'users';

Bu sorgu, tablonuzun mevcut yapısını listeler. Bu sonucu bir CSV veya Excel dosyasına aktararak, teknik olmayan paydaşlarla paylaşabileceğiniz bir veri sözlüğü taslağı oluşturabilirsiniz.

Adım 4: Veri Sözlüğü Yöntemlerinin Karşılaştırılması

Veri sözlüğü oluştururken kullanabileceğiniz farklı yaklaşımları aşağıdaki tabloda inceleyebilirsiniz.

Adım 5: Güvenlik ve Veri Gizliliği Uyarıları

Kritik Uyarı: Veri sözlüğünüzde asla gerçek şifreleme anahtarları, veritabanı bağlantı dizeleri veya hassas kullanıcı verileri (örneğin ham şifreler) tutmayın. SQL Injection saldırılarına karşı, veri sözlüğü tablolarınızı sorgulayan arayüzlerde mutlaka parametreli sorgular (prepared statements) kullanın.

Örneğin, bir arayüzden veri sözlüğünü sorgularken asla doğrudan kullanıcı girdisini SQL'e eklemeyin. Aşağıdaki örnek, güvenli bir sorgulama yapısını göstermektedir:

-- Güvenli sorgulama örneği (Parametreli)
PREPARE get_column_info(text) AS
SELECT column_name, data_type 
FROM information_schema.columns 
WHERE table_name = $1;

EXECUTE get_column_info('users');

Adım 6: Otomasyon ve Sürekli Dokümantasyon

2026 yılı itibarıyla, veri sözlüğünü manuel yönetmek büyük bir hata kabul edilir. CI/CD süreçlerinize, şema değişikliklerini takip eden ve veri sözlüğünü otomatik güncelleyen scriptler eklemelisiniz. Özellikle DBML (Database Markup Language) kullanarak şemanızı kod olarak saklamak, veri sözlüğünüzün her zaman güncel kalmasını sağlar.

-- DBML örneği (Şema tanımlama)
Table users {
  id integer [primary key]
  email varchar [unique, note: 'Kullanıcı e-postası']
  created_at timestamp
}

Sıkça Sorulan Sorular

Veri sözlüğü neden gereklidir?

Veri sözlüğü, veritabanı yapısının karmaşıklığını azaltır, yeni geliştiricilerin projeye adaptasyonunu hızlandırır ve veri tutarlılığını sağlar.

Veri sözlüğü ne sıklıkla güncellenmelidir?

Her veritabanı şeması değişikliğinde (migration) veri sözlüğü de güncellenmelidir. Mümkünse bu süreci otomatize etmek en iyi pratiktir.

SQL Comment kullanmak performansı etkiler mi?

Hayır, COMMENT ifadeleri veritabanı motoru tarafından meta veri olarak saklanır ve sorgu performansına hiçbir etkisi yoktur.

Veri sözlüğünde hangi bilgiler zorunludur?

Sütun adı, veri tipi, null durumu ve sütunun işlevsel açıklaması (iş kuralı) mutlaka bulunmalıdır.

Veri sözlüğü için özel bir yazılım kullanmalı mıyım?

Küçük projeler için SQL yorumları yeterlidir, ancak kurumsal düzeyde projeler için DataHub veya DBML gibi araçlar kullanmak daha profesyonel bir yaklaşımdır.

İleri İpuçları: Veri Sözlüğünü Dinamik Hale Getirme

Veri sözlüğünüzü statik bir tablo olarak tutmak yerine, veritabanı şemasındaki değişiklikleri anlık olarak yakalayan tetikleyiciler (triggers) kullanabilirsiniz. Bu, özellikle geliştirme aşamasında dokümantasyonun güncelliğini korumak için kritik bir yaklaşımdır. Aşağıdaki örnek, bir tablo üzerinde yapılan değişiklikleri loglayan ve veri sözlüğü tablosunu güncelleyen bir yapıyı temsil eder.

Otomatik Güncelleme Tetikleyicisi

Her tablo değişikliğinde manuel güncelleme yapmak yerine, veritabanı olaylarını dinleyen bir yapı kurmak hata payını düşürür. PostgreSQL üzerinde bir tabloya sütun eklendiğinde veri sözlüğünü uyaran bir örnek:

CREATE OR REPLACE FUNCTION update_data_dictionary()
RETURNS TRIGGER AS $$
BEGIN
    INSERT INTO data_dictionary (table_name, column_name, updated_at)
    VALUES (TG_TABLE_NAME, NEW.column_name, NOW());
    RETURN NEW;
END;
$$ LANGUAGE plpgsql;

CREATE TRIGGER trg_sync_dictionary
AFTER ALTER ON my_application_tables
FOR EACH STATEMENT EXECUTE FUNCTION update_data_dictionary();

Veri Sözlüğü ile Hata Ayıklama (Debugging) Süreçlerini Hızlandırma

Veritabanı şemanız büyüdükçe, karmaşık sorgularda hangi sütunun ne anlama geldiğini hatırlamak zorlaşır. Veri sözlüğü, sadece bir doküman değil, aynı zamanda bir hata ayıklama aracıdır. Özellikle "orphan" (yetim) verilerle uğraşırken, veri sözlüğü üzerinden sütunların ilişkilerini (Foreign Key tanımları) hızlıca filtreleyebilirsiniz.

İlişkisel Hata Ayıklama Sorgusu

Eğer bir veri tutarsızlığı yaşıyorsanız, veri sözlüğünüzü kullanarak ilgili tablonun tüm bağımlılıklarını şu şekilde listeleyebilirsiniz:

SELECT 
    t.table_name, 
    c.column_name, 
    d.description 
FROM information_schema.columns c
JOIN data_dictionary d ON c.column_name = d.column_name
JOIN information_schema.tables t ON c.table_name = t.table_name
WHERE t.table_schema = 'public' 
AND d.is_nullable = 'NO'
ORDER BY t.table_name;

Performans İyileştirmesi İçin İpuçları

• İndeksleme: Veri sözlüğü tablonuzda table_name ve column_name sütunlarına mutlaka indeks ekleyin. Bu, dokümantasyon sorgularının veritabanı performansını etkilemesini engeller.
• Görünümler (Views): Veri sözlüğünü doğrudan sorgulamak yerine, sık kullanılan filtreleri içeren bir VIEW oluşturun.
• Veri Tipi Eşleştirme: Sözlükte sadece açıklama değil, sütunun beklenen veri tipi (örn: VARCHAR(255)) bilgisini de tutarak uygulama tarafındaki validasyon hatalarını minimize edin.

Bu yöntemleri uygulayarak, veritabanı yönetimini bir yük olmaktan çıkarıp, yazılım geliştirme döngüsünün doğal bir parçası haline getirebilirsiniz. Unutmayın, iyi dokümante edilmiş bir veritabanı, yazılımın bakım maliyetini %40'a varan oranlarda düşürebilir.

Sonuç

Sql & Veritabanı ile uygulamalar için veri sözlüğü oluşturma, projenizin uzun ömürlü olması için atmanız gereken en önemli adımlardan biridir. Veritabanı şemanızı dokümante etmek, sadece bir "yazma" işi değil, verinizin dilini oluşturma sürecidir. Bu rehberde öğrendiğiniz yöntemleri kullanarak, veritabanı mimarinizi daha anlaşılır ve yönetilebilir hale getirebilirsiniz. Bir sonraki adım olarak, veritabanı şemanızı otomatik olarak dokümante eden bir "Schema-to-Markdown" aracı geliştirmeyi deneyebilirsiniz.

Yasal Sorumluluk Reddi: Bu makalede paylaşılan kod örnekleri eğitim amaçlıdır. Üretim ortamında kullanmadan önce mutlaka güvenlik testlerinden geçirin ve veritabanı yedeklerinizi almayı unutmayın.