Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 2.3 KB

README.md

File metadata and controls

78 lines (61 loc) · 2.3 KB

tgdump - Tsurugi Table Dump Tool

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

Build and Install

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

../../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

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

parameters:

  • <table-name> - the dump target table names
  • --to - the destination directory
  • --connection - the target Tsurugi endpoint URI (must be ipc: protocol)

optional parameters:

  • --profile
    • dump profile name / file path
    • available profile name:
      • default - dump without any special settings
    • default: default
  • --connection-label (doesn't work)
    • the session label
    • default: no session labels
  • --connection-timeout
    • the timeout duration (in milliseconds) until the connection was established
    • default: disable timeout
  • --transaction
    • transaction type of dump operations
    • available transaction types:
      • OCC (or short)
      • LTX (or long)
      • RTX (or read, readonly, read-only)
    • default: RTX
  • --transaction-label
    • the transaction label
    • default: no transaction labels
  • --threads
    • the number of client threads in dump operations
      • The number of simultaneous processing tables is limited to the number of this threads.
    • default: 1
  • -v,--verbose
    • print verbose messages during executions.

special parameters:

  • -h,--help
    • print the help messages and then exit.
  • --version
    • print the version information and then exit.