| + + + + + + | +openGauss=# select id_number,name from creditcard_info; + +-----------+------------------------------------------- +1 | \x011aefabd754ded0a536a96664790622487c4d36 + + + |
+
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | + | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +|||
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ |
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ |
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ |
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | +
|---|---|---|---|---|---|
| + | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | +
| + | ++ | ++ | ++ | ++ | +
|---|---|---|---|---|
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
|---|---|---|---|---|---|---|---|
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
|---|---|---|---|---|---|---|---|---|
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | ++ | ++ | ++ | ++ | +
| + + + + + + + + + + | +
| + + + + + + + + + + | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | +
| + | ++ + + + | +
detail: 明细数据。
all: 包含summary和detail。| +|report\_scope|指定生成report的范围，可以为cluster或者node。|cluster: 数据库级别的信息。
node: 节点级别的信息。| +|node\_name|在report\_scope指定为node时，需要把该参数指定为对应节点的名称。(节点名称可以执行select \* from pg\_node\_env;查询)。在report\_scope为cluster时，该值可以指定为省略、空或者为NULL。| | + + + +执行操作 + +```sql +postgres@omm:local=#select * from pg_node_env; + node_name | host | process | port | installpath | datapath | log_directory +-----------+-----------+---------+------+------------------+---------------------+--------------- + mogdb | localhost | 1 | 5432 | /usr/local/mogdb | /var/lib/mogdb/data | pg_log +(1 row) +postgres@omm:local=# +postgres@omm:local=#\a \t \o wdr_20220502.html +postgres@omm:local=#select generate_wdr_report(1,2,'all','node','mogdb'); +``` +## c.执行如下命令关闭输出选项及格式化输出命令。 +```Plain Text +\o \a \t +``` + + +# 查看报告 + + + + diff --git "a/content/zh/post/Frank/openGauss MogDB\350\204\232\346\234\254\346\272\220\347\240\201\346\265\205\346\236\220\357\274\2102\357\274\211\342\200\224\342\200\224 gs_install_plugin gs_install_plugin_local.md" "b/content/zh/post/Frank/openGauss MogDB\350\204\232\346\234\254\346\272\220\347\240\201\346\265\205\346\236\220\357\274\2102\357\274\211\342\200\224\342\200\224 gs_install_plugin gs_install_plugin_local.md" new file mode 100644 index 0000000000000000000000000000000000000000..9c56eacf2303f97ebe314f0a270678e66e492f29 --- /dev/null +++ "b/content/zh/post/Frank/openGauss MogDB\350\204\232\346\234\254\346\272\220\347\240\201\346\265\205\346\236\220\357\274\2102\357\274\211\342\200\224\342\200\224 gs_install_plugin gs_install_plugin_local.md" @@ -0,0 +1,336 @@ +# openGauss/MogDB脚本源码浅析（2）—— gs\_install\_plugin/gs\_install\_plugin\_local +# 摘要 +> openGauss提供了gs\_install\_plugin/gs\_install\_plugin\_local工具用于安装插件，目前支持安装的插件包括pg\_repack、pg\_trgm、dblink、wal2json、orafce、pg\_bulkload、pg\_prewarm等。gs\_install\_plugin适用于一主多备部署的MogDB,gs\_install\_plugin\_local适用于单机部署的MogDB。 + +这两个工具是python编写的脚本，直接可以看到源码实现。本文通过对两个工具的源码进行分析，希望从底层了解插件安装的原理，掌握原理后可以在安装出现问题或者手动安装时对整个安装流程有所帮助。 + + + +# 整体流程 +主要流程有如下几个步骤： + +## 1 解析参数 +根据命令行传入参数进行解析，并设置相关变量，如：要安装哪些插件、是否强制覆盖、指定安装包路径、是否开启调试信息等。 + + + +* \-h, --help + +显示帮助信息 + +* \-p + +指定plugins安装包位置，默认在\$GPHOME/script/static寻找plugins安装包 + +* \--all + +安装全部插件 + +* \--force + +指定覆盖旧的插件 + +* \--plugins + +可安装多个插件，--plugins后跟插件名 + +* \--PLUGIN\_NAME + +指定安装某一个插件，如：--dblink + +* \--debug + +输出debug信息 + +**详细请参考“****官方文档****”** + +## 2 初始化Deploy类 +将解析好的参数赋值给Deploy类的成员变量。 + + + +几处关键代码： + +* 环境变量和关键目录 + +```python +GAUSSHOME = os.getenv("GAUSSHOME") +GPHOME = os.getenv('GPHOME') +LIB_POSTGRESQL_DIR = f'{GAUSSHOME}/lib/postgresql' +EXTENSION_DIR = f'{GAUSSHOME}/share/postgresql/extension' +CONTRIB_DIR = f'{GAUSSHOME}/share/postgresql/contrib' +``` +主要是得到下载插件包的目录和安装openGauss插件的系统目录。 + +* 插件包目录 + +如果没有设置-p选型，则使用默认目录 + +```cpp +self.plugin_pkg = f"{GPHOME}/script/static/Plugins-*.tar.gz" +``` +* 解压插件包的目录 + +```python +self._plugins_temp_dir = f"{GPHOME}/script/static/plugins/" +self.executor(f'mkdir -p {self._plugins_temp_dir}') +logger.debug(f"deconpress plugin package to {self._plugins_temp_dir}") +self.local_execute(f"tar -xf {self.plugin_pkg} -C {self._plugins_temp_dir}") +``` +* 集群相关 + +```bash +-X Specify the XML file path +``` +如果是集群安装（使用gs\_install\_plugin工具），需要指定cluster\_config.xml的位置，通过下面方法获得具体node的ip地址并检查链接： + +```python +self.nodenames = self.read_cluster_hosts(self.xml) +self.ssh_tool = SshTool(self.nodenames) +``` +* 读取desc.json文件 + +解压MogDB插件包后，文件夹下面有desc.json文件，文件中包含了版本信息，插件名称和安装的目标路径。插件名称对应同级目录下插件目录的名称，files节点对应了插件目录中的文件。 + + + +```json +{ + "version": "3.0.1", + "plugins": [ + { + "name": "pg_trgm", + "files": { + "pg_trgm.so": "lib/postgresql", + "pg_trgm.control": "share/postgresql/extension", + "pg_trgm--1.0.sql": "share/postgresql/extension", + "pg_trgm--unpackaged--1.0.sql": "share/postgresql/extension" + } + }, + { + "name": "dblink", + "files": { + "dblink.so": "lib/postgresql", + "dblink.control": "share/postgresql/extension", + "dblink--1.0.sql": "share/postgresql/extension", + "dblink--unpackaged--1.0.sql": "share/postgresql/extension" + } + }, + { + "name": "orafce", + "files": { + "orafce.so": "lib/postgresql", + "orafce.control": "share/postgresql/extension", + "orafce--3.17.sql": "share/postgresql/extension" + } + }, + { + "name": "wal2json", + "files": { + "wal2json.so": "lib/postgresql" + } + }, + { + "name": "pg_repack", + "files": { + "pg_repack": "bin", + "pg_repack.so": "lib/postgresql", + "pg_repack.control": "share/postgresql/extension", + "pg_repack--1.4.6.sql": "share/postgresql/extension" + } + }, + { + "name": "pg_bulkload", + "files": { + "pg_bulkload": "bin", + "pg_bulkload.so": "lib/postgresql", + "pg_bulkload.control": "share/postgresql/extension", + "pg_bulkload--1.0.sql": "share/postgresql/extension", + "pg_bulkload.sql": "share/postgresql/extension", + "pg_bulkload--unpackaged--1.0.sql": "share/postgresql/extension", + "uninstall_pg_bulkload.sql": "share/postgresql/extension", + "pg_timestamp.so": "lib/postgresql", + "pg_timestamp.sql": "share/postgresql/contrib", + "postgresql": "bin", + "uninstall_pg_timestamp.sql": "share/postgresql/contrib" + } + }, + { + "name": "pg_prewarm", + "files": { + "pg_prewarm.so": "lib/postgresql", + "pg_prewarm.control": "share/postgresql/extension", + "pg_prewarm--1.1.sql": "share/postgresql/extension" + } + }, + { + "name": "dolphin", + "files": { + "dolphin.so": "lib/postgresql", + "dolphin.control": "share/postgresql/extension", + "dolphin--1.0.sql": "share/postgresql/extension" + } + }, + { + "name": "whale", + "files": { + "whale.so": "lib/postgresql", + "whale.control": "share/postgresql/extension", + "whale--1.0.sql": "share/postgresql/extension" + } + }, + { + "name": "postgis", + "files": { + "libjson-c.so.2": "lib", + "libgeos_c.so.1": "lib", + "libproj.so.9": "lib", + "libgeos-3.6.2.so": "lib", + "libgdal.so.1": "lib", + "liblwgeom-2.4.so.0": "lib", + "postgis-2.4.so": "lib/postgresql", + "rtpostgis-2.4.so": "lib/postgresql", + "postgis_topology-2.4.so": "lib/postgresql", + "postgis.control": "share/postgresql/extension", + "postgis--2.4.2.sql": "share/postgresql/extension", + "postgis_raster--2.4.2.sql": "share/postgresql/extension", + "postgis_raster.control": "share/postgresql/extension", + "postgis_topology--2.4.2.sql": "share/postgresql/extension", + "postgis_topology.control": "share/postgresql/extension" + } + } + ] +} +``` +## 3 执行部署 + + +* 解析desc.json文件，将解析结果存到datas\[\]中 + +```python + datas = [] + # json file to obtain plugin information, add to datas + with open(desc_path, 'r', encoding='utf-8') as f: + result = json.load(f) + if "all" in para: + datas = result.get("plugins") + else: + for plugin in result.get("plugins", {}): + if plugin.get("name") in para: + datas.append(plugin) + if not datas: + raise Exception("Invalid plugins: %s" % para) +``` +* 遍历datas\[\]中插件信息，进行文件copy，完成安装 + +```python +# plugin file copy +for data in datas: + name = data.get("name") + if not name: + continue + for file, path in data.get("files").items(): + source_path = '/'.join([self.plugins_dir, name, file]) + target_dir = '/'.join([GAUSSHOME, path]) + self.copy_file(source_path, target_dir) + print("SUCCESS: %s" % name) +``` +* 文件copy过程 + +```python +def copy_file(self, source, target_dir): + file_name = os.path.basename(source) + + if self.local_mode: + if os.path.exists(f"{target_dir}/{file_name}") and not self.force: + print("Warning: file %s already exists, skip copy" % (file_name)) + return + return shutil.copy2(source, target_dir) + for host in self.nodenames: + if not self.force: + _, output = self.ssh_tool.getSshStatusOutput(f"test -f {target_dir}/{file_name} && echo 1 || echo 0", hostList=[host]) + output = output.split(':')[-1] + if int(output) == 1: + print("Warning: [%s]: file %s already exists, skip copy" % (host, file_name)) + continue + self.ssh_tool.scpFiles(source, target_dir, hostList=[host]) +``` +如果是本地安装则直接copy：`shutil.copy2(source, target_dir)` + +如果是集群按照则使用scp进行copy：`self.ssh_tool.scpFiles(source, target_dir, hostList=[host])` + + + +# 使用gs\_install\_plugin\_local一直openGauss插件 +## 准备环境 +* 下载，安装插件包 + +```bash +[omm@host-10-208-76-194 script]$ cd /opt/mogdb/tool/script/ +[omm@host-10-208-76-194 script]$ mkdir static +[omm@host-10-208-76-194 script]$ cd static +[omm@host-10-208-76-194 static]$ wget https://cdn-mogdb.enmotech.com/mogdb-media/3.0.1/Plugins-3.0.1-openEuler-arm64.tar.gz +[omm@host-10-208-76-194 script]$ ./gs_install_plugin_local +SUCCESS: pg_trgm +SUCCESS: dblink +SUCCESS: orafce +SUCCESS: wal2json +SUCCESS: pg_repack +SUCCESS: pg_bulkload +SUCCESS: pg_prewarm +SUCCESS: dolphin +SUCCESS: whale +SUCCESS: postgis + +``` +* 安装插件（默认全部安装） + + + +* 创建插件 + +```sql +MogDB=# create extension orafce; +CREATE EXTENSION +MogDB=# + +``` +* 下载编译openGauss插件 + +参见“MogDB秘籍 之 乾坤大挪移”中的关于编译安装openGauss插件章节。 + +## 迁移插件 +> 以lo插件为例，进行迁移 + +* 创建lo目录 + +```bash +[omm@host-10-208-76-194 plugins]$ cd /opt/mogdb/tool/script/static/plugins/plugins +[omm@host-10-208-76-194 plugins]$ ls +dblink desc.json dolphin orafce pg_bulkload pg_prewarm pg_repack pg_trgm postgis wal2json whale +[omm@host-10-208-76-194 plugins]$ mkdir lo +[omm@host-10-208-76-194 plugins]$ ls +dblink desc.json dolphin lo orafce pg_bulkload pg_prewarm pg_repack pg_trgm postgis wal2json whale +[omm@host-10-208-76-194 plugins]$ +``` +* 将openGauss插件复制到MogDB插件目录，并修改属组 + +```bash +[root@host-10-208-76-194 lo]# cp lo.so lo.control lo--1.0.sql /opt/mogdb/tool/script/static/plugins/plugins/lo +[root@host-10-208-76-194 lo]# chown -R omm:omm /opt/mogdb/tool/script/static/plugins/plugins/lo +``` +* 修改desc.json + + + +* 重新打包 + +```bash +tar -zcvf Plugins-3.0.1-openEuler-arm64.tar.gz plugins/ +``` +注：这里重新打包有点麻烦，也可以修改代码，注释掉解压的步骤，或者优雅一点，则可以增加参数控制是否重新解压，如果不重新打包则解压是desc.json会被覆盖成老版本的，导致安装新插件失败。 + + + +# 总结 +总的来说这两个工具还是比较好用的，代码实现也比较简单。了解原理之后可以根据几个关键路径手动安装，或者在遇到安装问题的时候可以通过本文的分析继续排查解决。 \ No newline at end of file diff --git "a/content/zh/post/Frank/openGauss MogDB\350\260\203\347\224\250C FUNCTION.md" "b/content/zh/post/Frank/openGauss MogDB\350\260\203\347\224\250C FUNCTION.md" new file mode 100644 index 0000000000000000000000000000000000000000..0c50e5cffbabcbb8c1c4cf149af2ef1a13ba4600 --- /dev/null +++ "b/content/zh/post/Frank/openGauss MogDB\350\260\203\347\224\250C FUNCTION.md" @@ -0,0 +1,182 @@ ++++ + +title = "openGauss/MogDB调用C FUNCTION" + +date = "2022-05-16" + +tags = ["openGauss/MogDB调用C FUNCTION"] + +archives = "2020-05" + +author = "xingchen" + +summary = "openGauss/MogDB调用C FUNCTION" + +img = "/zh/post/xingchen/title/8f11c785-f027-47b5-a1ba-726edaacb2f2.png" + +times = "18:40" + ++++ +# openGauss/MogDB调用C FUNCTION +# 摘要 +> 之前写过一篇关于[postgresql自定义函数实现，通过contrib模块进行扩展](https://blog.csdn.net/xk_xx/article/details/123011397 "postgresql自定义函数实现，通过contrib模块进行扩展")的帖子，今天和恩墨工程师进行了一些交流，在MogDB中也可以实现同样的功能，原以为需要完整的openGauss的源码才能完成，但在恩墨工程师的指点下，了解到，通过既有官网版本的安装包就可以进行插件开发。而且，使用postgres的C FUNCTION要比开发插件更加容易些。也感谢恩墨专家提供的线索和思路:+1: :+1: + +# 环境准备 +* 安装MogDB +参考官方文档，写的已经很详细了。 +* 服务器环境 +本地虚拟机 centos 7.9 + +***注意：尽量进入******omm******用户下进行编译，可以避免一些不必要的环境问题*** + +# 代码 +* C代码 +基本与postgres插件开发一样，关键是4,5,6三行。 + +```cpp +#include "postgres.h" +#include "fmgr.h" + +PG_MODULE_MAGIC; +extern "C" Datum add_ab(PG_FUNCTION_ARGS); +PG_FUNCTION_INFO_V1(add_ab); + +Datum +add_ab(PG_FUNCTION_ARGS) +{ + int32 arg_a = PG_GETARG_INT32(0); + int32 arg_b = PG_GETARG_INT32(1); + + PG_RETURN_INT32(arg_a + arg_b); +} +``` +* CMakeLists.txt + +```makefile +cmake_minimum_required (VERSION 2.8) + +project (gs_plug) +set(CMAKE_CXX_FLAGS "-Wall -std=c++11 -Wall") +set(CMAKE_CXX_FLAGS_DEBUG "-g3") +set(CMAKE_CXX_FLAGS_RELEASE "-O2") +set(CMAKE_BUILD_TYPE Debug) + +set(MOG_INCLUDE /opt/mogdb/app/include/postgresql/server) +set(MOG_LIBPATH /opt/mogdb/app/lib/postgresql/proc_srclib) +include_directories(${MOG_INCLUDE}) + +aux_source_directory(. DIR_SRCS) +add_library (${PROJECT_NAME} SHARED ${DIR_SRCS}) + +install(TARGETS ${PROJECT_NAME} DESTINATION ${MOG_LIBPATH}) +``` +***要点1：获取包含头文件的目录*** + +```Plain Text +[omm@vmpc funcs]$ pg_config --includedir +/opt/mogdb/app/include +``` +所需头文件路径：\`pg\_config --includedir\`/postgresql/server + +***要点1：c函数安装路径*** + +```Plain Text +[omm@vmpc funcs]$ pg_config --pkglibdir +/opt/mogdb/app/lib/postgresql +``` +安装路径：\`pg\_config --pkglibdir\`/proc\_srclib/ + + + +# 编译 & 安装 +```Plain Text +[omm@vmpc funcs]$ mkdir build +[omm@vmpc funcs]$ cd build/ +[omm@vmpc build]$ cmake ../ +CMake Deprecation Warning at CMakeLists.txt:1 (cmake_minimum_required): + Compatibility with CMake < 2.8.12 will be removed from a future version of + CMake. + + Update the VERSION argument