Database Documentation

Dokumentacja bazy danych informuje nas o elementach bazy danych oraz przedstawia jakie wartości zawarte są w danych parametrach, kolumnach bądź tabelach.

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