數(shù)據愛好者/工具，以及為什么遲早需要一個。

 

該數(shù)據庫可能很復雜且令人生畏。

作為開發(fā)人員(特別是如果您來自后端團隊)，您受到非技術團隊成員或客戶詢問字段含義的電子郵件轟炸了多少次?

記錄和組織數(shù)據庫元數(shù)據對此很重要，但這并不是我們的首要任務。 由于數(shù)據庫的復雜性，我們經常避免維護它，或者更糟的是首先創(chuàng)建它。

那是數(shù)據庫文檔工具派上用場的地方。 除了可以幫助您使用預定義的格式為數(shù)據庫創(chuàng)建詳細的數(shù)據目錄外，對于整個團隊來說，工具可能是寶貴的資產。

這篇博客文章將與您分享數(shù)據庫文檔工具的真正重要性，以及應該用來提高個人和團隊工作效率的前5種工具。

什么是數(shù)據庫文檔工具?

Internet上沒有具體，廣泛接受的文檔工具定義，因此，我將嘗試根據自己的知識和研究進行總結。

數(shù)據庫文檔編制工具充當數(shù)據目錄，以簡化的表格格式捕獲數(shù)據庫的所有信息。

它最常用作提供表模式詳細信息的數(shù)據字典，或用作提供數(shù)據庫內部所有關系概述的單個事實來源。

 

 

為什么我們需要數(shù)據庫文檔工具?

文檔工具既有短期利益，也有長期利益。

但是，由于大多數(shù)人只知道它的臨時優(yōu)勢，而對全局卻疏忽大意，因此他們傾向于將這些工具視為臨時解決方案。

數(shù)據庫文檔編制工具的一些較明顯的短期好處是：

• 幫助開發(fā)人員快速為當前項目建立數(shù)據庫結構原型
• 業(yè)務成員(銷售人員，BA)可以輕松理解具有開發(fā)人員輸入的豐富元數(shù)據的表字段的上下文和含義

但是，使數(shù)據庫編錄工具真正有價值的是長期利益：

• 工具可以幫助開發(fā)人員生成整體數(shù)據庫文檔，將其作為每個人的真實來源。 現(xiàn)在，數(shù)據庫的知識并沒有鎖定在任何高級開發(fā)人員中，而是在他們離開公司時走出了大門。 留下來。
• 當團隊擴展時，共享的數(shù)據Wiki可以幫助避免將來發(fā)生沖突。 高級開發(fā)人員可以使用一種數(shù)據源輕松地加入新手。
• 一些工具允許共享，外部用戶可以在線訪問數(shù)據庫文檔的最新版本。 無需手動截圖或會議。 是的，這將有助于節(jié)省您的編碼時間，從長遠來看，還可以提高企業(yè)的生產率和聲譽，特別是如果您的企業(yè)屬于咨詢行業(yè)。

2020年排名前5位的數(shù)據庫文檔工具

2020個用戶需要2020個設計樣式。

沒有人愿意使用那些可以追溯到90年代的設計風格的工具。

同樣，數(shù)據分析的格局也變得越來越復雜。 團隊更加意識到要構建可擴展的分析堆棧，從而將重點更多地放在他們的數(shù)據倉庫上。

因此，數(shù)據庫的復雜性和規(guī)模不斷增長，以處理大量數(shù)據源。

因此，我們需要功能強大的工具來適應數(shù)據庫的增長，但它們必須輕巧且設計精美，足以為我們日益繁忙的開發(fā)人員節(jié)省時間。

下面我們整理了滿足這些要求的5種數(shù)據庫文檔工具的列表：

• dbdocs.io
• 大數(shù)據
• ApexSQL文件
• RedGate SQL文檔
• 模式間諜

dbdocs.io

 

dbdocs.io是一個免費的簡單工具，可為您的數(shù)據庫創(chuàng)建基于Web的數(shù)據庫文檔。 與大多數(shù)競爭對手不同，dbdocs.io最輕巧，不需要復雜的設置。

此外，dbdocs具有自己的DSL語言，可幫助開發(fā)人員快速定義和記錄其數(shù)據庫架構和結構。 您可以在此處簽出樣本文檔。

價錢

dbdocs處于測試階段，因此完全免費。 您可以從這里開始。

優(yōu)點

• 輕巧且易于設置。 通過CLI安裝dbdocs的唯一要求是擁有NodeJS和NPM(大多數(shù)開發(fā)人員已經擁有)。 無需將其連接到任何數(shù)據庫。
• 使用DBML(它自己的開源DSL語言)來記錄數(shù)據庫的超快速方式。 您可以完全控制要添加到文檔中的架構，關系和元數(shù)據。
• 具有數(shù)據庫結構的可視化概述以及每個表及其關系的單獨視圖。 您可以將dbdocs與dbdiagram.io結合使用，以快速建立數(shù)據庫ERD的原型。
• 通過簡單的鏈接輕松與團隊成員共享文檔。 如果您使用的是客戶端，請使用密碼保護功能將文件設為私有文件，并且只有具有密碼的用戶才能訪問。
• 輕松集成到您的工作流程中。 在git倉庫中創(chuàng)建一個DBML文件，并在每次提交時對其進行更新。
• 適用于任何操作系統(tǒng)。 dbdocs只需要一個簡單的代碼編輯器和一個CLI工具即可生成文檔(例如Windows和Mac中的Terminal)，這意味著任何用戶都可以使用它!
• 即時電子郵件支持

缺點

• dbdocs.io是一個相當新的工具，因此缺少某些功能，例如版本控制或深度編輯功能。 但是據開發(fā)人員說，這些功能已經在路線圖上。
• dbdocs不允許協(xié)作編輯。 當前，每個開發(fā)人員都可以使用本地DBML文件來編輯文檔，因此一項所做的更改將不會反映在另一項的文檔中。
• dbdocs不像大多數(shù)競爭對手那樣支持導出功能，但即將推出。

dataedo

 

Dataedo是一個高級數(shù)據庫文檔工具，其中包括數(shù)據字典，ERD和業(yè)務詞匯表。

它將連接到廣泛的數(shù)據源列表(即MySQL，PostgreSQL，Oracle，Amazon Redshift…)并提取元數(shù)據，您可以在其中添加更有意義的自定義信息。

與dbdocs一樣，Dataedo允許開發(fā)人員使用ER圖可視化數(shù)據模型。

價錢

Dataedo提供三種定價計劃：Pro，Pro +和Enterprise。

專業(yè)版的費用為每位用戶每月39美元(30.11英鎊)，其中包括標準電子郵件支持和五個自定義字段。 Pro +版本的費用為每位用戶每月79美元(60.99英鎊)，其中包含10個自定義字段和優(yōu)先級支持。

企業(yè)版每100個自定義字段的價格為每位用戶每月159美元(122.74英鎊)，具有諸如模式變更跟蹤和業(yè)務詞匯表之類的額外功能。如果您覺得當前計劃不適合，它們還會提供自定義定價計劃。

優(yōu)點

• 支持大量的數(shù)據源
• 易于創(chuàng)建的ER圖：只需拖放數(shù)據表，Dataedo即可自動檢測并可視化它們之間的關系。
• 豐富的元數(shù)據：用戶可以使用自定義字段和豐富的文本描述數(shù)據元素，或將表組織到不同的模塊中
• 共享性：除PDF和Excel格式外，用戶還可以生成不需要專用服務器的交互式HTML

缺點

• 初創(chuàng)企業(yè)可能會發(fā)現(xiàn)定價有些開銷。
• 復雜的設置
• 該工具需要陡峭的學習曲線才能充分利用其功能
• 僅適用于Windows用戶

ApexSQL

 

ApexSQL是一個功能強大的工具，不僅適用于SQL，而且適用于SSIS，SSAS，SSRS和Tableau文檔。 ApexSQL最令人印象深刻的功能是自定義。 您可以使用不同的樣式，自定義文本，主題和圖形完全自定義文檔及其布局。

價錢

ApexSQL每位用戶僅需花費699美元。 從長遠來看，這聽起來像是一筆合理的投資，但這意味著該工具僅限于一個用戶。

優(yōu)點

• 強大的定制和個性化功能
• 各種服務的支持文檔
• 輕松自動化和安排文檔
• 支持多種輸出格式(CHM，HTML，Word，MD和PDF)
• 包括圖形關系和數(shù)據模型圖

缺點

• 僅適用于Windows用戶
• 對于具有多個用戶的團隊要協(xié)作記錄其數(shù)據庫的前期費用較高
• 需要陡峭的學習曲線才能充分利用其功能
• 過時的設計風格

Redgate SQL文件

 

Redgate SQL Doc是一種工具，可幫助您快速自動地為數(shù)據庫生成文檔。 您可以獲取有關數(shù)據庫模式，對象間和數(shù)據庫間依賴關系的概述，并帶有批注以幫助用戶找到所需的內容。 您還可以通過右鍵單擊對象資源管理器在SSMS中記錄數(shù)據庫。

您可以在此處查看示例。

價錢

Redgate SQL Doc可滿足廣泛的用途。 如果您的團隊有1-4個用戶，則每位用戶(生命周期)的費用為385美元，包括1年的支持和升級。 如果您的團隊有5–9個用戶，則每位用戶的費用為327美元，將少一些。 如果您的團隊有10–20個用戶，則價格為308美元。 對于20多個用戶，您可以聯(lián)系團隊以獲取個性化報價。

優(yōu)點

• 通過CLI輕松自動化文檔
• 支持多種輸出格式(PDF，HTML，MS Word)

缺點

• Redgate SQL Doc主要用于查看目的，因此其編輯功能非常有限。 您不能更改表字段，類型，值，它們是任何模式的基本組成部分。 您只能編輯描述。
• 過時的設計風格(UI和UX)
• 無法創(chuàng)建ER圖

schemaspy

 

SchemaSpy是此列表上的第二個免費工具。 它是基于Java，基于CLI的工具(需要Java 5或更高版本)，可分析數(shù)據庫架構的元數(shù)據并以瀏覽器可顯示的格式生成其可視化表示形式

您可以在此處檢查文檔的預覽。

價錢

SchemaSpy是免費使用的。

優(yōu)點

• SchemaSpy是免費且輕量級的。 如果與RedGate SQL Doc(具有幾乎相同的功能集(生成ERD除外))相比，那么SchemaSpy無疑具有定價優(yōu)勢
• 易于設置和配置
• SchemaSpy可以掃描并生成數(shù)據庫的綜合元數(shù)據(表，列，約束，關系，孤立表，異常，例程)
• 支持Markdown表注釋!

缺點

• 該項目已近一年沒有更新(最新版本v6.1.0已于2019年9月18日發(fā)布)。 該功能強大的工具的所有者似乎不會積極支持它，因此，如果您希望擁有不斷更新的功能和新功能，那么該工具可能不適合您。
• SchemaSpy編輯功能受到限制。 它既不能向表組件添加注釋，也不能直接編輯/添加當前架構的更多元數(shù)據。
• 過時的設計風格(尤其是圖表)

結論

每個文檔工具都是為滿足特定需求而設計的，因此第一手了解您的業(yè)務需求非常重要。

如果您只想生成當前數(shù)據庫的只讀版本，那么RedGate SQL Doc和SchemaSpy是優(yōu)秀選擇。 盡管SchemaSpy適合預算有限的團隊，但是RedGate SQL Doc可能會為您提供更多的保證，因為該產品仍在積極開發(fā)中。

如果您需要通過更多的元數(shù)據和外觀精美的ER圖來豐富文檔，則絕對應該選擇dbdocs.io。 它自己的語言(DBML)不需要太多學習，并且比傳統(tǒng)的DDL語言(如SQL)更容易編寫，閱讀和維護。 另外，此工具特別適合咨詢初創(chuàng)公司/中小型企業(yè)，因為它是免費的，具有可共享文件和密碼保護，可在任何OS上使用。

如果您的企業(yè)規(guī)模很大并且對數(shù)據庫文檔的預算很大，那么dbdocs.io的可能替代方法是dataedo。 與dbdocs.io相比，它具有更多功能，這些功能需要更陡峭的學習曲線，這可能會成為應用的障礙。

如果您優(yōu)先考慮記錄各種服務(以及大量的自定義)，那么ApexSQL是首屈一指的! 與Dataedo相似，由于高昂的前期成本和每用戶定價模型，該工具適用于預算較大的數(shù)據團隊。