CREATE LIBRARY

将包含用户定义的扩展 (UDx) 的库加载到 Vertica 编录。Vertica 自动将库文件和支持库的副本分发到所有群集节点。

因为库被添加至数据库编录，因此数据库重新启动后也将如此。

在编录中加载库后，即可使用 CREATE FUNCTION 等语句定义该库中包含的扩展。有关详细信息，请参阅开发用户定义的扩展 (UDx)。

语法

CREATE [OR REPLACE] LIBRARY
    [[database.]schema.]name
    AS 'path'
    [ DEPENDS 'depends-path' ]
    [ LANGUAGE 'language' ]

参数

OR REPLACE
如果存在相同名称的库，请将其替换。编录中定义的引用更新库的 UDx 会自动开始使用新的库文件。

如果您不使用此指令并且库已经存在，则 CREATE 语句会返回错误。

[database.]schema

数据库和架构。默认架构为 public。如果指定一个数据库，它必须是当前数据库。

name
要创建的库的名称。这是在库中创建函数时使用的名称（请参阅创建 UDx 函数）。虽然不是必需的，但最好匹配文件名。
AS path
要加载的库的路径，可以是启动程序节点文件系统上的绝对路径，也可以是其他支持的文件系统或对象存储的 URI。
DEPENDS 'depends-path'

此库所依赖的文件或库，启动程序节点的文件系统或其他受支持的文件系统或对象存储中的一个或多个文件或目录。对于目录，路径条目以斜杠 (/) 结束，后跟通配符 (*)（可选）。要指定多个文件，请使用冒号 (:) 分隔条目。

如果任何路径条目包含冒号（例如 URI），请在整个 DEPENDS 路径两端加上括号，且单个路径元素使用双引号，如下例所示：

DEPENDS '["s3://mybucket/gson-2.3.1.jar"]'

要指定具有多个目录级别的库，请参阅多级库依赖项。

DEPENDS 对使用 R 编写的库没有影响。R 软件包必须本地安装在每个节点上，包括外部依赖项。

如果 Java 库依赖于本机库（SO 文件），请使用 DEPENDS 指定路径并调用 UDx 中的 System.loadLibrary() 以从该路径加载本机库。

LANGUAGE 'language'
库中函数的编程语言，下列之一：

  • C++ （默认值）

  • Python

  • Java

  • R

特权

超级用户，或者架构上的 UDXDEVELOPER 和 CREATE。非超级用户必须显式启用 UDXDEVELOPER 角色，如下例所示：

=> SET ROLE UDXDEVELOPER;
SET

-- Not required, but you can confirm the role as follows:
=> SHOW ENABLED ROLES;
     name      |   setting
---------------+--------------
 enabled roles | udxdeveloper
(1 row)

=> CREATE LIBRARY MyLib AS '/home/dbadmin/my_lib.so';
CREATE LIBRARY

-- Create functions...

-- UDXDEVELOPER also grants DROP (replace):
=> CREATE OR REPLACE LIBRARY MyLib AS '/home/dbadmin/my_lib.so';

要求

  • Vertica 会制作自己的库文件副本。后期修改或删除该语句中指定的原始文件不会影响编录中定义的库。要更新库，请使用 ALTER LIBRARY。

  • 加载库并不能保证该功能可以正常工作。CREATE LIBRARY 会对库文件执行一些基本检查，以验证库文件是否兼容 Vertica。如果语句检测到库未正确编译或发现了其他一些基本的不兼容性，则语句失败。但是，CREATE LIBRARY 无法检测到共享库中的许多其他问题。

如果 DEPENDS 子句指定具有多个目录级别的库，Vertica 将按照库路径包含该库的所有子目录。例如，以下 CREATE LIBRARY 语句使 UDx 库 mylib 能够导入它在 site‑packages 的子目录中找到的所有 Python 包和模块：

=> CREATE LIBRARY mylib AS '/path/to/python_udx' DEPENDS '/path/to/python/site-packages' LANGUAGE 'Python';

示例

在 dbadmin 帐户的主目录中加载库：

=> CREATE LIBRARY MyFunctions AS '/home/dbadmin/my_functions.so';

加载位于您启动 vsql 的目录中的库：

=> \set libfile '\''`pwd`'/MyOtherFunctions.so\'';
=> CREATE LIBRARY MyOtherFunctions AS :libfile;

从云端加载库：

=> CREATE LIBRARY SomeFunctions AS 'S3://mybucket/extensions.so';

加载依赖于同一目录中多个 JAR 文件的库：

=> CREATE LIBRARY DeleteVowelsLib AS '/home/dbadmin/JavaLib.jar'
   DEPENDS '/home/dbadmin/mylibs/*' LANGUAGE 'Java';

加载具有多个显式依赖项的库：

=> CREATE LIBRARY mylib AS '/path/to/java_udx'
   DEPENDS '/path/to/jars/this.jar:/path/to/jars/that.jar' LANGUAGE 'Java';

在云中加载具有依赖项的库：

=> CREATE LIBRARY s3lib AS 's3://mybucket/UdlLib.jar'
   DEPENDS '["s3://mybucket/gson-2.3.1.jar"]' LANGUAGE 'Java';