文件操作 FILE 语句

FILE 语句是一个名词语句，用于文件操作，实现文件新建、删除和列表等操作。

FILE 语句通过路径path来定位文件，必须使用完整的路径。

获取文件的详细信息

无其他关键词的 FILE 语句用于获取文件的详细信息，返回值是一个数据行。如果文件不存在，返回格式为：

如果文件存在，返回格式为：

可使用集合对象的访问规则，如PRINT $file.size;将打印2.41K。
文件夹的扩展名是。

新建和删除文件

新建文件返回布尔值。文件不存在且有写权限可创建成功，否则失败。只能创建文件文件。
删除文件操作也返回布尔值。如果文件存在且未被其他程序占用，即删除成功，返回true; 删除失败返回false。

文件重全名、移动和复制

RENAME操作对文件进行重命名，如果源文件不存在或目标文件存在，则返回false，重命名失败。重命名可以指定另一个目录，实现与MOVE类似的操作，但不建议这么做。
MOVE操作可以将一个文件从一个目录移动到另一个目录，或者执行重命名操作。TO可以指定一个目录，或使用包含文件名的全路径。REPLACE EXISTING选项表示如果目录文件，则覆盖。返回布尔值。
COPY操作可以将一个文件从一个目录复制到另一个目录，TO可以指定一个目录，或者使用包含文件名的全路径，即可以在复制的同时重命名。REPLACE EXISTING选项表示如果目录文件，则覆盖。返回布尔值。

判断文件是否存在

文件是否存在的判断只能用于条件表达式中。

文件列表

接受一个文件夹路径，列表此文件下的所有文件（不包括文件夹），返回一个数据表，每个数据行都是一个文件的信息。一般在循环中使用。

获取文件大小

LENGTH返回字节长度，是一个整数，如2477。
SIZE返回易读的文件大小表示，是一个字符串，如2.41K。SIZE的逻辑等效于FILE LENGTH "path" -> TO CAPACITY。

文件读写操作

READ操作将整个文件内容读成一个字符串，文件不存在得抛出异常。
WRITE向文件中附加文本内容，附加的内容放在文件末尾。如果文件不存在则新建。
READ和WRITE适合一次性读取和一性次写入，还有就是读写不规则文件的场景。读取按行分隔的规则文本可以使用OPEN语句将文件读成数据表，写入规则数据可以用SAVE语句保存为文本文件。

在 PQL 中，FILE 语句 SQL 语句、PARSE 语句一样归为查询语句的范畴，每条语句都有返回值，所以 SQL 语句和 PARSE 语句的特性 FILE 语句均支持。比如用做赋值语句、在FOR循环中使用，使用Sharp表达式再编辑，当做查询表达式的一部分等。

按模板引擎解析

FILE VOYAGE 的作用是将使用 PQL 嵌入式规则编写的文件解析后生成新的文件，可以理解为原文件是一个模板，通过传递参数从而生成不同的内容，模板文件中支持所有的 PQL 。WITH关键词用于传递参数，可支持查询字符串或 Json 对象格式。TO关键词用于设置目标文件的绝对路径，当目标文件存在时会直接覆盖。

文件下载

这个操作需要Spring Boot环境支持，一般在 OneApi 中使用。这个功能会使Spring Boot抛出一个异常，但不影响正常使用。

参考链接