1

当社（PostgreSQL）では、SQLクエリを使用してほとんどの分析作業を行っています。現在、固定ディレクトリ構造に保存されている250以上のクエリがあります（DDL / DMLファイルも多数あります）。

これらすべてのクエリのドキュメントを作成し、出力（htmlなど）を生成するautodocツールはありますか？

関数/テーブル/手順のドキュメントに使用できるツールがいくつかあることは知っていますが、（私が理解している限り）クエリに適したツールはありません。例：

ドキュメントでは、次のことを追跡したいと思います。

  • ファイル名
  • SQLの説明
  • 著者
  • プロジェクト
  • タグ

固定ディレクトリ構造の制限は明らかです。クエリが論理的に多くのフォルダに属する場合がよくありますが、1つを選択する必要があります。trac wikiを使用しようとしましたが、複雑です（クエリのすべてのバージョンをコピーしてwikiに貼り付ける必要があります）。一方、タグを使用することもでき、簡単に検索でき、バージョン管理も可能です。また、高度な組み込み検索を備えたいくつかのクエリツール（Eclipse用のヒキガエルプラグインなど）を使用してみましたが、興味のあるファイルを取得するには、かなり複雑なregexを作成する必要があります。

これが、autodocアプローチがこのタスクの唯一の可能な方法であると私が信じる理由です。

4

2 に答える 2

1

このようなツールは一般的なユースケースではすぐに利用できるとは思わないので、慣例に固執するのが最善の選択肢は自分で作成することです。重要なのは、SQLの多くのドキュメントジェネレータが依存関係などを追跡しようとすることです。これはテーブルで比較的簡単に実行でき（たとえば、外部キーを動的に検出）、場合によっては関数で実行できますが、これを超えると実際になります。難しい。postgresql_autodoc私はdbオブジェクトに使用していることに注意してください。テーブルを追跡できることには問題があります（クエリが別のクエリで実行された場合はどうなりますsearch_pathか？わからないことがたくさんあります...）。

私の場合は、必要な情報を追跡するためにdoxygenを変更することを検討します。さらに、ファイルごとに1つのSQLステートメントがある場合にのみこれを行うことができます。たとえば、ファイルを文書化することは1つのことですが、クエリを文書化することとは大きく異なります。

COMMENT ONただし、検出可能なストアドプロシージャインターフェイスを採用し、SQLステートメントにコメントを入れることをお勧めします。これが私たちの仕事であり、自動文書化がはるかに簡単になります。次に、必要に応じてpostgresql_autodocまたは他のツールを使用できます。

于 2013-04-24T08:25:03.827 に答える
0

私が知っている唯一の1つは、MS SQLベースのものです：http：//www.apexsql.com/sql_tools_doc.aspx

于 2013-02-08T09:31:58.653 に答える