Mariusz Koprowski
 O firmie Red Gate
 „Dokumentacja” słowo klucz
 SQL Doc 2.0
   O programie
   Demo
   Tips and Tricks
 Q&A
   Jeden z dwóch najważniejszych
    ISV tworzący oprogramowanie
    dodatkowe do Microsoft SQL
    Server
   Visual Stu...
SQL Comparison
   SQL Compare®: porównywanie
    i synchronizowanie schematów.
   SQL Data Compare™:
    porównywanie i
...
SQL Backup
   SQL Backup™ Pro: szybkie
    tworzenie kopi zapasowych
    z możliwością enkrypcji.

   SQL Multi Script™ ...
SQL Prompt
   SQL Prompt™ Pro: IntelliSense
    dla narzędzi bazodanowych.
   SQL Doc™: szybkie
    dokumentowanie baz d...
.Net
   ANTS Profiler Pro:
     ANTS Performance Profiler:
      Sprawdzanie aplikacji do
      określenia wąskich garde...
   Exchange Server Archiver:
    Archiwizacja maili w Exchange
    Server.

   SQL Comparison SDK™: SDK
    do narzędzi ...
Jeżeli zainteresował cię któryś z produktów pamiętaj,
   że możesz zawsze go przetestować i przedstawić
                 g...
   Rodzaje dokumentacji:           Dokumentacja techniczna
                                        oprogramowania
     u...
METODY DOKUMENTOWANIA W SQL SERVER
                         Aggregate                   Remote Service
 Komentarze     ...
   Dodawanie opisu do tabeli:              Odczytywanie opisu z tabeli:
USE AdventureWorks;                      USE Adv...
   Tworzenie dokumentacji bazy
    danych bezpośrednio z fizycznej
    struktury.
   Dodawanie i edytowanie opisów do
  ...
   SQL Doc wykorzystuje mechanizm extended
    property do zapisywania wprowadzanych opisów.
     Opis zapisywany jest w...
   Aby zmienić domyślny wygląd pierwszej strony wygenerowanego
    dokumentu Microsoft Word należy zmienić odpowiednio do...
WADY                                         ZALETY
   Twórca dokumentacji ma mały wpływ na         Szybkość.
    jej za...
Using Red Gate SQL Doc for database documentation
Using Red Gate SQL Doc for database documentation
Upcoming SlideShare
Loading in …5
×

Using Red Gate SQL Doc for database documentation

914 views
822 views

Published on

This is my presentation about Red Gate SQL Doc that I have presented on one of the meatings of Lodzka Grupa Profesjonalistow IT & .NET. Presentation in Polish.

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
914
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
0
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Using Red Gate SQL Doc for database documentation

  1. 1. Mariusz Koprowski
  2. 2.  O firmie Red Gate  „Dokumentacja” słowo klucz  SQL Doc 2.0  O programie  Demo  Tips and Tricks  Q&A
  3. 3.  Jeden z dwóch najważniejszych ISV tworzący oprogramowanie dodatkowe do Microsoft SQL Server  Visual Studio Industry Partner (VSIP)  Microsoft Gold Visual Studio .NET launch partner  Wielokrotnie nagradzana przez SQL Server Magazin, Visual Studio Magazin, asp.netPRO, Dr Dobbs, Code Project  Wśród klientów redgate można znaleźć:HP, Sage, Bank of America, AT&T , US Treasury
  4. 4. SQL Comparison  SQL Compare®: porównywanie i synchronizowanie schematów.  SQL Data Compare™: porównywanie i synchronizowanie danych.  SQL Packager™: pakowanie, aktualizacja i instalacja baz danych.  SQL Dependency Tracker™: graficzna wizualizacja zależności.
  5. 5. SQL Backup  SQL Backup™ Pro: szybkie tworzenie kopi zapasowych z możliwością enkrypcji.  SQL Multi Script™ Unlimited: wywoływanie wielu skryptów równocześnie na wielu instancjach SQL Server za pomocą tylko jednego kliknięcia.  SQL Response™: monitorowanie „zdrowia” i aktywności SQL Server.
  6. 6. SQL Prompt  SQL Prompt™ Pro: IntelliSense dla narzędzi bazodanowych.  SQL Doc™: szybkie dokumentowanie baz danych w Word lub HTML.  SQL Data Generator: automatyczny generator realistycznych danych testowych.  SQL Refactor™: refaktoryzacja kodu baz danych w locie.
  7. 7. .Net  ANTS Profiler Pro:  ANTS Performance Profiler: Sprawdzanie aplikacji do określenia wąskich gardeł i zapewnienia optymalnej wydajności tworzonego kodu.  ANTS Memory Profiler: Sprawdzanie tworzonych  .NET Reflector™: Eksploracja aplikacji pod kontem zużycia .NET assemblies w naturalny i pamięci prosty sposób. (Freeware)  Exception Hunter: Analizuje  PInvoke Visual Studio Add-in: stworzone .NET assemblies pod dodatek do Visual Studio do kontem nie obsłużonych tworzeni i przeszukiwania wyjątków , które mogą być sygnatur PInvoke (Freeware) zwracane z metod
  8. 8.  Exchange Server Archiver: Archiwizacja maili w Exchange Server.  SQL Comparison SDK™: SDK do narzędzi SQL Comparison umożliwiające pisanie własnych zadań synchronizacyjnych itp.  SQL Log Rescue™: analizator logów transakcyjnych SQL Server.  SQL Safari ®:dostęp do Safari Books Online z wybranymi najlepszymi książkami o SQL w formie elektronicznej
  9. 9. Jeżeli zainteresował cię któryś z produktów pamiętaj, że możesz zawsze go przetestować i przedstawić go na naszym forum.
  10. 10.  Rodzaje dokumentacji: Dokumentacja techniczna oprogramowania  użytkownika  powinna zawierać dokładny opis metod  inwestycyjna działania programu, algorytmów w nich  konstrukcyjna zastosowanych, rozmieszczenia i sposobu działania poszczególnych  technologiczna komponentów itp.  fabryczna  Jej finalna forma powinna być  naukowo-techniczna zrozumiała/czytelna dla człowieka.  badawczo-rozwojowa  Coraz częściej do tworzenia i generowania dokumentacji  … wykorzystuje się automaty np.:  Sandcatle – generacja dokumentacji z C# i VB.NET na podstawie komentarzy ///  GhostDoc – automat ułatwiający tworzenie dokumentacji w C# na podstawie nazw.
  11. 11. METODY DOKUMENTOWANIA W SQL SERVER  Aggregate  Remote Service  Komentarze  Asymmetric Key Binding (Service  Assembly Broker) ▪ --  Certificate  Route (Service Broker) ▪ /*….*/  Contract (Service  Rule Broker)  Schema or User  Database  Service  Default  Extended property  Event Notification  Symmetric Key - dodawanie  Filegroup or File Name  Synonym dowolnych opisów  Function  Table  Message Type  Trigger do obiektów Partition Function   Type bazodanowych  Partition Scheme  View  Plan Guide  XML Schema  Procedure Collection  Queue (Service Broker)
  12. 12.  Dodawanie opisu do tabeli:  Odczytywanie opisu z tabeli: USE AdventureWorks; USE AdventureWorks; GO GO EXEC sys.sp_addextendedproperty SELECT objtype @name = N‘Test', , objname @value = N‘test', , name @level0type = N'SCHEMA', @level0name = , value Person, FROM fn_listextendedproperty (NULL, @level1type = N'TABLE', @level1name = 'schema', 'Person', 'table', 'Address', Address; default, default); GO GO  Kasowanie opisu z tabeli: objtype objname name value USE AdventureWorks; GO TABLE Address Test Test EXEC sp_dropextendedproperty @name = = 'Test' ,@level0type = 'schema' ,@level0name = Person ,@level1type = 'table' ,@level1name = 'Address' GO
  13. 13.  Tworzenie dokumentacji bazy danych bezpośrednio z fizycznej struktury.  Dodawanie i edytowanie opisów do tabel, widoków i kolumn.  Eksport dokumentacji do postaci Microsoft Word, HTML i CHM.  Stworzona dokumentacja prezentuje wszystkie wewnętrzne i zewnętrze (tylko pomiędzy bazami) zależności pomiędzy obiektami bazodanowymi.  Wsparcie dla SQL Server w wersji:  2000  2005  2008
  14. 14.  SQL Doc wykorzystuje mechanizm extended property do zapisywania wprowadzanych opisów.  Opis zapisywany jest w właściwości o nazwie „MS_Description”.  Skasowanie właściwości z bazy spowoduje zniknięcie opisu obiektu z projektu.  Wymaga użytkownika typu SYSADMIN lub SECURITYADMIN oraz prawa typu EXEC dla:  sp_addextendedproperty (dodawanie właściwości)  fn_listextendedproperties (odczyt właściwości)  sp_dropextendedproperty (kasowanie właściwości)
  15. 15.  Aby zmienić domyślny wygląd pierwszej strony wygenerowanego dokumentu Microsoft Word należy zmienić odpowiednio dokument „DefaultCoverPage.doc” znajdujący się w <wybrana ścieżka instalacji programu>SQL Doc 2Style1Word DefaultCoverPage.doc  Aby zmienić domyślny wygląd wygenerowanego HTML należy zaktualizować pliki css znajdujące się w <wybrana ścieżka instalacji programu> SQL Doc 2Style1Style  Możliwa jest zmiana ikon poprzez podmiana odpowiednich plików typu .gif w ścieżce <wybrana ścieżka instalacji programu> SQL Doc 2 Style1Images  Zalecane jest tworzenie dokumentacji na pustej bazie danych przeznaczonej tylko do generacji dokumentacji.
  16. 16. WADY ZALETY  Twórca dokumentacji ma mały wpływ na  Szybkość. jej zawartość.  Łatwość obsługi.  Za mała konfigurowalność tworzonych elementów.  Łatwa edytowalność danych  Brak domyślnej obsługi PDF. (opisów obiektów).  Zapisywanie opisów bezpośrednio w  Domyślny wygląd generowanej bazie danych, co może doprowadzić do dokumentacji w większości ich zniknięcia w przypadku przywracania przypadków jest wystarczający. bazy itp.  Generowana dokumentacja zawiera wszystkie informacje, które mogą być potrzebne odbiorcą dokumentu.

×