旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。
PDK
プラグイン開発キット(PDK)は、プラグインが独自のロジックを実装するために使用できる Lua 関数と変数のセットです。
PDK はもともと Kong 0.14.0 でリリースされました。
PDKは、1.0.0 リリース以降の上位互換性が保証されています。
プラグイン開発キットには kong
グローバル変数からアクセスできます。
また、このテーブルには、kong.request
、kong.log
などのような、さまざまな機能の名前空間に整理されています。
kong.version
現在実行中のノードのバージョン番号を含む、人間が判読できる文字列。
使用方法
print(kong.version) -- "2.0.0"
kong.version_num
現在実行されているノードのバージョン番号を表す正数で、比較や機能の存在チェックに役立ちます。
使用方法
if kong.version_num < 13000 then -- 000.130.00 -> 0.13.0
-- no support for Routes & Services
end
kong.configuration
現在のKongノードの設定を含む読み取り専用のテーブルは、 設定ファイルと環境変数に基づいています。
詳細については、kong.conf.default を参照してください。
kong.conf
ファイルのカンマ区切りのリストは、このテーブルでは文字列の配列に昇格されています。
使用方法
print(kong.configuration.prefix) -- "/usr/local/kong"
-- this table is read-only; the following throws an error:
kong.configuration.prefix = "foo"
kong.db
KongのDAO(kong.db
モジュール)のインスタンス。さなまざなエンティティのアクセサーオブジェクト
が含まれています。
このDAOおよび新しいスキーマ定義の詳細なドキュメントは、今後利用可能になる予定です。
使用方法
kong.db.services:insert()
kong.db.routes:select()
kong.dns
KongのDNSリゾルバのインスタンス、lua-resty-dns-clientモジュールからのクライアントオブジェクト。
注: このモジュールの使用は、現在のところ、コアユーザーまたは上級ユーザーに限定されています。
kong.worker_events
lua-resty-eventsモジュールからワーカー間の通信向けKongのIPCモジュールのインスタンス。
注: このモジュールの使用は、現在のところ、コアユーザーまたは上級ユーザーに限定されています。
kong.cluster_events
ノード間通信用のKongクラスタイベントモジュールのインスタンス。
注: このモジュールの使用は、現在のところ、コアユーザーまたは上級ユーザーに限定されています。
kong.cache
kong.cache
モジュールからのKongのデータベースキャッシュオブジェクトのインスタンス。
注: このモジュールの使用は、現在のところ、コアユーザーまたは上級ユーザーに限定されています。