cli-kintone(v1.x.x)与旧版本(v.0.x.x)的差异

aki发表于:2023年07月28日 10:32:13更新于:2023年12月11日 12:10:50

v1.0.0及之后版本的cli-kintone,强化了同时添加和更新记录数据的功能,并可支持SecureAccess。
关于与v1.0.0(v0.x.x)之前的cli-kintone 的主要差异,请参照后述表格。

版本的查看方法

执行以下命令确认cli-kintone版本。

// Windows环境
cli-kintone.exe --version

# 显示版本号
1.0.0

如果执行命令时出现以下错误,则表示所使用的是v0.10.0之前的cli-kintone。

> segmentation fault cli-kintone.exe --version

主要差异

导出

截至2022年10月24日,导出功能的主要差异如下:

 旧版本(v0.x.x)v1.x.x及更高版本
输出内容的格式

可以指定的值如下,可指定以下选项
         -o:可指定的值如下

  • csv:CSV格式

  • json:JSON格式

仅限CSV文件
kintone环境的指定方法

指定以下选项
         -d: kintone子域名或FQDN

指定以下选项
         --base-url: kintone的URL(以“https://”开头)

应用的指定方法

指定以下选项
         -a: kintone的应用ID

指定以下选项
         --app: kintone的应用ID

密码身份验证

指定以下选项
         -u: kintone的登录名
         -p: kintone的密码

指定以下选项
         --username:kintone的登录名
         --password: kintone的密码

API令牌身份验证

指定以下选项
         -t:API令牌

指定以下选项
         --api-token:API令牌

Basic身份验证

指定以下选项
         -U:Basic身份验证的用户名
         -P:Basic身份验证的密码

指定以下选项
         --basic-auth-username:Basic身份验证的用户名
         --basic-auth-password:Basic身份验证的密码

SecureAccess 

指定以下选项
         --pfx-file-path:客户证书文件路径
         --pfx-file-password:客户证书文件密码

通过代理执行导出 

指定以下选项
         --proxy:代理服务器URL

来宾空间内的应用

指定以下选项
         -g:来宾空间ID

指定以下选项
         --guest-space-id:来宾空间ID

导出带有附件的记录指定以下选项
       -b:用于存放输出附件的文件夹的路径
指定以下选项
       --attachments-dir:用于存放输出附件的文件夹的路径
指定要导出的字段

指定以下选项
         -c:要导出字段的字段代码

同一字段多次指定时,会根据指定的次数导出相应数量的列

指定以下选项
         --fields:要导出字段的字段代码

同一字段多次指定时,只会导出一列

要导出的记录的筛选方法

指定以下选项
         -q:记录的筛选条件和排序

指定以下选项
         --condition:记录的筛选条件
         --order-by:记录的排序

导出数据的文字编码

指定以下选项
         -e:可指定的值如下

  • utf8:UTF-8

  • utf-16:UTF-16

  • utf-16be-with-signature:UTF-16BE

  • utf-16le-with-signature:UTF-16LE

  • sjis:Shift-JIS

  • euc-jp:EUC-JP

  • gbk:GBK(简体中文)

指定以下选项
         --encoding:可指定的值如下

  • utf8:UTF-8

  • sjis:Shift-JIS

导入

截至2023年2月22日,导入的主要差异如下。

 旧版本(v0.x.x)v1.x.x及更高版本
指定要导入的文件

指定以下选项
         -f:CSV文件的文件路径

指定以下选项
       --file-path:CSV文件的文件路径
kintone环境的指定方法

指定以下选项
         -d: kintone子域名或FQDN

指定以下选项
         --base-url: kintone的URL(以“https://”开头)

应用的指定方法

指定以下选项
         -a: kintone的应用ID

指定以下选项
         --app: kintone的应用ID

密码身份验证

指定以下选项
         -u: kintone的登录名
         -p: kintone的密码

指定以下选项
         --username:kintone的登录名
         --password: kintone的密码

API令牌身份验证

指定以下选项
         -t:API令牌

指定以下选项
         --api-token:API令牌

Basic身份验证

指定以下选项
         -U:Basic身份验证的用户名
         -P:Basic身份验证的密码

指定以下选项
         --basic-auth-username:Basic身份验证的用户名
         --basic-auth-password:Basic身份验证的密码

SecureAccess 

指定以下选项
         --pfx-file-path:客户证书文件路径
         --pfx-file-password:客户证书文件密码

通过代理执行导入

指定以下选项
         --proxy:代理服务器URL

来宾空间内的应用

指定以下选项
         -g:来宾空间ID

指定以下选项
         --guest-space-id:来宾空间ID

批量添加记录导入不包含$id列的CSV文件不指定-update-key导入CSV文件
记录数据的批量更新

导入包含更新key列的CSV文件,可批量记录更新
         作为记录更新key的字段,可以指定以下其一

  • $id 列

  • 开头带有 * 的字段代码的列

根据作为批量更新key的字段的值,批量更新或添加记录

  • 如需添加新的记录
               输入一个空白字符

  • 如需更新现有记录时
               输入与现有记录相匹配的值

指定以下选项,导入CSV文件

--update-key:要作为批量更新key的字段代码

根据-update-key中指定的列的值,添加或更新记录

  • 如需添加新的记录
               输入与现有记录不重复的值或空格字符

  • 如需更新现有记录时
               输入与现有记录相匹配的值

-update-key可指定的字段类型如下

  • 记录编号

  • 勾选了 "值为唯一 "的下列字段

    • 单行文本框

    • 数值

删除记录后,再执行批量添加

-D 指定选项
         如指定了此选项,则在删除记录数据后执行导入

如需筛选要删除的记录,通过-q选项指定筛选记录的条件

执行 delete 命令删除记录后,

用 import 命令导入数据

如要通过 delete 命令来删除特定的记录,可在 CSV 文件中写好要删除的记录,然后通过 --file-path 选项来指定该 CSV 文件

如果不通过 --file-path 选项来指定 CSV 文件,则删除所有记录

导入含有附件的记录数据

指定以下选项
         -b:存放附件的文件夹的路径

指定以下选项
         --attachments-dir:存放附件的文件夹的路径

指定要导入的字段 

指定以下选项
         --fields:要导入的字段代码

指定导入起始行

指定以下选项
         -l:导入的起始行

 
导入数据的文字编码

指定以下选项
         -e:可指定的值如下

  • utf8:UTF-8

  • utf-16:UTF-16

  • utf-16be-with-signature:UTF-16BE

  • utf-16le-with-signature:UTF-16LE

  • sjis:Shift-JIS

  • euc-jp:EUC-JP

  • gbk:GBK(简体中文)

指定以下选项
         --encoding:可指定的值如下

  • utf8:UTF-8

  • sjis:Shift-JIS