Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise README for tgdump project. #36

Merged
merged 1 commit into from
Dec 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Available Tools

* [tgsql](./modules/tgsql/cli) - Text based SQL client program.
* [tgdump](./modules/tgdump/cli) - Table Dump Tool.
* [tgdump](./modules/tgdump) - Table Dump Tool.

## Requirements

Expand Down
28 changes: 27 additions & 1 deletion modules/tgdump/cli/README.md → modules/tgdump/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,33 @@

Tsurugi Table Dump Tool extracts the contents of table data and saves them on files.

## command specification
## Build and Install

Execute the below command in this directory (`/modules/tgdump`):

```sh
../../gradlew assemble
```

This will create the following distribution archives:

* `cli/build/distributions/tgdump-<version>.zip`
* `cli/build/distributions/tgdump-<version>.tar.gz`
* `cli/build/distributions/tgdump-<version>-shadow.zip`
* `cli/build/distributions/tgdump-<version>-shadow.tar.gz`

Each of the archives above contains the following contents:

* `tgdump-<version>(-shadow)/bin/tgdump`
* A script for executing the command
* Additionally, `tgdump.bat` is included for Windows users
* `tgdump-<version>(-shadow)/lib/*.jar`
* Java libraries used by the command
* For the -shadow archives, the above is packaged into a single "Uber JAR" file

Deploy the files mentioned above, and the tgdump command will be available for use.

## Command specification

```sh
tgdump <table-name> [<table-name> [...]] --to </path/to/destination-dir> --connection <endpoint-uri> ...
Expand Down