Wie dokumentiere ich die Oracle-Datenbank?

7

Ich bin neu in Oracle-Datenbanken. Ich habe SQL Server und die Beschreibungsfelder (MS_Description) für Tabellen und Spalten zu Dokumentationszwecken verwendet. Gibt es ein Äquivalent für Oracle? Was ist die beste Vorgehensweise zum Dokumentieren der Oracle-Datenbank?

oracle metadata documentation jrara
quelle
1
Sie könnten auch an dieser verwandten Frage
Jack sagt, versuchen Sie es mit topanswers.xyz

Antworten:

10

In Oracle würden Sie den Befehl COMMENT verwenden, um:

[...] Fügen Sie dem Datenwörterbuch einen Kommentar zu einer Tabelle oder Tabellenspalte, einer Ansicht, einer materialisierten Ansicht, einem Operator, einem Indextyp, einem Miningmodell oder einer Edition hinzu.

Die meisten Tools (PL / SQL Developer, Toad ...) zeigen diese Kommentare in entsprechenden Feldern an, wenn Sie das Datenbankschema durchsuchen.

Die Kommentare können direkt mit den *COMMENTSWörterbuchansichten abgefragt werden , z ALL_TAB_COMMENTS.

Vincent Malgrat
quelle
8

In Oracle gibt es Tabellen- und Spaltenkommentare, die zur Dokumentation verwendet werden können.

Diese Kommentare können einfach mit den folgenden Befehlen hinzugefügt werden:

COMMENT ON TABLE my_table IS 'Documentation of my table'
/


COMMENT ON COLUMN my_table.my_columns IS 'Documentation of my column'
/
Peter Åkerlund
quelle
0

Oracle stellt sein Datenwörterbuch über Ansichten zur Verfügung. Mit diesen Ansichten können Sie die benötigten Informationen abfragen.

Die wichtigsten Ansichten, die Sie verwenden müssen, sind:

  • DBA_OBJECTS - listet alle DB-Objekte auf
  • DBA_TABLES- Liste aller Tabellen (und ihrer Eigentümer, die in Oracle Schemata sind )
  • DBA_TAB_COLUMNS - Alle Tabellen und ihre Spalten auflisten

Darüber hinaus gibt es ALL_%und USER_%Äquivalente dieser Ansichten (zB: `USER_TABLES) , die nur alle Objekte zeigen Sie die Berechtigung auf, und Objekte , die Sie besitzen.

Philᵀᴹ
quelle
1
Vielen Dank für diese Antwort, aber ich denke, Sie haben meine Frage falsch verstanden. Ich weiß, dass ich diese Objekte abfragen kann, aber wie kann ich meine eigenen Metadaten schreiben, z. B. für Spalten? Wenn eine Spalte vorhanden ist, CustomerIDmöchte ich möglicherweise die vom ETL-Prozess generierte Ersatz-ID hinzufügen. Siehe zum Beispiel diesen Link
jrara
0

Wenn Sie dies in der Oracle-Datenbank tun müssen, ist der Kommentarbefehl Ihre Antwort. Die Dokumentation des Schemas auf diese Weise hat jedoch einige Nachteile:

  • bestimmte Berechtigungen sind erforderlich (nicht immer möglich)
  • In einigen Fällen können Sie die Datenbank (Drittanbieter / Legacy) nicht stören
  • Sie können keine langen Beschreibungen verwenden (maximal 4000 Zeichen).
  • Sie können keinen Text (direkt) verwenden oder formatieren.
  • Sie können keine Bilder hinzufügen
  • Keine einfache Möglichkeit, die Dokumentation zu durchsuchen

Ich würde empfehlen, die Dokumentation in einem dedizierten Repository zu speichern. Überprüfen Sie das Dataedo- Datenbankdokumentationstool. Es liest das Schema (und vorhandene Kommentare) und ermöglicht es Ihnen, jedes Element mit Rich Text und Bildern (für Ihre ERD-Diagramme) zu beschreiben. Sie können dann in ein schönes PDF-Dokument oder interaktives HTML exportieren. Wenn sich das Schema ändert, können Sie Ihre Dokumentation mit wenigen Klicks synchronisieren.

Ich bin der Produktmanager von Dataedo.

Bad Pitt
quelle