Dokumentacja

Rozwiązania oparte o platformę StudioSystem oferują administratorowi narzędzie generujące automatycznie dokumentację techniczną bazy SQL z której korzysta system.

W celu wyświetlenia dokumentacji użytkownik Administrator lub SuperVisor musi uruchomić moduł administratora

Z menu moduł administratora dostępna jest sekcja DOKUMENTACJA, która wyświetla listę dostępnych elementów bazy danych:

• Tabele;
• Widoki;
• Procedury;
• Funkcje;
• Assembly;
• Trigery

Extended Properties

Jak odczytać metadane tabel z bazy SQL?

Metadane tabel w bazach SQL stanowią cenne źródło informacji o strukturze danych, a ich właściwe wykorzystanie znacznie ułatwia pracę programistom. Poprzez specjalne zapytania SQL możemy uzyskać dostęp do tytułów oraz opisów poszczególnych tabel. Zatem warto poznać sposoby efektywnego odczytywania tych informacji z systemowego katalogu bazy danych.

Systemy zarządzania bazami danych oferują wbudowane mechanizmy do przechowywania metadanych, które następnie można łatwo odczytać za pomocą odpowiednich poleceń. W Microsoft SQL Server wykorzystujemy widok sys.extended_properties, natomiast w Oracle korzystamy z widoku ALL_TAB_COMMENTS. Co więcej, programiści mogą tworzyć własne zapytania łączące różne widoki systemowe, aby uzyskać jeszcze bardziej szczegółowe informacje o strukturze bazy danych.

Proces pobierania metadanych z bazy wymaga znajomości odpowiednich widoków systemowych oraz składni języka SQL. Administrator bazy danych nadaje uprawnienia użytkownikom do odczytu tych informacji. Następnie programista tworzy odpowiednie zapytania SQL do pobrania potrzebnych metadanych.

Istnieje możliwość dodawania wielu opisów dla jednej tabeli

Przykładowo dla tabeli _dziennik dodajemy drugi opis EXTENDED PROPERTIES

W efekcie w dokumentacji opis tabeli zawierać będzie dwie linie opisu dla jednej tabeli

W przypadku tabel które mają uniwersalne zastosowanie dodawane są zapisy o tytule ZASTOSOWANIE, ale także z opisem jakie jest wykorzystanie w zależności od roli, przykładowa tabela KNASO

knaso	ZASTOSOWANIE	Kartoteki towarowe, magazynowe inne

knaso	Rola WMS	Kartoteki magazynowe

knaso	Rola NAR	Kartoteki magazynowe i wypożyczeń

knaso	Rola MMS	Kartoteki części i materiałów eksploatacyjnych

Tabele

Wybór Tabele powoduje wyświetlenie listy tabel bazy SQL które są zainstalowane w bazie StudioSystem. Jak znaleźć tabele w bazie StudioSystem?

Baza StudioSystem zawiera wiele połączonych ze sobą elementów danych. Ponadto system ten pozwala na łatwe zarządzanie informacjami poprzez przyjazny interfejs. Następnie użytkownik może szybko odnaleźć potrzebne tabele dzięki specjalnej funkcji wyszukiwania.

Podobnie jak w innych systemach bazodanowych, StudioSystem wyświetla strukturę tabel po kliknięciu odpowiedniej opcji w menu. Wówczas na ekranie pojawia się przejrzysty widok wszystkich dostępnych tabel wraz z ich opisem. Wreszcie każda tabela w tym systemie posiada unikalne oznaczenie, dzięki czemu przypomina książkę w dobrze zorganizowanej bibliotece.

Nawigacja po bazie przypomina spacer po uporządkowanym magazynie, gdzie każdy element ma swoje miejsce. Dodatkowo system oferuje możliwość filtrowania wyników według różnych kryteriów. Zatem użytkownik może szybko dotrzeć do interesujących go informacji.

Widoki SQL

Wybór Widoki powoduje wyświetlenie listy widoków bazy SQL które są zainstalowane w bazie StudioSystem. Jak działają widoki w bazie SQL StudioSystem?

W bazie danych SQL StudioSystem widoki stanowią wirtualne tabele, które pozwalają użytkownikom na łatwy dostęp do danych. Następnie te zasoby umożliwiają szybkie przeglądanie informacji bez konieczności pisania złożonych zapytań. Ponadto widoki działają podobnie jak okna, przez które można obserwować wybrane fragmenty bazy danych.

Projektanci bazy StudioSystem stworzyli widoki dla usprawnienia codziennej pracy z danymi, zatem ich wykorzystanie znacznie przyspiesza proces analizy informacji. Równocześnie administrator może nadawać różne uprawnienia do poszczególnych widoków, co przypomina rozdawanie kluczy do konkretnych pomieszczeń. W konsekwencji każdy pracownik otrzymuje dostęp tylko do tych danych, które są mu faktycznie potrzebne.

Zarządzanie widokami w StudioSystem przypomina organizowanie biblioteki, gdzie każdy dział ma swój własny katalog. Jednocześnie użytkownicy mogą łatwo odnaleźć potrzebne informacje dzięki przejrzystemu interfejsowi systemu. W rezultacie praca z bazą danych staje się bardziej intuicyjna oraz wydajna.

Procedury Składowane

Wybór Procedury powoduje wyświetlenie listy procedur składowanych bazy SQL które są zainstalowane w bazie StudioSystem. Jak działa wybór procedury w bazie SQL StudioSystem?

Baza SQL StudioSystem zawiera wiele przydatnych narzędzi do zarządzania danymi. Zatem wybór procedury otwiera przed użytkownikiem szeroki wachlarz możliwości pracy z bazą danych. W związku z tym system automatycznie wyświetla kompletną listę wszystkich zainstalowanych procedur składowanych.

Procedury składowane w StudioSystem przypominają małe programy wykonujące określone zadania na danych. Następnie każda z nich posiada unikalną nazwę oraz zestaw parametrów potrzebnych do jej uruchomienia. Ponadto użytkownik może szybko przeszukiwać listę procedur podobnie jak przegląda katalog w bibliotece.

Funkcje bazy SQL

Wybór Funkcje powoduje wyświetlenie listy funkcji bazy SQL które są zainstalowane w bazie StudioSystem. Jakie znaczenie mają funkcje SQL w bazie StudioSystem?

Funkcje SQL stanowią podstawowy element pracy z bazą StudioSystem oraz znacząco usprawniają zarządzanie danymi. Wbudowane narzędzia matematyczne oraz tekstowe pozwalają na szybkie przetwarzanie informacji w bazie danych. Ponadto programiści wykorzystują te mechanizmy do tworzenia zaawansowanych zapytań oraz raportów.

Dostępne w StudioSystem funkcje agregujące umożliwiają łatwe obliczanie sum oraz średnich wartości podobnie jak w arkuszu kalkulacyjnym. Następnie administratorzy bazy mogą także korzystać z funkcji daty oraz czasu do precyzyjnego określania przedziałów czasowych. Dodatkowo system oferuje rozbudowane funkcje tekstowe do formatowania oraz łączenia ciągów znaków.

Assembly

Wybór Assemblypowoduje wyświetlenie listy Assembly bazy SQL które są zainstalowane w bazie StudioSystem. Dlaczego warto znać listę Assembly w bazie SQL Server?

Znajomość Assembly w bazie danych SQL Server pozwala programistom efektywniej zarządzać kodem aplikacji. Następnie umożliwia to sprawniejsze wykrywanie potencjalnych konfliktów między różnymi wersjami bibliotek. Ponadto administrator może szybciej reagować na problemy z zależnościami między komponentami.

Przeglądanie listy zainstalowanych Assembly przypomina analizowanie składników przepisu kulinarnego. Zatem programista widzi wszystkie dostępne biblioteki CLR zintegrowane z bazą StudioSystem. Co więcej, narzędzie to wyświetla szczegółowe informacje o każdym Assembly, takie jak wersja czy poziom zabezpieczeń. Dlatego też deweloperzy mogą łatwiej zarządzać wersjami komponentów w swoich projektach.

Triggery

Wybór Triggery powoduje wyświetlenie listy Triggerów bazy SQL które są zainstalowane w bazie StudioSystem. Jak działają Triggery w bazie danych SQL StudioSystem?

W bazach danych SQL Triggery pełnią funkcję podobną do czujnych strażników pilnujących zmian w tabelach. Ponadto automatycznie reagują na określone zdarzenia w bazie danych StudioSystem. Następnie wykonują zdefiniowane wcześniej działania w odpowiedzi na te zdarzenia.

Triggery w StudioSystem monitorują operacje INSERT oraz UPDATE na tabelach tak jak kamery monitorujące w sklepie. Dodatkowo automatyzują procesy aktualizacji powiązanych danych w innych tabelach bazy. Zatem znacząco wpływają na spójność i integralność przechowywanych informacji w systemie.