@kintone/data-loader

kintone-data-loader

A kintone record importer and exporter.

THIS IS EXPERIMENTAL, AND THESE FEATURES ARE NOT SUPPORTED YET.

• Export attachments of fields in table field
• Import attachemnts
• Update records when importing
• When using CSV format, the following fields are not supported
  • User selection, Group selection, Department selection

We plan to support them in the future release.

---

• Installation
• Usage
  • import
    • Options
  • export
    • Options
• Supported file formats
  • JSON format
  • CSV format
• LICENSE

Installation

$ npm install -g @kintone/data-loader

You can use also npx instead of installing @kintone/data-loader as global.

Usage

import

import command allows you to import record data into a specified kintone app.

$ kintone-data-loader \
import \
--base-url https://${yourDomain} \
--username ${yourLoginName} \
--password ${yourPassword} \
--app ${kintoneAppId} \
--file-path ${filepath}

Options

Some options use enviroment variables starting KINTONE_ as default values.

Options:
      --version              Show version number                       [boolean]
      --help                 Show help                                 [boolean]
      --base-url             Kintone Base Url
                                 [string] [required] [default: KINTONE_BASE_URL]
  -u, --username             Kintone Username
                                            [string] [default: KINTONE_USERNAME]
  -p, --password             Kintone Password
                                            [string] [default: KINTONE_PASSWORD]
      --api-token            App's API token[array] [default: KINTONE_API_TOKEN]
      --basic-auth-username  Kintone Basic Auth Username
                                 [string] [default: KINTONE_BASIC_AUTH_USERNAME]
      --basic-auth-password  Kintone Basic Auth Password
                                 [string] [default: KINTONE_BASIC_AUTH_PASSWORD]
      --app                  The ID of the app               [string] [required]
      --guest-space-id       The ID of guest space
                                      [string] [default: KINTONE_GUEST_SPACE_ID]
      --file-path            The path to source file. ".json" or ".csv"
                                                             [string] [required]
      --pfx-file-path        The path to client certificate file        [string]
      --pfx-file-password    The password of client certificate file    [string]

export

export command allows you to export record data from a specified kintone app.

$ kintone-data-loader \
export \
--base-url https://${yourDomain} \
--username ${yourLoginName} \
--password ${yourPassword} \
--app ${kintoneAppId} \
> ${filepath}

Options

Some options use enviroment variables starting KINTONE_ as default values.

Options:
      --version              Show version number                       [boolean]
      --help                 Show help                                 [boolean]
      --base-url             Kintone Base Url
                                 [string] [required] [default: KINTONE_BASE_URL]
  -u, --username             Kintone Username
                                            [string] [default: KINTONE_USERNAME]
  -p, --password             Kintone Password
                                            [string] [default: KINTONE_PASSWORD]
      --api-token            App's API token[array] [default: KINTONE_API_TOKEN]
      --basic-auth-username  Kintone Basic Auth Username
                                 [string] [default: KINTONE_BASIC_AUTH_USERNAME]
      --basic-auth-password  Kintone Basic Auth Password
                                 [string] [default: KINTONE_BASIC_AUTH_PASSWORD]
      --app                  The ID of the app               [string] [required]
      --guest-space-id       The ID of guest space
                                      [string] [default: KINTONE_GUEST_SPACE_ID]
      --attachment-dir       Attachment file directory                  [string]
      --format               Output format. "json" or "csv"
                                      [choices: "json", "csv"] [default: "json"]
  -c, --condition            The query string                           [string]
      --order-by             The sort order as a query                  [string]
      --pfx-file-path        The path to client certificate file        [string]
      --pfx-file-password    The password of client certificate file    [string]

Supported file formats

data-loader supports JSON and CSV for both import/export commands.
When import, it determines the format automatically by the extension of the file (specified by --file-path option).
When export, you can specify the format by specifying --format option.

The detailed formats of JSON / CSV files are as follows:

JSON format

The format of JSON file is the same as Get/Add/Update records REST API.

[
  {
    "FieldCode1": {
      "type": "SINGLE_LINE_TEXT",
      "value": "foo"
    },
    "Created_by": {
      "type": "CREATOR",
      "value": {
        "code": "Administrator",
        "name": "Administrator"
      }
    },
    ...
  },
  {
    ...
  },
  ...
]

CSV format

The first row (header row) lists the field codes of each field.
Each subsequent row corresponds to a record. Each value represents the value of the field.

"Record_number","FieldCode1","FieldCode2"
"1","foo","bar"
"2","baz","qux"

Here are considerations for some field types:

Text area

If the value contains line break, enclose the value in double quotes.

"TextAreaField"
"multi
line
text"

Check box, Multi-choice

Specify multiple values divided by line break.

"CheckboxField"
"value1
value2"

Created by, Updated by

Specify the user's login name (equivalent to value.code in REST API).

"Created_by"
"John"

LICENSE

• MIT