他のバージョンの文書9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

名前

CREATE CAST — 新しいキャストを定義する

概要

CREATE CAST (source_type AS target_type)
    WITH FUNCTION function_name (argument_type [, ...])
    [ AS ASSIGNMENT | AS IMPLICIT ]

CREATE CAST (source_type AS target_type)
    WITHOUT FUNCTION
    [ AS ASSIGNMENT | AS IMPLICIT ]

CREATE CAST (source_type AS target_type)
    WITH INOUT
    [ AS ASSIGNMENT | AS IMPLICIT ]

説明

CREATE CASTを使用すると、新しいキャストを定義できます。 キャストは、2つのデータ型間の変換処理方法を指定するものです。 以下に例を示します。

SELECT CAST(42 AS float8);

この文を実行すると、事前に指定された関数(この場合float8(int4))が呼び出され、整数定数42がfloat8型に変換されます (適切なキャストが定義されていない場合、変換処理は失敗します)。

2つのデータ型をバイナリ強制互換とすることができます。 これは、関数をまったく呼び出さなくても、自由に変換を行うことができることを意味します。 これには、対応する値は、同じ内部表現を使用している必要があります。 例えば、データ型textvarcharには、両方向でバイナリ互換性があります。 バイナリ強制互換性は必ずしも対称関係ではありません。 例えば、現在の実装ではxmlからtextへのキャストは自由に行うことができますが、逆方向では少なくとも構文検査を行う関数が必要です。 (2つの型が両方向でバイナリ強制互換であることは、バイナリ互換性と呼ばれます。)

WITH INOUT構文を使用してI/O変換キャストとしてキャスト定義を行うことができます。 I/O変換キャストは、元データ型の出力関数を呼び出し、その結果文字列を対象データ型の入力関数に渡すことで行われます。 多くの一般的な場合では、この機能により変換用に別個のキャスト関数を作成する必要性がなくなります。 I/O変換キャストは通常の関数を基にしたキャストと同様に動作します。ただ実装が異なるだけです。

デフォルトでは、キャストは明示的なキャスト要求があった場合のみ発生します。 明示的なキャスト要求の構文は、CAST(x AS typename)、もしくは、x::typename式です。

キャストにAS ASSIGNMENTオプションを付けると、対象データ型の列に代入する際、暗黙的にそのキャストを発生させることができます。 例えば、foo.f1text型の列であるとします。

INSERT INTO foo (f1) VALUES (42);

integer型をtext型に変換するキャストにAS ASSIGNMENTオプションが付けられていれば、上記のSQL文が実行できます。 しかし、AS ASSIGNMENTオプションが付いていなければ、実行できません (一般的に、この種のキャストを代入キャストと呼びます)。

キャストにAS IMPLICITオプションを付けると、代入の場合だけでなく、式の中にある場合でも、全てのコンテキストで暗黙的にそのキャストを呼び出すことができます。 (一般的に、この種のキャストを暗黙キャストと呼びます。) 例えば次のような問い合わせを考えてみます。

SELECT 2 + 4.0;

パーサはまず定数にそれぞれintegernumericであると印を付けます。 システムカタログには、integer + numericという演算子はありませんが、numeric + numericという演算子は存在します。 したがって、integerからnumericへのキャストが利用可能であり、そのキャストにAS IMPLICITが付いていればこの問い合わせは成功します(実際このようになっています)。 パーサは暗黙的なキャストを行い、問い合わせをあたかも次のように記載されたものとして解決します。

SELECT CAST ( 2 AS numeric ) + 4.0;

ここで、カタログはまたnumericからintegerへのキャストも提供しています。 もしこのキャストにAS IMPLICITが付いていたら(実際は付いていません)、パーサは上のように解釈するか、それとも、numeric定数をintegerにキャストし、integer + integerという演算子を適用するかを選択しなければなりません。 どちらがより良いかという知見がなければ、選択をあきらめ、問い合わせがあいまいであると宣告します。 2つのキャストの内1つのみが暗黙的であるという事実が、パーサに、numericintegerが混在する式をnumericとして扱うという適切な解決方法を知らせる方法です。 これに関する組み込まれた知見は存在しません。

暗黙キャストは、多用しない方が賢明です。 暗黙的キャストを使用し過ぎると、PostgreSQLがコマンドを思わぬ意味に解釈してしまう原因になります。 また、複数の解釈が可能なため、コマンドをまったく解読できなくなってしまう可能性もあります。 経験的には、2つのデータ型が同一の一般的なデータ型のカテゴリに属しており、変換によって情報が保持される場合のみ、暗黙キャストを呼び出し可能にするのが良い方法と思われます。 例えば、int2型からint4型へのキャストは、暗黙キャストにするのが妥当ですが、float8型からint4型へのキャストは、おそらく代入キャストのみにすべきでしょう。 text型からint4型への変換のような、カテゴリを越えるデータ型のキャストは、明示的にのみ使用するのが適切です。

注記

型の集合の中で複数の暗黙的なキャストを提供することが、有用性や標準との互換性上の理由により必要となることがあり、これにより、上で説明した通り防ぐことができないあいまいさが引き起こされます。 パーサは、こうした状況でも望ましい動作の提供を補助できる型カテゴリ優先される型に基づいた発見的手法を用意しています。 詳細はCREATE TYPEを参照してください。

キャストを作成するためには、変換元または変換先(の内の一方)のデータ型を所有し、もう一方の型に対するUSAGE権限を持つ必要があります。 また、バイナリ強制互換性を持つキャストを作成できるのは、スーパーユーザでなければなりません。 (バイナリ強制互換性があるキャスト変換を誤って使用するとサーバがクラッシュしてしまう可能性が高いことから、この制限が付けられました)。

パラメータ

source_type

キャストする変換元のデータ型の名前です。

target_type

キャストする変換先のデータ型の名前です。

function_name(argument_type [, ...])

キャストを実行するために使用される関数です。 関数名はスキーマ修飾することができます。 スキーマ修飾されていない場合、関数はスキーマ検索パスから検索されます。 関数の結果のデータ型は、キャストの変換先のデータ型と一致する必要があります。 引数については後で説明します。

WITHOUT FUNCTION

変換元データ型から変換先データ型への間に、バイナリ強制互換性があることを示します。 この場合、キャストを実行するのに関数は必要ありません。

WITH INOUT

キャストが、変換元データ型の出力関数を呼び出し、その結果の文字列を変換先データ型の入力関数に渡すことで行われる、I/O変換キャストであることを示します。

AS ASSIGNMENT

代入コンテキストで、暗黙的にキャストを呼び出せることを示します。

AS IMPLICIT

任意のコンテキストで、暗黙的にキャストを呼び出せることを示します。

キャストを実装する関数は1〜3個の引数を取ることができます。 1番目の引数型はキャストの変換元データ型と同一、または、変換元データ型からのバイナリ強制互換を持つ型でなければなりません。 2番目の引数(もしあれば)は、integer型でなければなりません。変換先の型に関連付けられた型修飾子を指定します。 型修飾子がない場合は-1を指定します。 3番目の引数(もしあれば)は、boolean型でなければなりません。キャストが明示的なキャストであればtrueを、それ以外であればfalseを指定します (奇妙な話ですが、標準SQLでは、明示的キャストと暗黙的キャストとの間で異なる振舞いを要求する場合があります。 この引数はそのようなキャストを実装しなければならない関数用に提供されています。 独自のデータ型をこの流儀に従うように設計することは勧められません)。

キャスト関数の戻り値は、キャストの対象型と同一またはバイナリ強制互換性を持たなければなりません。

通常、キャストにおける変換元データ型と変換先データ型は異なる必要があります。 しかし、2つ以上の引数を持つ関数でキャストを実装した場合は、変換元と変換先とで同一のデータ型を持つキャストを宣言することができます。 これは、システムカタログにおいて型固有の長さ強制関数を表現するために使用されています。 指定された関数は、型の値を強制的に2番目の引数で与えられた型修飾子の値にするために使用されます

キャストが変換元と変換先のデータ型が異なり、複数の引数を取る関数を持つ場合、あるデータ型から他のデータ型への変換と長さの強制を1つの操作にまとめたものをサポートします。 引数を1つしか取らない場合は、型修飾子を使用して型を強制するために、データ型間の変換と修飾子の適用という2つのキャスト操作が必要となります。

ドメイン型へのキャスト、ドメイン型からのキャストは現在は効果がありません。 ドメインへのキャスト、ドメインからのキャストは、基となる型と関連したキャストを使用します。

注釈

ユーザ定義のキャストを削除するにはDROP CASTを使用してください。

データ型を双方向に変更可能にするには、双方向のキャストを明示的に宣言する必要があることに注意してください。

ユーザ定義型と標準文字列型(textvarcharchar(n))、および文字列カテゴリとして定義されたユーザ定義型との間のキャストを作成することは、通常必要ありません。 PostgreSQLはこのために自動的なI/O変換キャストを提供します。 この文字列への自動キャストは代入キャストとして扱われますが、文字列型からの入出力変換キャストは明示的なキャストのみです。 この振舞いは独自のキャストを宣言して自動キャストを置き換えることで変更することができます。 しかし、通常このようにするのは、この変換を標準の代入のみまたは明示的のみの設定よりもより呼び出しやすくしたい場合に限られます。 他にも、型の入出力関数と異なる動作で変換したいという理由もあるかもしれません。 しかし、これは非常に驚かされるものであり、そうすべきかどうか熟考すべきです。 (組み込み型のごく一部は実際変換用に異なった振舞いをしますが、ほとんどは標準SQLの仕様のためのものです。)

必須ではありませんが、キャストを実装する関数には変換先のデータ型の名前を付けるという以前からの慣習に従っておくことを推奨します。 多くのユーザはtypename(x)という関数スタイルの記法でデータ型のキャストを行っています。 この記法は、キャストを実装している関数の呼び出しに他なりません。 キャストとして特別に扱われるわけではないのです。 ユーザが作成した変換関数の名前がこの慣習に従っていないと、他のユーザがとまどうことになります。 PostgreSQLは引数として異なる型を取る同じ名前の関数をオーバーロードすることができるので、様々な型から特定の変換先型への変換関数の名前を全て変換先の型名にしても特に問題は発生しません。

注記

実際のところ、前の段落は単純化しすぎたものです。 関数呼び出し式が実際の関数と一致しない状態でキャスト要求として扱われる状況が2つ存在します。 関数呼び出しname(x)が実際の関数に正確に一致せず、nameがデータ型の名前であり、pg_castxの型からその型へのバイナリ強制互換のキャストを提供する場合、この呼び出しはバイナリ強制互換キャストとして処理されます。 この例外は、実際の関数が存在しなくても、関数のような構文でバイナリ強制互換キャストを呼び出すことができるように作成されました。 同様に、pg_castに項目がないが、文字列型との間のキャストが存在する場合、この呼び出しは入出力変換キャストとして処理されます。 この例外により関数のような構文で入出力変換キャストができるようになります。

注記

この例外にも例外があります。 複合型から文字列型へのI/O変換キャストでは関数構文を使用して呼び出すことができず、明示的なキャスト構文(CAST記法または::記法のいずれか)で記述しなければなりません この例外は、自動提供I/O変換キャストを導入した後、関数または列参照を意図した時に非常に簡単に間違って呼び出されることが判明したため追加されました。

関数int4(bigint)を使用したbigint型からint4型への代入キャストを作成します。

CREATE CAST (bigint AS int4) WITH FUNCTION int4(bigint) AS ASSIGNMENT;

(このキャストは、システムに既に定義されています。)

互換性

SQLではバイナリ強制互換性があるデータ型や実装関数の追加の引数について規定されていません。さらに、AS IMPLICITは、PostgreSQLの拡張です。 これらの点以外では、CREATE CASTは標準SQLに準拠しています。

関連項目

CREATE FUNCTION, CREATE TYPE, DROP CAST