Górne zakładki
FILTERS
Funkcja pozwala na odfiltrowanie dokumentacji.
- Include All Tables By Default - jeśli zaznaczone wyświetlone zostają tabele standardowe, które zawsze wchodzą w skład bazy danych
- Exclude Schemas - Lista rozwijana schematów pozwalająca na wybranie elementów bazodanowych wybranym przez nas schemacie
- Exclude Tables - Wybór z listy rozwijanej tabeli, których nie chcemy widzieć w dokumentacji
- Exclude Views - Wybór z listy rozwijanej widoków, których nie chcemy widzieć w dokumentacji
- Exclude Procedures - Wybór z listy rozwijanej procedur, których nie chcemy widzieć w dokumentacji
- Exclude Function - Wybór z listy rozwijanej funkcji, których nie chcemy widzieć w dokumentacji
EXPORT
Funkcja pozwala na wyeksportowanie dokumentacji.
- Languages - Lista rozwijana języków, w których wykonana jest dokumentacja
- Export Type - typ wyeksportowanych danych
- Export Data - elementy bazodanowe, których dokumentacje chcemy wyeksportować
IMPORT
Po wybraniu funkcji zostajemy przekierowani do plików na komputerze w celu wskazania pliku, który chcemy zaimportować.
Tables/Views
widok przedstawiający tabele/widoki wchodzące w skład bazy danych oraz dokumentację do każdej z nich.
Funkcje toolbar menu:
Columns - po wybraniu wyświetlony zostaje widok kolumn wchodzących w skład wybranej tabeli/widoku. Dokumentację możemy uzupełnić także dla poszczególnej kolumny.
Documentation - po wybraniu ukarzą nam się pola do wpisania dokumentacji w wybranym języku dla wybranego obiektu
Procedures/Functions
widok przedstawiający procedury/funkcje wchodzące w skład bazy danych oraz dokumentację do każdej z nich.
Funkcje toolbar menu:
Parameters- po wybraniu wyświetlony zostaje widok parametró wchodzących w skład wybranej procedury/funkcji. Dokumentację możemy uzupełnić także dla poszczególnej kolumny.
Documentation - po wybraniu ukarzą nam się pola do wpisania dokumentacji w wybranym języku dla wybranego obiektu
Do czego służy Database Documentation
Database Documentation gromadzi opisy obiektów bazy danych projektu - tabel, widoków, procedur i funkcji - wraz z dokumentacją poszczególnych kolumn i parametrów. Dokumentację można filtrować, eksportować i importować.
Zakładki górne
- Filters - Include All Tables By Default oraz listy wykluczeń: Exclude Schemas, Exclude Tables, Exclude Views, Exclude Procedures, Exclude Functions.
- Export - Languages, Export Type i Export Data określają zakres i format eksportu.
- Import - wskazanie pliku dokumentacji z dysku.
Widoki i uzupełnianie opisów
Widok Tables/Views pokazuje obiekty bazy i ich dokumentację. Z paska menu polecenie Columns otwiera listę kolumn obiektu, a Documentation - pola opisu w wybranym języku. Analogicznie działa widok Procedures/Functions z poleceniem Parameters.