יום שני, 17 בנובמבר 2014

בסיס הנתונים שלך מתועד? או - למה זה טוב Extended Properties ?

ישנם מספר נושאים חשובים שיש לתת עליהם את הדעת בפיתוח ותכנון בסיס נתונים. כמובן שצריך לשים לב לנירמול נכון של הטבלאות, וכמובן שצריך להגדיר סטנדרט לכתיבה נכונה של הקוד, וכמובן שאי אפשר בלי סטנדרט נכון לשמות האובייקטים ועוד ועוד...

בין הנושאים החשובים ביותר לפי דעתי בפיתוח בסיס נתונים הינו שלב התיעוד !

תיעוד נכון של האובייקטים יחסוך הרבה מאוד כאב ראש בשלב הפיתוח, אבל הכי חשוב בעבודה ובפיתוח השוטף.

 

בשנותיי כיועץ לחברות ניתקלתי בהרבה מאוד מקרים בהם פרוייקטי פיתוח התעכבו רק בגלל שהיה חסר תיעוד בבסיס הנתונים , סיטואציה שגרמה לעיכובים והתארכות זמני הפיתוח מהסיבה הפשוטה שהמתכנת היה צריך לפני כל שינוי קטן – זמן על מנת להבין מה מטרת האובייקט? ומה שינוי בו יגרור?

כמובן שאני לא מדבר על אי הנוחות בשינוי אובייקט בטעות :( בסביבת ייצור עקב אי הבנה מה מטרת האובייקט...

אם כן, ברור לנו שהתיעוד בא לסייע לנו כמובן בשלב הפיתוח, בעת "העברת מקל" , שימור ידע בארגון וכו'...

 

מנסיוני, תיעוד נכון של סביבת בסיס נתונים צריכה להיות מורכבת ממספר רבדים:

1.     תיעוד סביבת השרת – בשלב זה לתעד את תשתית שרת בסיס הנתונים, הגדרות, סוג החומרה, משאבים, פתרון DR, פתרון גיבויים, אבטחת מידע, תרשים הקשרים בין השרתים (שרתי האפליקציה וכו'...) וכו

2.     תיעוד סביבת ה- sql server – בשלב זה יש לתעד את ההגדרות ברמת האינסטנס, והאובייקטים "שמחוץ" לבסיס הנתונים (link server, jobs וכו'...)

3.     תיעוד סביבת בסיסי הנתונים – תיעוד אובייקטים, קוד, הוספת הסברים בקוד וכו'....

 

ישנם מספר כלים בהם ראיתי שצוותים מתעדים בהם את הסביבות, לדוגמא: Visio לטובת תיעוד יחסי הגומלין בין השרתים בסביבה, ותיעוד ה- ERD של טבלאות בסיסי הנתונים (כמובן שלטובת ה- ERD של הטבלאות ניתן להיעזר ב- database diagram שעושה עבודה מצויינת לטעמי,  לפרטים אודות היכולת : http://www.mssqltips.com/sqlservertip/1816/getting-started-with-sql-server-database-diagrams/) . כמובן שניתן פשוט להיעזר גם ב- power point ו- word אך העבודה תהיה טיפה יותר מסורבלת...

 

באותו הקשר - לפני מספר ימים פנה אליי חבר טוב בהתייעצות, מדובר במקרה של שרת בסיסי נתונים של מוצר שמידי תקופה מעלים גרסאות של עדכוני סכמה וקוד (נשמע לכם מוכר הסיטואציה? :) )

ועלתה הסוגיה – כיצד נדע לפני העלאת גרסה - איזו גרסה מותקנת על בסיס הנתונים? כמו-כן, כיצד נדע אילו אובייקטים שודרגו כבר? ואילו לא?

(כמובן שניתן להקים טבלאות מערכת שינהלו את העלאת הגרסה וכו'... – אך הלקוח רצה פתרון חכם ויעיל יותר).

 

אין ספק שתיעוד נכון וחכם הינו הפיתרון לסוגיה זו.

 

הפעם ברצוני להמליץ על פיצ'ר שקיים עוד מ- SQL Server 2000 אך לטעמי לא כולם מכירים אותו ומשתמשים בו - Extended Properties.

בעזרת ה- Extended Properties ניתן להוסיף מאפיינים והערות לכמעט כל אובייקט ב- SQL Server (כמובן שהיכולת מגיעה עם רמות הרשאה).

ה- Extended Properties בנוי כך שניתן להגדיר פרמטרים וערכים לכל אובייקט. לדוגמא: ניתן להוסיף כסטנדרט לכל אובייקט פרטמרים כגון : מספר גרסה, הערות מיוחדות וכו'...

 

ניתן להוסיף, לעדכן ולמחוק מאפיינים כמובן דרך ה- SSMS, וניתן דרך הקוד. היתרון בעבודה על ידי הקוד הוא שניתן מצד אחד לשלב בקוד (או בשלב העלאת גרסת לדוגמא) את עדכון המאפיינים והתיעוד. וכמובן ניתן לשלוף בצורה יעילה ומהירה את כל המאפיינים של והתיעוד של האובייקטים (וכמובן לפלטר בינהם).

 

אז ראשית, להלן האובייקטים והשכבות ב- SQL Server שניתן להוסיף להם Extended Properties :

 





להלן דוגמא למסך ה- Extended Properties ברמת בסיס הנתונים:



 

ולהלן דוגמאות לקוד:

 

הוספה:

USE AdventureWorks2012;

GO

--Add a caption to the AdventureWorks2012 Database object itself.

EXEC sp_addextendedproperty

@name = N'Caption',

@value = 'AdventureWorks2012 Sample OLTP Database';

 

 

עדכון:

EXEC sp_updateextendedproperty

@name = N'NAME',

@VALUE = N'Holds tables created by user itai.',

    @level0type = N'SCHEMA',

    @level0name = 'Jes';

 

מחיקה:

EXEC sp_dropextendedproperty

    @name = 'name',

        @level0type = 'SCHEMA',

        @level0name = 'Jes',

            @level1type = 'Table',

            @level1name = 'Running',

                @level2type = 'Column',

                @level2name = 'RunDistance';

 

 

וכמובן שליפה:

SELECT EP.class_desc AS PropertyOn,

    DB_NAME() AS DatabaseName,

    EP.name AS ExtendedPropertyDescription,

    EP.VALUE AS ExtendedPropertyValue,

       *

FROM sys.extended_properties AS EP

 

לפרטים נוספים אודות היכולת :


 

אז אל תשכחו לתעד !!

 

בהצלחה !
הוסף רשומת תגובה