CREATE FOREIGN DATA WRAPPER

PostgreSQL 16.0文書
		SQLコマンド	誤訳等の報告
前へ	上へ	CREATE FOREIGN DATA WRAPPER	次へ

CREATE FOREIGN DATA WRAPPER <refpurpose>define a new foreign-data wrapper</refpurpose> — 新しい外部データラッパーを定義する

概要

CREATE FOREIGN DATA WRAPPER name
    [ HANDLER handler_function | NO HANDLER ]
    [ VALIDATOR validator_function | NO VALIDATOR ]
    [ OPTIONS ( option 'value' [, ... ] ) ]

説明

<title>Description</title>

<command>CREATE FOREIGN DATA WRAPPER</command> creates a new foreign-data wrapper. The user who defines a foreign-data wrapper becomes its owner. CREATE FOREIGN DATA WRAPPERは新しい外部データラッパーを作成します。外部データラッパーを定義したユーザがその所有者となります。

The foreign-data wrapper name must be unique within the database. 外部データラッパーの名前はデータベース内で一意でなければなりません。

Only superusers can create foreign-data wrappers. スーパーユーザのみが外部データラッパーを作成することができます。

パラメータ

<title>Parameters</title>

name

The name of the foreign-data wrapper to be created. 作成する外部データラッパーの名前です。

HANDLER handler_function

<para><replaceable class="parameter">handler_function</replaceable> is the name of a previously registered function that will be called to retrieve the execution functions for foreign tables. The handler function must take no arguments, and its return type must be <type>fdw_handler</type>.

handler_functionは、事前に登録された、外部テーブル向けの関数実行を受け付けるために呼び出される関数の名前です。ハンドラ関数は引数を取らず、fdw_handler型を返すものでなければなりません。

It is possible to create a foreign-data wrapper with no handler function, but foreign tables using such a wrapper can only be declared, not accessed. ハンドラ関数を持たない外部データラッパーを作成することもできますが、こうしたラッパーを使用する外部テーブルは宣言することができるだけでアクセスできません。

VALIDATOR validator_function

<para><replaceable class="parameter">validator_function</replaceable> is the name of a previously registered function that will be called to check the generic options given to the foreign-data wrapper, as well as options for foreign servers, user mappings and foreign tables using the foreign-data wrapper. If no validator function or <literal>NO VALIDATOR</literal> is specified, then options will not be checked at creation time. (Foreign-data wrappers will possibly ignore or reject invalid option specifications at run time, depending on the implementation.) The validator function must take two arguments: one of type <type>text[]</type>, which will contain the array of options as stored in the system catalogs, and one of type <type>oid</type>, which will be the OID of the system catalog containing the options. The return type is ignored; the function should report invalid options using the <function>ereport(ERROR)</function> function.

validator_functionは、外部データラッパーへ与える一般的なオプションと、その外部データラッパーを使用する外部サーバ、ユーザマップおよび外部テーブルへ与えるオプションを検査するために呼び出される、前もって登録された関数の名前です。検証関数がない、またはNO VALIDATORが指定された場合、オプションは作成時に検査されません。（実装に依存しますが、実行時外部データラッパーは無効なオプション指定を無視することも拒絶することもできます。）検証関数は2つの引数を取らなければなりません。 1つはtext[]型で、システムカタログ内に格納されたオプションの配列を含みます。もう1つはoid型で、オプションを含むシステムカタログのOIDです。戻り値の型は無視されます。関数はereport()関数を使用して無効なオプションを報告しなければなりません。

OPTIONS ( option 'value' [, ... ] )

This clause specifies options for the new foreign-data wrapper. The allowed option names and values are specific to each foreign data wrapper and are validated using the foreign-data wrapper's validator function. Option names must be unique. この句は新しい外部データラッパー用のオプションを指定します。使用できるオプション名と値は外部データラッパーごとに固有であり、外部データラッパーの検証関数を使用して検証されます。オプション名は一意でなければなりません。

注釈

<title>Notes</title>

<productname>PostgreSQL</productname>'s foreign-data functionality is still under active development. Optimization of queries is primitive (and mostly left to the wrapper, too). Thus, there is considerable room for future performance improvements. PostgreSQLの外部データ機能はまだ活発な開発がなされています。問い合わせの最適化がまだ開発が進んでいません（そしてほとんどがラッパーに任せられています）。したがって将来の性能向上の余地が大きくあります。

例

<title>Examples</title>

Create a useless foreign-data wrapper <literal>dummy</literal>: 無意味な外部データラッパーdummyを作成します。

CREATE FOREIGN DATA WRAPPER dummy;

Create a foreign-data wrapper <literal>file</literal> with handler function <literal>file_fdw_handler</literal>: file_fdw_handlerハンドラ関数を持つ外部データラッパーfileを作成します。

CREATE FOREIGN DATA WRAPPER file HANDLER file_fdw_handler;

Create a foreign-data wrapper <literal>mywrapper</literal> with some options: いくつかオプションを付けた外部データラッパーmywrapperを作成します。

CREATE FOREIGN DATA WRAPPER mywrapper
    OPTIONS (debug 'true');

互換性

<title>Compatibility</title>

<command>CREATE FOREIGN DATA WRAPPER</command> conforms to ISO/IEC 9075-9 (SQL/MED), with the exception that the <literal>HANDLER</literal> and <literal>VALIDATOR</literal> clauses are extensions and the standard clauses <literal>LIBRARY</literal> and <literal>LANGUAGE</literal> are not implemented in <productname>PostgreSQL</productname>. CREATE FOREIGN DATA WRAPPERはISO/IEC 9075-9 (SQL/MED)に従います。ただし、HANDLER句とVALIDATOR句は拡張であり、PostgreSQLでは標準のLIBRARY句とLANGUAGE句は実装されていません。

Note, however, that the SQL/MED functionality as a whole is not yet conforming. しかし、SQL/MED機能は全体としてまだ従っていないことに注意してください。

CREATE FOREIGN DATA WRAPPER

概要

説明

パラメータ

注釈

例

互換性

関連項目