计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

DBE_FILE

更新时间:2024-05-07 GMT+08:00

DBE_FILE包为存储过程提供了读、写操作系统文本文件的能力。

注意事项

  • DBE_FILE要求以DBE_FILE.FOPEN打开的文件是以数据库字符集编码,如果打开的文件未按预期的字符集编码,在使用DBE_FILE.READ_LINE读取文件时,会发生编码校验错误;DBE_FILE要求以DBE_FILE.FOPEN_NCHAR打开的文件是以UTF-8字符集编码,如果打开的文件未按预期的字符集编码,在使用DBE_FILE.READ_LINE_NCHAR读取文件时,会发生编码校验错误。
  • 当使用DBE_OUTPUT.PUT_LINE打印DBE_FILE.READ_LINE_NCHAR接口得到的结果时,需要确保UTF-8字符集编码能够转换成当前数据库字符集编码,满足上述条件后可以正常输出结果。DBE_OUTPUT.PRINT_LINE不支持该功能。
  • DBE_FILE要求客户端字符集编码与数据库字符集编码保持一致。
  • 当数据库字符集编码为ASCII编码、客户端字符集编码为支持中文的编码,在客户端调用DBE_FILE.WRITE_NCHAR或DBE_FILE.WRITE_LINE_NCHAR写入中文相关内容时,无法保证写入的内容为UTF-8编码格式。可能会导致后续使用DBE_FILE.READ_LINE_NCHAR时报错。

数据类型介绍

  • DBE_FILE.FILE_TYPE

    DBE_FILE.FILE_TYPE类型定义了DBE_FILE包中文件的表示方式,DBE_FILE.FILE_TYPE中的字段是DBE_FILE包的私有字段,请不要直接修改DBE_FILE.FILE_TYPE类型对象中字段的值。

    1
    2
    3
    4
    5
    CREATE TYPE DBE_FILE.FILE_TYPE AS(
        id INTEGER,
        datatype INTEGER,
        byte_mode BOOLEAN
    );
    
    表1 DBE_FILE.FILE_TYPE字段说明

    参数

    描述

    id

    文件句柄。

    datatype

    表明文件是CHAR文件还是NCHAR文件或者二进制文件,目前支持CHAR文件和NCHAR文件。CHAR文件返回1,NCHAR文件返回2。

    byte_mode

    表明文件是以二进制模式打开(TRUE)还是以文本模式打开(FALSE)。

接口介绍

高级功能包DBE_FILE支持的所有接口请参见表2

表2 DBE_FILE

接口名称

描述

DBE_FILE.OPEN/DBE_FILE.F...

根据指定的目录和文件名打开一个文件。

DBE_FILE.IS_CLOSE

检测一个文件是否关闭。

DBE_FILE.IS_OPEN

检测一个文件是否打开。

DBE_FILE.READ_LINE

从一个打开的文件中读取一行指定长度的数据。

DBE_FILE.WRITE

将数据写入到一个打开的文件。

DBE_FILE.NEW_LINE

将一个或者多个行终结符写入到一个打开的文件。

DBE_FILE.WRITE_LINE

将数据写入到一个打开的文件,并自动追加一个行终结符。

DBE_FILE.FORMAT_WRITE

将格式化数据写入到一个打开的文件,允许格式化的DBE_FILE.WRITE接口。

DBE_FILE.GET_RAW

从一个打开的文件中读取RAW类型数据。

DBE_FILE.PUT_RAW

将RAW类型数据写入到一个打开的文件。

DBE_FILE.FLUSH

将缓存的数据写入到物理文件中。

DBE_FILE.CLOSE

关闭一个打开的文件。

DBE_FILE.CLOSE_ALL

关闭一个会话中打开的所有的文件。

DBE_FILE.REMOVE

删除一个磁盘文件,使用的时候需要有充分的权限。

DBE_FILE.RENAME

重命名一个磁盘文件,类似Unix的mv指令。

DBE_FILE.COPY

拷贝一个连续区域的内容到一个新创建的文件中,如果忽略了start_line和end_line会拷贝整个文件。

DBE_FILE.GET_ATTR

读取并返回一个磁盘文件的属性。

DBE_FILE.SEEK

根据用户指定的字节数向前或者向后调整文件指针的位置。

DBE_FILE.GET_POS

以字节为单位返回文件当前的偏移量。

DBE_FILE.FOPEN_NCHAR

根据指定的目录和文件名打开一个文件。

DBE_FILE.WRITE_NCHAR

将数据写入到一个打开的文件。

DBE_FILE.WRITE_LINE_NCHAR

将数据写入到一个打开的文件,并自动追加一个行终结符。

DBE_FILE.FORMAT_WRITE_NCHAR

将格式化数据写入到一个打开的文件,允许格式化的DBE_FILE.WRITE_NCHAR接口。

DBE_FILE.READ_LINE_NCHAR

从一个打开的文件中读取一行指定长度的数据。

  • DBE_FILE.OPEN/DBE_FILE.FOPEN

    函数DBE_FILE.OPEN用来打开一个文件,可以指定最大行的大小,一个会话内最多可以同时打开50个文件。该函数返回一个INTEGER类型的文件句柄。函数DBE_FILE.FOPEN功能和DBE_FILE.OPEN类似,返回一个DBE_FILE.FILE_TYPE类型的对象。

    DBE_FILE.OPEN函数原型为:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    DBE_FILE.OPEN(
        dir           IN TEXT,
        file_name     IN TEXT,
        open_mode     IN TEXT,
        max_line_size IN INTEGER DEFAULT 1024)
    RETURN INTEGER;
    
    DBE_FILE.FOPEN(
        dir           IN TEXT,
        file_name     IN TEXT,
        open_mode     IN TEXT,
        max_line_size IN INTEGER DEFAULT 1024)
    RETURN DBE_FILE.FILE_TYPE;
    
    表3 DBE_FILE.OPEN/DBE_FILE.FOPEN接口参数说明

    参数

    描述

    dir

    文件的目录位置,这个字符串是一个目录对象名。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包读写safe_data_path指定文件路径下的文件。

    file_name

    文件名,包含扩展(文件类型),不包括路径名。如果文件名中包含路径,在OPEN中会被忽略,在Unix系统中,文件名不能以/.结尾。

    open_mode

    指定文件的打开模式,包含r:read text,w: write text, a: append text, rb: read byte, wb: write byte和ab: append byte。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

    max_line_size

    每行最大字符数,包含换行符(最小值是1,最大值是32767)。如果没有指定,会指定一个默认值1024。

  • DBE_FILE.IS_CLOSE

    函数DBE_FILE.IS_CLOSE用于检测一个文件是否已经关闭,返回一个布尔值,异常情况是INVALID_FILEHANDLE。

    DBE_FILE.IS_CLOSE函数原型为:

    1
    2
    3
    4
    5
    6
    7
    DBE_FILE.IS_CLOSE(
        file IN INTEGER)
    RETURN BOOLEAN;
    
    DBE_FILE.IS_CLOSE(
        file IN DBE_FILE.FILE_TYPE)
    RETURN BOOLEAN;
    
    表4 DBE_FILE.IS_CLOSE接口参数说明

    参数

    描述

    file

    待检测的文件句柄或DBE_FILE.FILE_TYPE类型的对象。

  • DBE_FILE.IS_OPEN

    函数DBE_FILE.IS_OPEN用于检测一个文件是否已经打开,返回一个布尔值,异常情况是INVALID_FILEHANDLE。

    DBE_FILE.IS_OPEN函数原型为:

    1
    2
    3
    4
    5
    6
    7
    DBE_FILE.IS_OPEN(
        file IN INTEGER)
    RETURN BOOLEAN;
    
    DBE_FILE.IS_OPEN(
        file IN DBE_FILE.FILE_TYPE)
    RETURN BOOLEAN;
    
    表5 DBE_FILE.IS_OPEN接口参数说明

    参数

    描述

    file

    待检测的文件句柄或DBE_FILE.FILE_TYPE类型的对象。

  • DBE_FILE.READ_LINE

    存储过程DBE_FILE.READ_LINE从一个打开的文件读取数据,并把读取的结果存放到buffer中。读取的时候会读取到行尾,但不包含行终结符,或者读取到文件末尾,或者读取到len参数指定的大小。读取的长度不能超过OPEN的时候指定的max_line_size。

    DBE_FILE.READ_LINE存储过程原型为:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    DBE_FILE.READ_LINE(
        file   IN  INTEGER,
        buffer OUT TEXT,
        len    IN  INTEGER DEFAULT NULL);
    
    DBE_FILE.READ_LINE(
        file   IN  DBE_FILE.FILE_TYPE,
        buffer OUT TEXT,
        len    IN  INTEGER DEFAULT NULL);
    
    表6 DBE_FILE.READ_LINE接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象,文件必须以读模式打开,否则会抛出INVALID_OPERATION的异常。

    buffer

    接收数据的buffer。

    len

    从文件中读取的字节数,默认值为NULL。如果是NULL,会使用max_line_size来指定大小。

  • DBE_FILE.WRITE

    函数DBE_FILE.WRITE用于向文件中写入buffer中的数据,文件必须以写模式打开,这个操作不会写入行终结符,返回值永远为TRUE。

    DBE_FILE.WRITE函数原型为:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    DBE_FILE.WRITE(
        file   IN INTEGER,
        buffer IN TEXT)
    RETURN BOOLEAN;
    
    DBE_FILE.WRITE(
        file   IN DBE_FILE.FILE_TYPE,
        buffer IN TEXT)
    RETURN VOID;
    
    表7 DBE_FILE.WRITE接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象,要写入的文件必须以写模式打开,这个操作不会写入行终结符。

    buffer

    写入文件的文本数据。每行的累计写入长度不能大于或等于OPEN或FOPEN时指定或默认的max_line_size,否则会在刷新到文件时报错。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

  • DBE_FILE.NEW_LINE

    函数DBE_FILE.NEW_LINE用于向一个打开的文件中写入一个或者多个行终结符。行终结符和平台相关,返回值永远为TRUE。

    DBE_FILE.NEW_LINE函数原型为:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    DBE_FILE.NEW_LINE(
        file      IN INTEGER,
        line_nums IN INTEGER DEFAULT 1)
    RETURN BOOLEAN;
    
    DBE_FILE.NEW_LINE(
        file      IN DBE_FILE.FILE_TYPE,
        line_nums IN INTEGER DEFAULT 1)
    RETURN VOID;
    
    表8 DBE_FILE.NEW_LINE接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

    line_nums

    写入到文件中的行终结符的数量。

  • DBE_FILE.WRITE_LINE

    函数DBE_FILE.WRITE_LINE用于向文件中写入buffer中的数据,文件必须以写模式打开,这个操作会自动追加行终结符,返回值永远为TRUE。

    DBE_FILE.WRITE_LINE函数原型为:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    DBE_FILE.WRITE_LINE(
        file   IN INTEGER,
        buffer IN TEXT,
        flush  IN BOOLEAN DEFAULT FALSE)
    RETURN BOOLEAN;
    
    DBE_FILE.WRITE_LINE(
        file   IN DBE_FILE.FILE_TYPE,
        buffer IN TEXT,
        flush  IN BOOLEAN DEFAULT FALSE)
    RETURN VOID;
    
    表9 DBE_FILE.WRITE_LINE接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

    buffer

    要写入文件的文本数据,每行的长度(包含换行符)不能大于OPEN或FOPEN时指定或默认的max_line_size,否则会在刷新到文件时报错。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

    flush

    在WRITE_LINE后是否要刷到磁盘,默认值为FALSE。

  • DBE_FILE.FORMAT_WRITE

    函数DBE_FILE.FORMAT_WRITE将格式化数据写入到一个打开的文件,是允许格式化的DBE_FILE.WRITE接口,返回值永远为TRUE。

    DBE_FILE.FORMAT_WRITE函数原型为:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    DBE_FILE.FORMAT_WRITE(
        file   IN INTEGER,
        format IN TEXT,
        arg1   IN TEXT DEFAULT NULL,
        . . .
        arg6   IN TEXT DEFAULT NULL)
    RETURN BOOLEAN;
    
    DBE_FILE.FORMAT_WRITE(
        file   IN DBE_FILE.FILE_TYPE,
        format IN TEXT,
        arg1   IN TEXT DEFAULT NULL,
        . . .
        arg6   IN TEXT DEFAULT NULL)
    RETURN VOID;
    
    表10 DBE_FILE.FORMAT_WRITE接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

    format

    格式化的字符串,包含文本和格式符\n和%s。

    [arg1. . .arg6]

    从1到6个可选的参数串,参数和格式化字符的位置是一一对应的,如果存在格式化字符而没有提供参数,会使用空串来替代%s。

  • DBE_FILE.GET_RAW

    存储过程DBE_FILE.GET_RAW从一个打开的文件读取RAW类型数据,并把读取的结果存放到buffer中,从r中返回。

    DBE_FILE.GET_RAW存储过程原型为:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    DBE_FILE.GET_RAW(
        file   IN  INTEGER,
        r      OUT RAW,
        length IN  INTEGER DEFAULT NULL);
    
    DBE_FILE.GET_RAW(
        file   IN  DBE_FILE.FILE_TYPE,
        r      OUT RAW,
        length IN  INTEGER DEFAULT NULL);
    
    表11 DBE_FILE.GET_RAW接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

    r

    接收RAW类型数据的buffer。

    length

    从文件中读取的字节数,默认值为NULL,如果是NULL,会使用RAW类型最大长度来指定大小。

  • DBE_FILE.PUT_RAW

    函数DBE_FILE.PUT_RAW用于向文件中写入RAW类型数据,返回值永远为TRUE。

    DBE_FILE.PUT_RAW函数原型为:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    DBE_FILE.PUT_RAW (
        file  IN INTEGER,
        r     IN RAW,
        flush IN BOOLEAN DEFAULT FALSE)
    RETURN BOOLEAN;
    
    DBE_FILE.PUT_RAW (
        file  IN DBE_FILE.FILE_TYPE,
        r     IN RAW,
        flush IN BOOLEAN DEFAULT FALSE)
    RETURN VOID;
    
    表12 DBE_FILE.PUT_RAW接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

    r

    写入文件的RAW类型数据。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

    flush

    在PUT_RAW后是否要刷到磁盘,默认值为FALSE。

  • DBE_FILE.FLUSH

    函数DBE_FILE.FLUSH将缓存的数据写入到物理文件中,缓存中的数据必须要有一个行终结符。

    DBE_FILE.FLUSH函数原型为:
    1
    2
    3
    4
    5
    6
    7
    DBE_FILE.FLUSH(
        file IN INTEGER)
    RETURN VOID;
    
    DBE_FILE.FLUSH(
        file IN DBE_FILE.FILE_TYPE)
    RETURN VOID;
    
    表13 DBE_FILE.FLUSH接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

  • DBE_FILE.CLOSE

    函数DBE_FILE.CLOSE用于关闭一个打开的文件,当调用这个函数的时候,如果还有等待写入的缓存的数据,可能会收到异常信息,返回值永远为TRUE。

    DBE_FILE.CLOSE函数原型为:
    1
    2
    3
    4
    5
    6
    7
    DBE_FILE.CLOSE(
        file IN INTEGER)
    RETURN BOOLEAN;
    
    DBE_FILE.CLOSE(
        file IN DBE_FILE.FILE_TYPE)
    RETURN BOOLEAN;
    
    表14 DBE_FILE.CLOSE接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

  • DBE_FILE.CLOSE_ALL

    函数DBE_FILE.CLOSE_ALL关闭一个会话中打开的所有的文件,可用于紧急的清理操作。

    DBE_FILE.CLOSE_ALL函数原型为:

    1
    2
    DBE_FILE.CLOSE_ALL()
    RETRUN VOID;
    
    表15 DBE_FILE.CLOSE_ALL接口参数说明

    参数

    描述

  • DBE_FILE.REMOVE

    函数DBE_FILE.REMOVE删除一个磁盘文件,使用的时候需要有充分的权限。

    DBE_FILE.REMOVE函数原型为:
    1
    2
    3
    4
    DBE_FILE.REMOVE(
        dir       IN TEXT,
        file_name IN TEXT)
    RETURN VOID;
    
    表16 DBE_FILE.REMOVE接口参数说明

    参数

    描述

    dir

    文件的目录位置,这个字符串是一个目录对象名。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包操作safe_data_path指定文件路径下的文件。

    file_name

    文件名。

  • DBE_FILE.RENAME

    函数DBE_FILE.RENAME重命名一个磁盘文件,类似Unix的mv指令。

    DBE_FILE.RENAME函数原型为:
    1
    2
    3
    4
    5
    6
    7
    DBE_FILE.RENAME(
        src_dir        IN TEXT,
        src_file_name  IN TEXT,
        dest_dir       IN TEXT,
        dest_file_name IN TEXT,
        overwrite      IN BOOLEAN DEFAULT FALSE)
    RETURN VOID;
    
    表17 DBE_FILE.RENAME接口参数说明

    参数

    描述

    src_dir

    原文件的目录位置(大小写敏感)。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包操作safe_data_path指定文件路径下的文件。

    src_file_name

    要进行命名的原文件。

    dest_dir

    目的目录位置(大小写敏感)。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包操作safe_data_path指定文件路径下的文件。

    dest_file_name

    新的文件名。

    overwrite

    是否重写,默认值为FALSE,如果目的目录下存在一个同名的文件,不会进行重写。

  • DBE_FILE.COPY

    函数DBE_FILE.COPY拷贝一个连续区域的内容到一个新创建的文件中,如果忽略了start_line和end_line会拷贝整个文件。

    DBE_FILE.COPY函数原型为:
    1
    2
    3
    4
    5
    6
    7
    8
    DBE_FILE.COPY(
        src_dir        IN TEXT,
        src_file_name  IN TEXT,
        dest_dir       IN TEXT,
        dest_file_name IN TEXT,
        start_line     IN INTEGER DEFAULT 1,
        end_line       IN INTEGER DEFAULT NULL)
    RETURN VOID;
    
    表18 DBE_FILE.COPY接口参数说明

    参数

    描述

    src_dir

    原文件所在的目录。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包操作safe_data_path指定文件路径下的文件。

    src_file_name

    原文件。

    dest_dir

    目的文件所在的目录。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包操作safe_data_path指定文件路径下的文件。

    dest_file_name

    目的文件。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

    start_line

    拷贝开始的行号,默认为1。

    end_line

    拷贝结束的行号,默认为NULL,如果是NULL,则指定到文件尾。

  • DBE_FILE.GET_ATTR

    存储过程DBE_FILE.GET_ATTR读取并返回一个磁盘文件的属性。

    DBE_FILE.GET_ATTR存储过程原型为:
    1
    2
    3
    4
    5
    6
    DBE_FILE.GET_ATTR(
        location    IN  TEXT,
        filename    IN  TEXT,
        fexists     OUT BOOLEAN,
        file_length OUT BIGINT,
        block_size  OUT INTEGER);
    
    表19 DBE_FILE.GET_ATTR接口参数说明

    参数

    描述

    location

    文件所在的目录。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包操作safe_data_path指定文件路径下的文件。

    filename

    文件名。

    fexists

    返回文件是否存在。

    file_length

    返回文件的字节长度,如果文件不存在返回NULL。

    block_size

    返回文件系统的块大小(单位字节),如果文件不存在返回NULL。

  • DBE_FILE.SEEK

    函数DBE_FILE.SEEK根据用户指定的字节数向前或者向后调整文件指针的位置。

    DBE_FILE.SEEK函数原型为:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    DBE_FILE.SEEK(
        file           IN INTEGER,
        absolute_start IN BIGINT DEFAULT NULL,
        relative_start IN BIGINT DEFAULT NULL)
    RETURN VOID;
    
    DBE_FILE.SEEK(
        file           IN DBE_FILE.FILE_TYPE,
        absolute_start IN BIGINT DEFAULT NULL,
        relative_start IN BIGINT DEFAULT NULL)
    RETURN VOID;
    
    表20 DBE_FILE.SEEK接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

    absolute_start

    文件偏移的绝对位置,默认值为NULL。

    relative_start

    文件偏移的相对位置。如果值是正数,向前偏移;如果是负数,向后偏移;默认值为NULL。如果和absolute_start参数同时指定,以absolute_start参数为准。

  • DBE_FILE.GET_POS

    函数DBE_FILE.GET_POS以字节为单位返回文件当前的偏移量。

    DBE_FILE.FGETPOS函数原型为:
    1
    2
    3
    4
    5
    6
    7
    DBE_FILE.GET_POS(
        file IN INTEGER)
    RETURN BIGINT;
    
    DBE_FILE.GET_POS(
        file IN DBE_FILE.FILE_TYPE)
    RETURN BIGINT;
    
    表21 DBE_FILE.GET_POS接口参数说明

    参数

    描述

    file

    通过OPEN打开的文件句柄或者FOPEN打开的DBE_FILE.FILE_TYPE类型的对象。

  • DBE_FILE.FOPEN_NCHAR

    函数DBE_FILE.FOPEN_NCHAR用来打开一个文件,可以指定最大行的大小,一个会话内最多可以同时打开50个文件。该函数返回一个DBE_FILE.FILE_TYPE类型的文件句柄。该函数以国家字符集模式打开文件以进行输入或输出。

    DBE_FILE.FOPEN_NCHAR函数原型为:
    1
    2
    3
    4
    5
    6
    DBE_FILE.FOPEN_NCHAR(
        dir           IN TEXT,
        file_name     IN TEXT,
        open_mode     IN TEXT,
        max_line_size IN INTEGER DEFAULT 1024)
    RETURN DBE_FILE.FILE_TYPE;
    
    表22 DBE_FILE.FOPEN_NCHAR接口参数说明

    参数

    描述

    dir

    文件的目录位置,这个字符串是一个目录对象名。

    说明:
    • 文件目录的位置,需要添加到系统表PG_DIRECTORY中,如果传入的路径和PG_DIRECTORY中的路径不匹配,会报路径不存在的错误。
    • 在打开guc参数safe_data_path时,用户只能通过高级包读写safe_data_path指定文件路径下的文件。

    file_name

    文件名,包含扩展(文件类型),不包括路径名。如果文件名中包含路径,在FOPEN_NCHAR中会被忽略,在Unix系统中,文件名不能以/.结尾。

    open_mode

    指定文件的打开模式,包含r:read text,w: write text, a: append text, rb: read byte, wb: write byte和ab: append byte。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

    max_line_size

    每行最大字符数,包含换行符(最小值是1,最大值是32767)。如果没有指定,会指定一个默认值1024。

  • DBE_FILE.WRITE_NCHAR

    函数DBE_FILE.WRITE_NCHAR用于向文件中写入buffer中的数据,文件必须以国家字符集模式和写模式打开,这个操作不会写入行终结符,返回值永远为TRUE。文本字符串将以UTF8字符集格式写入。

    DBE_FILE.WRITE_NCHAR函数原型为:
    1
    2
    3
    4
    DBE_FILE.WRITE_NCHAR(
        file   IN DBE_FILE.FILE_TYPE,
        buffer IN NVARCHAR2)
    RETURN VOID;
    
    表23 DBE_FILE.WRITE接口参数说明

    参数

    描述

    file

    通过FOPEN_NCHAR打开的DBE_FILE.FILE_TYPE类型的对象,要写入的文件必须以写模式打开,这个操作不会写入行终结符。

    buffer

    写入文件的文本数据。每行的累计写入长度不能大于或等于FOPEN_NCHAR时指定或默认的max_line_size,否则会在刷新到文件时报错。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

  • DBE_FILE.WRITE_LINE_NCHAR

    函数DBE_FILE.WRITE_LINE_NCHAR用于向文件中写入buffer中的数据,文件必须以国家字符集模式和写模式打开,这个操作会自动追加行终结符,返回值永远为TRUE。文本字符串将以UTF8字符集格式写入。

    DBE_FILE.WRITE_LINE_NCHAR函数原型为:
    1
    2
    3
    4
    DBE_FILE.WRITE_LINE_NCHAR(
        file   IN DBE_FILE.FILE_TYPE,
        buffer IN NVARCHAR2)
    RETURN VOID;
    
    表24 DBE_FILE.WRITE_LINE接口参数说明

    参数

    描述

    file

    通过FOPEN_NCHAR打开的DBE_FILE.FILE_TYPE类型的对象。

    buffer

    要写入文件的文本数据,每行的长度(包含换行符)不能大于FOPEN_NCHAR时指定或默认的max_line_size,否则会在刷新到文件时报错。

    说明:

    对于写操作,会检测写入文件类型,如果为elf类型文件,会报错退出。

  • DBE_FILE.FORMAT_WRITE_NCHAR

    函数DBE_FILE.FORMAT_WRITE_NCHAR将格式化数据写入到一个打开的文件,是允许格式化的DBE_FILE.WRITE_NCHAR接口,返回值永远为TRUE。

    DBE_FILE.FORMAT_WRITE_NCHAR函数原型为:
    1
    2
    3
    4
    5
    6
    7
    DBE_FILE.FORMAT_WRITE_NCHAR(
        file   IN DBE_FILE.FILE_TYPE,
        format IN NVARCHAR2,
        arg1   IN NVARCHAR2 DEFAULT NULL,
        . . .
        arg5   IN NVARCHAR2 DEFAULT NULL)
    RETURN VOID;
    
    表25 DBE_FILE.FORMAT_WRITE_NCHAR接口参数说明

    参数

    描述

    file

    通过FOPEN_NCHAR打开的DBE_FILE.FILE_TYPE类型的对象。

    format

    格式化的字符串,包含文本和格式符\n和%s。

    [arg1. . .arg5]

    从1到5个可选的参数串,参数和格式化字符的位置是一一对应的,如果存在格式化字符而没有提供参数,会使用空串来替代%s。

  • DBE_FILE.READ_LINE_NCHAR

    存储过程DBE_FILE.READ_LINE_NCHAR从一个打开的文件读取数据,并把读取的结果存放到buffer中。读取的时候会读取到行尾,但不包含行终结符,或者读取到文件末尾,或者读取到len参数指定的大小。读取的长度不能超过FOPEN_NCHAR的时候指定的max_line_size。

    DBE_FILE.READ_LINE_NCHAR存储过程原型为:
    1
    2
    3
    4
    DBE_FILE.READ_LINE_NCHAR(
        file   IN  DBE_FILE.FILE_TYPE,
        buffer OUT NVARCHAR2,
        len    IN  INTEGER DEFAULT NULL);
    
    表26 DBE_FILE.READ_LINE接口参数说明

    参数

    描述

    file

    通过FOPEN_NCHAR打开的DBE_FILE.FILE_TYPE类型的对象,文件必须以读模式打开,否则会抛出INVALID_OPERATION的异常。

    buffer

    接收数据的buffer。

    len

    从文件中读取的字节数,默认值为NULL。如果是NULL,会使用max_line_size来指定大小。

示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
--系统管理员向PG_DIRECTORY系统表中加入目录/temp/:
CREATE OR REPLACE DIRECTORY dir AS '/tmp/';
--打开一个文件并向文件中写入数据

DECLARE
f DBE_FILE.FILE_TYPE;
buffer VARCHAR2;
BEGIN
-- 写文件
f := DBE_FILE.FOPEN('dir', 'sample.txt', 'w');
DBE_FILE.WRITE(f, 'A');
DBE_FILE.WRITE(f, 'B');
DBE_FILE.WRITE(f, 'C');
DBE_FILE.NEW_LINE(f);
DBE_FILE.WRITE_LINE(f, 'ABC');
DBE_FILE.FORMAT_WRITE(f, '[1 -> %s, 2 -> %s]\n', 'GaussDB', 'DBE_FILE');
DBE_FILE.CLOSE(f);
-- 读文件
f := DBE_FILE.FOPEN('dir', 'sample.txt', 'r');
DBE_FILE.READ_LINE(f, buffer); -- ABC
DBE_FILE.READ_LINE(f, buffer); -- ABC
DBE_FILE.READ_LINE(f, buffer); -- [1 -> GaussDB, 2 -> DBE_FILE]
DBE_OUTPUT.PRINT_LINE(buffer); 
DBE_FILE.CLOSE(f);
END;
/

-- 对文件句柄执行位置偏移,并获取文件的当前位置
DECLARE
f DBE_FILE.FILE_TYPE;
buffer VARCHAR2;
pos BIGINT;
BEGIN
-- 读文件
f := DBE_FILE.FOPEN('dir', 'sample.txt', 'r');
DBE_FILE.SEEK(f, 8);
DBE_FILE.READ_LINE(f, buffer); -- [1 -> GaussDB, 2 -> DBE_FILE]
DBE_OUTPUT.PRINT_LINE(buffer);
pos := DBE_FILE.GET_POS(f); -- 38
DBE_OUTPUT.PRINT_LINE(pos); 
DBE_FILE.CLOSE(f);
END;
/
-- NCHAR读写相关接口用例
DECLARE
f DBE_FILE.FILE_TYPE;
buffer NVARCHAR2;
BEGIN
-- 写文件
f := DBE_FILE.FOPEN_NCHAR('dir', 'sample02.txt', 'w');
DBE_FILE.WRITE_NCHAR(f, 'A');
DBE_FILE.WRITE_NCHAR(f, 'B');
DBE_FILE.WRITE_NCHAR(f, 'C');
DBE_FILE.NEW_LINE(f);
DBE_FILE.WRITE_LINE_NCHAR(f, 'ABC');
DBE_FILE.FORMAT_WRITE_NCHAR(f, '[1 -> %s, 2 -> %s]\n', 'GaussDB', 'DBE_FILE');
DBE_FILE.CLOSE(f);
-- 读文件
f := DBE_FILE.FOPEN_NCHAR('dir', 'sample02.txt', 'r');
DBE_FILE.READ_LINE_NCHAR(f, buffer); -- ABC
DBE_FILE.READ_LINE_NCHAR(f, buffer); -- ABC
DBE_FILE.READ_LINE_NCHAR(f, buffer); -- [1 -> GaussDB, 2 -> DBE_FILE]
DBE_OUTPUT.PRINT_LINE(buffer); 
DBE_FILE.CLOSE(f);
END;
/

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容