使い方
- インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
- 必要なツール、認証情報、対応環境を原文で確認します。
- 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/xsavikx/okf-skills --skill okf-postgresql開始前の確認
- 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
- スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文
見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。
PostgreSQL OKF Connector
This skill provides a Go-based CLI tool to convert PostgreSQL database schemas and comments (table and column descriptions) into Open Knowledge Format (OKF) bundles, and synchronize comments back to a PostgreSQL database from an OKF bundle.
When to Use
Use this skill when you need to:
- Extract table structures, column definitions, keys, schemas, and native PostgreSQL comments (descriptions) from a schema into a portable OKF bundle.
- Synchronize business descriptions or documentation changes written in an OKF bundle back into native PostgreSQL table and column comments using native SQL comment mechanisms.
Setup
The connector requires Go 1.24+:
bash
# Install the published binary (Go 1.24+) — no clone needed:
go install github.com/xSAVIKx/okf-skills/skills/okf-postgresql@v0.1.0
# …or build from a clone of the repository:
cd skills/okf-postgresql
go build -o okf-postgresql .How to Use
1. Produce an OKF Bundle
Extract database schema metadata and comments:
bash
./okf-postgresql produce --host <host> --port <port> --user <user> --password <password> --db <database-name> --schema <schema-name> --out <output-bundle-dir> [--tables <comma-separated-table-names>] [--sample <N>] [--profile]2. Ingest / Synchronize an OKF Bundle
Synchronize table/column descriptions from the OKF bundle back into database comments:
bash
./okf-postgresql ingest --host <host> --port <port> --user <user> --password <password> --db <database-name> --schema <schema-name> --bundle <path-to-okf-bundle> [--sync]Parameters:
--host(defaultlocalhost): PostgreSQL host.--port(default5432): PostgreSQL port.--user(defaultpostgres): PostgreSQL user.--password(required): PostgreSQL password. May also be supplied via thePGPASSWORDenvironment variable to keep secrets out of the command line.--db(required): Target database name.--schema(defaultpublic): Target schema name.--bundle(required for ingest): Path to the OKF bundle.--out(required for produce): Path to output OKF bundle.--tables(optional): Filter to extract only specific tables.--sample <N>(optional): Embed up to N sample rows per table as a## Samplesection in each table doc (default 0 = none).--profile(optional): Compute per-column statistics (non-null, null, distinct, min, max) and embed a## Data Profilesection.--sync(optional for ingest): If provided, runsCOMMENT ON TABLE ...andCOMMENT ON COLUMN ...statements to synchronize descriptions.
3. Inspect the Schema (self-description)
Print a machine-readable JSON description of this skill's commands and flags (used by okf-mcp to expose the skill as an MCP tool):
bash
./okf-postgresql schema
