9.14. XML関数

9.14.1.1. xmlcomment

xmlcomment(text)

関数xmlcommentは特定のテキストを内容としてXMLコメントを含んだXML値を作成します。テキストには結果として構築されるXMLコメントが有効になるよう--もしくは-で終結する内容を含んではなりません。引数がNULLならば結果もNULLになります。

Example:

SELECT xmlcomment('hello');

  xmlcomment
--------------
 <!--hello-->

9.14.1.2. xmlconcat

 xmlconcat(xml[, ...])
 

関数xmlconcatは、XMLの内容断片を含む単一の値を作成するための個別のXML値のリストを結合します。ヌル値は削除され、NULL以外の引数が存在しないときのみ結果はヌルになります。

Example:

SELECT xmlconcat('<abc/>', '<bar>foo</bar>');

      xmlconcat
----------------------
 <abc/><bar>foo</bar>

XML宣言が提示されている場合は次のようにまとめることができます。全ての引数の値が同一のXMLversion宣言を持っていれば、そのversionが結果に使用されます。さもなければversionは使用されません。もし全ての引数の値がstandalone宣言値である"yes"であれば、その値が結果に使用されます。もし全ての引数の値がstandalone宣言値であり、その中で１つでも"no"がある場合、それが結果に使用されます。さもなければ、結果はstandalone宣言を持ちません。もし結果がstandalone宣言を必要としていても、standalone宣言がない場合には、XMLはversion宣言を含むXML宣言を要求するため、version 1.0のversion宣言が使用されます。encoding宣言は無視され、全ての場合で削除されます。

例：

SELECT xmlconcat('<?xml version="1.1"?><foo/>', '<?xml version="1.1" standalone="no"?><bar/>');

             xmlconcat
-----------------------------------
 <?xml version="1.1"?><foo/><bar/>

9.14.1.3. xmlelement

 xmlelement(name name [, xmlattributes(value [AS attname] [, ... ])] [, content, ...])
 

xmlelement式は与えられた名前、属性、および内容を持つXML要素を生成します。

例：

SELECT xmlelement(name foo);

 xmlelement
------------
 <foo/>

SELECT xmlelement(name foo, xmlattributes('xyz' as bar));

    xmlelement
------------------
 <foo bar="xyz"/>

SELECT xmlelement(name foo, xmlattributes(current_date as bar), 'cont', 'ent');

             xmlelement
-------------------------------------
 <foo bar="2007-01-26">content</foo>

有効でないXML名の要素と属性名は、シーケンス_xHHHH_により違法な文字を置換することでエスケープされます。ここで、HHHHは１６進数によるその文字のUnicode文字コード番号です。例をあげます。

SELECT xmlelement(name "foo$bar", xmlattributes('xyz' as "a&b"));

            xmlelement
----------------------------------
 <foo_x0024_bar a_x0026_b="xyz"/>

属性値が列参照の場合、明示的な属性名を指定する必要はありません。この場合、デフォルトで列名が属性名として使用されます。その他の場合、属性は明示的な名前で与えられなければなりません。従って、以下の例は有効です。

CREATE TABLE test (a xml, b xml);
SELECT xmlelement(name test, xmlattributes(a, b)) FROM test;

しかし、以下の例は有効ではありません。

SELECT xmlelement(name test, xmlattributes('constant'), a, b) FROM test;
SELECT xmlelement(name test, xmlattributes(func(a, b))) FROM test;

もし要素内容が指定されればデータ型に従って書式化されます。もし内容そのものがxml型であれば、複合XML文書が構築されます。例をあげます。

SELECT xmlelement(name foo, xmlattributes('xyz' as bar),
                            xmlelement(name abc),
                            xmlcomment('test'),
                            xmlelement(name xyz));

                  xmlelement
----------------------------------------------
 <foo bar="xyz"><abc/><!--test--><xyz/></foo>

そのほかの型の内容は有効なXML文字データにフォーマットされます。これは特に文字<、>、および&がエンティティに変換されることを意味します。バイナリデータ（データ型はbytea）は、構成パラメータxmlbinaryの設定にしたがって、base64もしくは16進符号化方式で表現されます。個々のデータ型に対する特定の振る舞いは、XMLスキーマ仕様でのSQLおよびPostgreSQLデータ型に調整するため展開されると期待されます。この時点でより詳細な記述が出現します。

9.14.1.4. xmlforest

 xmlforest(content [AS name] [, ...])
 

xmlforest式は与えられた名前と内容を使用し、要素のXMLフォレスト（シーケンス）を生成します。

例：

SELECT xmlforest('abc' AS foo, 123 AS bar);

          xmlforest
------------------------------
 <foo>abc</foo><bar>123</bar>


SELECT xmlforest(table_name, column_name) FROM information_schema.columns WHERE table_schema = 'pg_catalog';

                                         xmlforest
-------------------------------------------------------------------------------------------
 <table_name>pg_authid</table_name><column_name>rolname</column_name>
 <table_name>pg_authid</table_name><column_name>rolsuper</column_name>
 ...

第２の例に見られるように、内容の値が列参照の場合要素名は省略可能です。この場合、列名がデフォルトで使用されます。そうでない場合、名前が指定されなければなりません。

有効なXML名ではない要素名は上のxmlelementで説明した通りエスケープされます。同様にして、前々からxml型でないかぎり内容データは有効なXML内容になるようにエスケープされます。

XMLフォレストは１つ以上の要素からなる場合、有効なXML文書ではありません。したがって、xmlelementにxmlforest式をラップすることが有用なことがあります。

9.14.1.5. xmlpi

 xmlpi(name target [, content])
 

xmlpi式はXML処理命令を作成します。内容が存在すれば、その内容は?>文字シーケンスを含んではなりません。

Example:

SELECT xmlpi(name php, 'echo "hello world";');

            xmlpi
-----------------------------
 <?php echo "hello world";?>

9.14.1.6. xmlroot

 xmlroot(xml, version text|no value [, standalone yes|no|no value])
 

xmlroot式はXML値のルートノードの属性を変更します。versionが指定されていると、version宣言での値を変更し、standalone値が指定されていると、standalone宣言での値を変更します。

SELECT xmlroot(xmlparse(document '<?xml version="1.1"?><content>abc</content>'), version '1.0', standalone yes);

                xmlroot
----------------------------------------
 <?xml version="1.0" standalone="yes"?>
 <content>abc</content>

9.14.1.7. xmlagg

xmlagg(xml)

ここで説明している関数とは異なり、xmlagg関数は集約関数です。xmlconcatが行うように、入力値を集約関数呼び出しに連結します。集約関数についての一般情報は項9.18を参照してください。

例：

CREATE TABLE test (y int, x xml);
INSERT INTO test VALUES (1, '<foo>abc</foo>');
INSERT INTO test VALUES (2, '<bar/>');
SELECT xmlagg(x) FROM test;
        xmlagg
----------------------
 <foo>abc</foo><bar/>

現在の実装において連結の順序は原則として定義されていないことに注意してください。しかし、入力値を別の形で保存することも可能です。例えば、上記の例において次のようにして順序に影響を与えることもできるでしょう。

SELECT xmlagg(x) FROM (SELECT * FROM test ORDER BY y DESC) AS tab;
        xmlagg
----------------------
 <bar/><foo>abc</foo>

しかしこの手法はあらゆる場面や、すべてのPostgreSQLのバージョンに対して保障されているわけではありません。将来のPostgreSQLバージョンは（xmlagg(expr ORDER BY expr, expr, ... のような）相応の方法でこの順序を制御する追加機能を提供してくれるかもしれません。

9.14.1.8. XML述語

xml IS DOCUMENT

式IS DOCUMENTは引数XML値が適切なXML文書であれば真を返し、そうでなければ（つまり、内容の断片）偽を返すか、もしくは引数がNULLであればNULLを返します。文書と内容の断片の差異については項8.13を参照してください。