Skip to content

Commit b6f9fda

Browse files
AUTO: Docs repo sync - ScalarDB (#1593)
* AUTO: Sync ScalarDB docs in English to docs site repo * Add Data Loader doc --------- Co-authored-by: josh-wong <[email protected]> Co-authored-by: Josh Wong <[email protected]>
1 parent 6934253 commit b6f9fda

File tree

7 files changed

+694
-35
lines changed

7 files changed

+694
-35
lines changed

docs/data-loader.mdx

Lines changed: 641 additions & 0 deletions
Large diffs are not rendered by default.

docs/scalardb-data-loader/getting-started-export.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,37 @@ displayed_sidebar: docsEnglish
88

99
# Getting started with Export
1010

11-
This document explains how you can get started with the ScalarDB Data Loader Export function.
11+
This document explains how you can get started with ScalarDB Data Loader Export function.
1212

1313
## Features
1414

15-
The ScalarDB Data Loader allows you to export data in the following formats:
15+
ScalarDB Data Loader allows you to export data in the following formats:
1616

1717
- JSON
18-
- JSONLines
18+
- JSON Lines
1919
- CSV
2020

21-
Each export will run a ScalarDB scan operation based on the provided CLI arguments when running data loader.
21+
Each export will run a ScalarDB scan operation based on the provided CLI arguments when running Data Loader.
2222

2323
## Usage
2424

25-
The data loader export function can be started with the following minimal configuration:
25+
Data Loader export function can be started with the following minimal configuration:
2626

2727
```console
2828
./scalardb-data-loader export --config scalardb.properties --namespace namespace --table tableName
2929
```
3030

3131

3232

33-
- --config: the path to the scalardb connection properties file
33+
- --config: the path to the ScalarDB connection properties file
3434
- --namespace: the namespace of the table that contains the data
3535
- --table: name of the table that contains the data
3636

37-
By default, the data loader will create the output file in the working directory if the `--output-file` argument is omitted as well.
37+
By default, Data Loader will create the output file in the working directory if the `--output-file` argument is omitted as well.
3838

3939
### Command-line flags
4040

41-
Here is a list of flags (options) that can be used with the scalardb data loader.
41+
Here is a list of flags (options) that can be used with ScalarDB Data Loader.
4242

4343
| Flag | Description | Usage |
4444
| ----------------- | ------------------------------------------------------------ | ------------------------------------------------------ |
@@ -52,11 +52,11 @@ Here is a list of flags (options) that can be used with the scalardb data loader
5252
| --start-exclusive | Is the scan start exclusive or not. If omitted, the default value is `false`. This flag is only applicable to `--key` | `scalardb-data-loader --start-exclusive` |
5353
| --end | Clustering key to mark scan end. This flag is only applicable to `--key`. | `scalardb-data-loader --end columnName=value` |
5454
| --end-exclusive | Is the scan start exclusive or not. If omitted, the default value is `false`. This flag is only applicable to `--key` | `scalardb-data-loader --end-exclusive` |
55-
| --limit | Limit the results of the scan. If omitted, the default value is `0` which means their is no limit. | `scalardb-data-loader --limit 1000` |
55+
| --limit | Limit the results of the scan. If omitted, the default value is `0` which means there is no limit. | `scalardb-data-loader --limit 1000` |
5656
| --output-file | The name and path of the output file. If omitted, the tool will save the file in the current folder with the following name format:<br />`export_namespace.tableName_timestamp.json` or `export_namespace.tableName_timestamp.csv`<br /><br />The ouput folder needs to exists. The dataloader does not create the output folder for you. | `scalardb-data-loader --output-file ./out/output.json` |
5757
| --format | The output format. By default `json` is selected. | `scalardb-data-loader --format json` |
5858
| --metadata | When set to true the transaction metadata is included in the export. By default this is set to `false` | `scalardb-data-loader --metadata` |
5959
| --delimiter | The delimiter used in CSV files. Default value is `;` | `scalardb-data-loader --delimiter ;` |
6060
| --no-headers | Exclude header row in CSV file. Default is `false` | `scalardb-data-loader --no-headers` |
61-
| --threads | Thread count for concurrent processing | `scalardb-data-loader --threads 500` |
61+
| --threads | Thread count for concurrent processing. The default value is the number of available processors. | `scalardb-data-loader --threads 500` |
6262

0 commit comments

Comments
 (0)