Jak udokumentować bazę danych

Piotr Kononow15 marzec 2016

Agenda

I. Po co dokumentowaćII. Czym jest dokumentacja bazy danychIII. Jak dokumentować

I. PO CODOKUMENTOWAĆ

Potrzeba analizy danych rośnie

• Wyszukiwania w Google

Niejasne

• MTL_SYSTEM_ITEMS_B• tP• BEN_PRTT_RMT_RQST_CTFN_PRVDD• RSRCSECX• ATTRIBUTE_5

Skomplikowane

Duże

Tabel i widoków:• Przykładowa aplikacja: 3 000• TETA: 9 000• Oracle e-Business Suite: 55 000• SAP: 130

000

PA_ADW_R_ACT_CMT_B_V.TXN_ADW_NOTIFY_FLAG

W jakich sytuacjach to pomocne?

• Tworzenie oprogramowania• Hurtownie danych, BI, …• Wdrożenia ERP, CRM, billing…• Integracja• Rozwój i utrzymanie• Migracja do nowego systemu

II. CZYM JESTDOKUMENTACJA BAZY DANYCH

1. Słownik danych (data dictionary)

Table: employeeTable holds past, current and future company employees.

Column Data type DescriptionBusinessEntityID int Primary key for Employee records. Foreign key

to BusinessEntity.BusinessEntityID.NationalIDNumber nvarchar(15) Unique national identification number such as

a social security number.LoginID nvarchar(256) Network login.OrganizationNode hierarchyid Where the employee is located in corporate

hierarchy.OrganizationLevel smallint The depth of the employee in the corporate

hierarchy.JobTitle nvarchar(50) Work title such as Buyer or Sales

Representative.

1. Słownik danych – stanyEmployee row can be in following statuses based on dates:• Future - start_date > today or start_date null• Current - start_date <= today and (end_date > today or null)• Past – end_date < today

1. Słownik danych – lista wartości

Column DescriptionMaritalStatus M = Married, S = SingleCurrentFlag 0 = Inactive, 1 = Active

1. Słownik danych – APITo modify and fetch data use this:• employee_get – returns specified employee row• employees_get – returns selected employees• employee_insert – use this to insert new employee• employee_update – use this to update employee row• employee_delete – use this to delete employee

1. Słownik danych – używane przez

View: employees_active_v

Used by: Employees search form, Active employees report

1. Słownik danych – źródła

Table: employee

Data source: Employees form, sync_employees

Column SourceMaritalStatus Employees formNationalIDNumber Employees formNumber emp_no triggerScore Data warehouse, calc_employees_scores

1. Słownik danych – metadane

Table: po_headers_all (Purchase orders)

Module: PurchasingResponsible: Piotr Kononow

Columnpo_header_idpo_header_number [DEPRECATED]po_header_codequantity

1. Słownik danych – wartość dodana

Table: invoices

Column Descriptionnumber Invoice numberdate Invoice date

1. Słownik danych – wartość dodana

Table: invoices

Column Descriptionnumber Invoice autogenerated number, starting from 1 each

year. Number is generated when invoice gets approved.

date Invoice issue date. Null for working copy invoices. Set to today’s date on invoice approval.

2. Diagram Związków Encji (ERD)

2. Diagram Związków Encji (ERD)

Nie chodzi o to:

Chodzi o to:

3. Dokumentacja kodu

Metadane, historia zmian

III. JAKDOKUMENTOWAĆ

Na bieżąco i staleDobra praktyka:

Czym dokumentować?

1. Excel, Word, notatnik

Czym dokumentować?

1. Excel, Word, notatnik2. Konsola

Czym dokumentować?

1. MS Excel, MS Word, notatnik2. Konsola3. Dedykowane narzędzia

• Redgate SQL Doc• Apex SQL Doc• Dataedo

Dedykowane narzędzia

Dedykowane narzędzia

Dedykowane narzędzia

http://tools.dataedo.com

Dedykowane narzędzia

Darmowe licencje

http://dataedo.com/3camp

Pytania?

Dziękuję za uwagę!

Piotr KononowPiotr.Kononow(at)logicsystems.com.pl