人大金仓数据库KingbaseES---dbms_xmlquery包使用技巧（二）

关键字：

KingbaseES、XML、DBMS_XMLQUERY、人大金仓

概述

在目前的KingbaseES的使用过程中，我们会遇到数据库需要存储XML格式的数据，或者需要对查询的数据进行转换的问题，XML格式的数据类似于HTML格式数据，XML是一种扩展标记语言，最早于1998年被引入软件工业界，它不仅可以在WEB前端使用还可以应用于后端数据处理以及数据库存储等。

那么如何使用KingbaseES数据库对XML格式的数据进行读取，或者说如何使用KingbaseES数据库对我们查询到的结果转换为XML数据格式，从而方便我们后续的一些处理如：前后端系统间的交互等，那就不得不提到KingbaseES数据库所带有的dbms_xmlquery系统包了，这个系统包是kes用于兼容对xml文本格式自定义处理的一系列过程与函数的集合。

DBMS_XMLQUERY

在上一篇章中，我们介绍了DBMS_XMLQUERY包中构造函数与生成函数的使用方式，那么在本文中我们继续对该包中的部分函数进行介绍，在首先对于析构函数来说，主要的用途是用于与构造函数共同调用，并为DBMS_XMLQUERY包的句柄维护提供一定的帮助，使得用户可以自定义的声明句柄类型以及对句柄的补充操作，并在最后时释放句柄资源，防止资源冗余调用的情况，那么接下来先介绍该析构函数的使用：

这个析构函数closecontext，它的具体语法如下所示：

  procedure closeContext(ctxhdl in ctxHandle);

可以看到相对于构造函数newcontext来说，析构函数并没有多态的调用模式，一是因为析构函数所操作的句柄类型，因此直接对句柄所拥有的资源进行释放就可以，而是析构函数不能被重载，因此析构函数的设置只能有一个，并且在面向对象的编程思想中析构函数有且只能有一个，并且不能带参数。在PLSQL层中，我们需要提供一个接口函数来使得用户可以手动释放他所开辟的句柄类型，因此就可以通过设计一个存储过程来调用这个函数，用户只用传入已经被开辟的句柄类型，之后通过该过程释放该句柄下的所有资源以及该句柄类型，因此这个存储过程的传参只有一个，并且是一个in类型的参数，即这个参数只用于传入并不需要返回，需要注意的是当我们调用这个函数后，该句柄类型就被完全释放了，即其将变为空，所以当调用这个函数后就不能使用dbms_xmlquery包中其他set类型过程来对该句柄进行操作，但是可以继续用newcontext来声明新的句柄以提供后续的使用。

那么在介绍完基本的析构函数后，DBMS_XMLQUERY包的基础函数就被介绍完毕了，接下来就是对句柄的处理过程一些set存储过程的介绍，首先就是与生成XML格式直接相关的row类型参数设置过程，在DBMS_XMLQEURY包中主要有三个函数用于设置全局的row类型。接下来利用三个小的章节来介绍这三个存储过程。

2.1 setrowtag

首先第一个set存储过程：setrowtag的作用是用于设置生成的XML格式文本的每行的行表标签名称，这里主要有两个参数，第一个参数就是ctxHandle也就是我们在dbms_xmlquery包中所定义的句柄类型，这里设置成in out类型的参数与in类型的参数本质作用是一样的，第二个参数tag参数是一个in类型的varchar2参数，这里就是用于接收我们自定义的行标签名称。它的语法如下所示：

  procedure setrowtag(ctxhdl in out ctxHandle,tag in varchar2);

但如果传入的标签名称是格式不合法的XML标签值，并不会在设置过程中报出错误，而是在调用getxml函数时抛出错误，这是因为kes所提供的dbms_xmlquery包与oracle的不同点在于kes致力于生成的格式合法规范的xml格式文本，并且该文本可以直接参与其他应用端接口的调用，而oracle不对生成的xml做保障，这使得oracle中调用dbms_xmlquery包所生成的xml格式文本可能无法被其他应用端接口调用，它将格式合法的检查交给了用户处理，这使得该系统包提供的功能并不合理。

2.2 setrowsettag

其次第二个set存储过程：setrowsettag的作用则是用于设置生成的XML格式文本的基础行级标签，即将所有行包含起来的标签名称，它的语法如下所示：

procedure setrowsettag(ctxhdl in out ctxHandle,tag in varchar2);

这个存储过程也提供了两个传参，其类型与setrowtag相同，第一个参数也是传入的句柄类型，第二个参数也是传入的in类型的varchar类型参数，同样的与setrowtag存储过程相同点在于，kes的dbms_xmlquery包会对非法的行集级标签进行非法检查，并且检查过程也是在生成xml格式文本时。

2.2 settagcase

最后第三个set存储过程：settagcase的作用是用于修改句柄生成当前的xml格式文本的标签及属性等除了值和顶层声明意外的名称的大小写模式，该存储过程的第一个参数依然是一个句柄类型，用于处理对应的句柄，第二个参数是一个in类型的number参数，这个参数是调节大小写模式的关键。它的语法如下所示：

procedure setTagCase(ctxhdl in ctxhandle, tCase in number);

该参数传入0时，则是使用目前的默认大小写模式，即保持原有的大小写模式不变；当该参数传入1时，则是调用小写模式，但只对当前的句柄执行settagcase的句柄进行改变，而后续如果在增加其他参数或对生成的XML设置其他属性值则并不适用，后续设置的标签值则保持原有的大小写模式，而在settagcase之前的标签值则修改为小写模式；当该参数传入2时，则是调用大写模式，与调用小写模式时相同，不对后续增加的标签值进行修改，仅修改当前的标签值名称。对于该部分函数的详细描述可见图1所示：

图 1 Settagcase参数2流程图

函数使用技巧

通过第二章节的介绍，我们大致了解了这个函数的具体参数以及函数返回类型的意义，那么在了解这些内容的基础上，我们就可以很好的实现这个函数的调用，这个包由于是KingbaseES提供的，那么在使用时，我们需要调用create extension来创建这个包，我们可以选择在当前事务的过程中执行。只要表在当前事务中可以运行，那么我们就可以利用表来生成XML数据，那么利用一个PL/SQL执行块来执行这个函数，具体的调用方法如下所示：

declare

    ctx dbms_xmlquery.ctxtype;

    xml clob;

begin

    ctx := dbms_xmlquery.newcontext('select * from test');

    dbms_xmlquery.setrowtag(ctx,'kes');

    dbms_xmlquery.settagcase(ctx,2);

    dbms_xmlquery.setrowsettag(ctx,'kingbase');

    xml := dbms_xmlquery.getxml(ctx);

    dbms_output.put_line(xml);

    dbms_xmlquery.closecontext(ctx);

end;

在上面的PL/SQL执行块中，我们将一个查询结果提供给了一个句柄类型，并通过这个句柄类型生成了对应的xml文本数据，并对该句柄设置不同的参数值，在结束后关闭了这个句柄类型。这样XML中就存放了我们表的查询结果集到XML数据映射的结果集。下面图2与图3分别是该PLSQL的不执行set过程与执行set过程的结果图：

图 2 不执行set过程XML结果

图 3 执行set过程XML结果

从图2与图3的红框标注中可以看出执行set过程与否间的差异，并在图3中可以看到settagcase的修改仅在执行该过程时执行，因此后续添加的行集级标签kingbase并没有被修改为大写模式。

总结

在KingbaseES数据库的使用过程中，我们总是要应对各式各样的数据类型以及各种类型之间的转换，而在对XML数据格式的处理中，KingbaseES提供了一个系统包来提供将数据库到XML格式数据类型的转换。这样我们就可以直接将SQL查询的结果应用于其他的处理操作中。在使用过程中，我们任然需要加强对KingbaseES的探索，因为KingbaseES是一个强大的数据库管理系统，这里任然有许多强大的功能与特性值得我们去发现。

参考资料

《KingbaseES数据库-PL/SQL包与函数》