SAKOE

This markdown can be generated using the command: sakoe manual export-md.

This version has been generated on 19-08-26 at 18:50:36.

ABOUT

What is this tool

SAKOE is a collection of tools aimed to simplify your work in Openedge environments.

About this manual

The goal of this manual is to provide KEY concepts that are necessary to understand to use this tool to its fullest.

Each command is well documented on its own, don’t be afraid to use the --help option.

Command line usage

How to use this command line interface tool:

You can escape white spaces in argument/option values by using double quotes (i.e. “my value”).
If you need to use a double quote within a double quote, you can do so by double quoting the double quotes (i.e. “my ““special”” value”).
If an extra layer is needed, just double the doubling (i.e. -opt “-mysubopt ““my special “”"”value”””””””).
In the ‘USAGE’ help section, arguments between brackets (i.e. []) are optionals.

Response file parsing

Instead of using a long command line (which is limited in size on every platform), you can use a response file that contains each argument/option that should be used.

Everything that is usually separated by a space in the command line should be separated by a new line in the file. In response files, you do not have to double quote arguments containing spaces, they will be considered as a whole as long as they are on a separated line.

sakoe @responsefile.txt

Exit code

The convention followed by this tool is the following.

0 : used when a command completed successfully, without errors nor warnings.
1-8 : used when a command completed but with warnings, the level can be used to pinpoint different kinds of warnings.
9 : used when a command does not complete and ends up in error.

Website

The official page of this tool is: https://jcaillon.github.io/Oetools.Sakoe/.

You are invited to STAR the project on github to increase its visibility!

TABLE OF CONTENT

Commands overview
About the build command
cabinet
- add
- list
database
- admin
  - run
- analysis
  - advise
  - report
- backup
- before-image
  - truncate
- busy
- check
- connect
- copy
- create
- data
  - dump
  - dump-binary
  - dump-sequence
  - dump-sql
  - load
  - load-binary
  - load-bulk
  - load-sequence
  - load-sql
  - truncate
- datadigger
  - install
  - remove
  - run
- delete
- dictionary
  - run
- index
  - rebuild
- kill
- kill-all
- log
  - truncate
- project
- repair
- restore
- schema
  - dump
  - dump-custom
  - dump-inc
  - dump-inc-df
  - dump-sql
  - load
- start
- stop
- structure
  - add
  - generate
  - remove
  - update
  - validate
manual
progress
- exe-path
- generate-ds
- help
  - list
  - message
  - open
  - search
- read-ini
- read-pf
- version
- wsdl-doc
project
- build
- git-ignore
- init
- list
- project
  - create
- update
tool
- datadigger
  - install
  - remove
  - run
update
version

COMMANDS OVERVIEW

Full command line	Short description
sakoe cabinet	Cabinet files (.cab) creation and edition.
sakoe cabinet add	Add.
sakoe cabinet list	List only encrypted (or decrypted) files.
sakoe database	Database manipulation tools.
sakoe database admin	The openedge database administration tool.
sakoe database admin run	Run an instance of the database administration tool.
sakoe database analysis	Regroup commands related to database analysis.
sakoe database analysis advise	Generates an html report which provides pointers to common database configuration issues.
sakoe database analysis report	Displays an analysis report.
sakoe database backup	Backup a database into a single file for a future restore.
sakoe database before-image	Operate on database before-image file.
sakoe database before-image truncate	Truncate the before-image of a database.
sakoe database busy	Check the usage mode of a database (busy mode).
sakoe database check	Check if a database is alive.
sakoe database connect	Get the connection string to use to connect to a database.
sakoe database copy	Copy a database.
sakoe database create	Creates a new database.
sakoe database data	Operate on database data.
sakoe database data dump	Dump the database data in plain text files (.d).
sakoe database data dump-binary	Dump data in binary format from a database.
sakoe database data dump-sequence	Dump the database sequence data in a plain text file (.d).
sakoe database data dump-sql	Dump data in SQL-92 format from a database.
sakoe database data load	Load the database data from plain text files (.d).
sakoe database data load-binary	Load the database data from binary format files.
sakoe database data load-bulk	Load the database data from plain text files (.d).
sakoe database data load-sequence	Load the database sequence data from a plain text file (.d).
sakoe database data load-sql	Load the database data from SQL-92 format files (.dsql).
sakoe database data truncate	Deletes all the data of a given table.
sakoe database datadigger	DataDigger is a tool for exploring and modifying the data of a database.
sakoe database datadigger install	Install DataDigger in the default installation path.
sakoe database datadigger remove	Remove DataDigger from the installation path.
sakoe database datadigger run	Run a new DataDigger instance.
sakoe database delete	Delete a database.
sakoe database dictionary	The openedge database dictionary tool.
sakoe database dictionary run	Run an instance of the dictionary tool.
sakoe database index	Operate on database indexes.
sakoe database index rebuild	Rebuild the indexes of a database. By default, rebuilds all the active indexes.
sakoe database kill	Kill the broker/server processes running for a particular a database.
sakoe database kill-all	Kill all the broker/server processes running on this machine.
sakoe database log	Operate on database log files (.lg).
sakoe database log truncate	Truncates the log file.
sakoe database project	Operates on databases belonging to a project.
sakoe database repair	Repair/update the database control information file (.db).
sakoe database restore	Restore a database from a backup file.
sakoe database schema	Operate on database schema.
sakoe database schema dump	Dump the schema definition (.df) of a database.
sakoe database schema dump-custom	Dump the schema definition in a custom format.
sakoe database schema dump-inc	Dump an incremental schema definition (.df) by comparing 2 databases.
sakoe database schema dump-inc-df	Dump an incremental schema definition (.df) by comparing 2 .df files.
sakoe database schema dump-sql	Dump the SQL-92 schema of a database.
sakoe database schema load	Load a schema definition (.df) to a database.
sakoe database start	Start a database in order to use it in multi-users mode.
sakoe database stop	Stop a database that was started for multi-users.
sakoe database structure	Operate on a database structure file (.st).
sakoe database structure add	Append the extents from a structure file (.st) to a database.
sakoe database structure generate	Generate the structure file (.st) from a definition file (.df).
sakoe database structure remove	Remove storage areas or extents.
sakoe database structure update	Create or update a structure file (.st) from the database .db file.
sakoe database structure validate	Validate a structure file (.st) against a given database.
sakoe manual	The manual of this tool. Learn about the usage and key concepts of sakoe.
sakoe progress	Progress utilities commands.
sakoe progress exe-path	Returns the full path of the progress executable.
sakoe progress generate-ds	Generate a dataset definition from a xsd/xml file.
sakoe progress help	Access the Openedge help.
sakoe progress help list	List all the .chm files (windows help files) available in $DLC/prohelp.
sakoe progress help message	Display the extended error message using an error number.
sakoe progress help open	Open an help file (.chm) present in $DLC/prohelp.
sakoe progress help search	Search for a keyword in the language windows help file.
sakoe progress read-ini	Get the PROPATH value found in a .ini file.
sakoe progress read-pf	Get a single line argument string from a .pf file.
sakoe progress version	Get the version found for the Openedge installation.
sakoe progress wsdl-doc	Generate an html documentation from a wsdl.
sakoe project	Commands related to an Openedge project (.oe directory).
sakoe project build	Build automation for Openedge projects.
sakoe project git-ignore	Initialize a .gitignore file adapted for sakoe projects (or append to, if it exists).
sakoe project init	Initialize a new Openedge project file (.oeproj.xml).
sakoe project list	List all the project files or list the build configurations in a project file.
sakoe project project	Operates on databases belonging to a project.
sakoe project project create	TODO : repair database
sakoe project update	Update the `Project.xsd` file of the project with the latest version embedded in this tool.
sakoe tool	Manage external tools usable in sakoe.
sakoe tool datadigger	DataDigger is a tool for exploring and modifying the data of a database.
sakoe tool datadigger install	Install DataDigger in the default installation path.
sakoe tool datadigger remove	Remove DataDigger from the installation path.
sakoe tool datadigger run	Run a new DataDigger instance.
sakoe update	Update this tool with the latest release found on github.
sakoe version	Show the version information of this tool.

ABOUT THE BUILD COMMAND

Overview

With sakoe, you can ‘build’ your project. A build process is a succession of tasks that (typically) transform your source files into a deliverable format, usually called a release or package.

In sakoe, you describe a build process using a ‘build configuration’. A build configuration holds ‘properties’ of the build (for instance, the path to the openedge installation directory $DLC). It also holds the list of ‘tasks’ that will be executed successively during the build process.

To illustrate this, here is a possible build process:

Task 1: compile all your .p files to a procedures directory.
Task 2: compile all your .w files into a pro-library client.pl.
Task 3: zip the procedures and client.pl together into an archive file release.zip.

In order to store these build configurations, sakoe uses project files: .oeproj.xml. You can create them with the command: sakoe project init.

By default, a build is ‘incremental’. An incremental build is the opposite of a full build. In incremental mode, only the files that were added/modified/deleted since the previous build are taken into account. Unchanged files are simply not rebuilt.

The chapters below contain more details about a project, build configuration, properties and tasks.

Project

An Openedge project (typically, your project is your application, they are synonyms).

Some facts:

A project is composed of one or several build configurations.
A build configuration describe how to build your project.
To build your project, you need to specify which build configuration to use.

Below is a simplified representation of a project file: Project

Build configuration 1
- Child build configuration 2
  - Child build configuration 3
  - Child build configuration x…
- Child build configuration x…
Build configuration x…

There are no upper limit for build configuration nesting. The idea is that nested build configuration inherit properties from their parent, recursively (more details on the build configuration help).

Build configuration

A list of build configurations for this project.

Some facts:

A build configuration describe how to build your application.
A build configuration is essentially a succession of tasks (grouped into steps) that should be carried on in a sequential manner to build your application.
Each build configuration also has properties, which are used to customize the build.
Each build configuration can also have variables that make your build process dynamic. You can use variables anywhere in this xml. Their value can be changed dynamically without modifying this xml when running the build.

Below is a simplified representation of a build configuration: Build configuration

Variables
Properties
Build steps
- Step 1
  - Task 1
  - Task x…
- Step x…
List of children build configuration
Child build configuration 1
Child build configuration x…

Inheritance of build configurations (think of russian dolls):

Each build configuration can define “children” build configurations.
Each child inherits its parent properties following these rules:
For a given property, the most nested value is used (i.e. child value prioritized over parent value).
If the xml element is a list, the elements of the child (if any) will be added to the elements of the parent (if any). For instance, the steps list has this behavior. This means that the steps of a child will be added to the defined steps of its parents.

Practical example: Given the project below:

Project

Build configuration 1
- Properties Property1 (x)
  - Property2
- Steps
  - Step1 (x)
- Child build configuration 2
  - Properties
    - Property2 (x)
    - Property3 (x)
  - Steps
    - Step2 (x)

We decide to build ‘Child build configuration 2’:

Property1 of ‘Build configuration 1’ will be used.
Property2 and Property 3 of ‘Build configuration 2’ will be used.
Two steps will be executed: Step1 from ‘Build configuration 1’ and Step2 from ‘Build configuration 2’.

Build configuration variables

The variables of this build configurations.

Some facts:

Variables make your build process dynamic by allowing you to change build options without having to modify this xml.
You can use a variable with the syntax .
Variables will be replaced by their value at run time.
If the variable exists as an environment variable, its value will be taken in priority (this allows to overload values using environment variables).
Non existing variables will be replaced by an empty string.
Variables can be used in any “string type” value (this exclude numbers/booleans).
Variables can be used in the build configuration properties and also in the build tasks.
You can use variables in the variables definition, simply define them in the correct order.
If several variables with the same name exist, the value of the latest defined is used.
As this is a list of variables, child configuration will inherit variables from their parents but variable values defined in children prevail.
Variable names are case insensitive.

Special variables are already defined and available to use:

the application source directory (defined in properties).
the project directory (/.oe).
the project local directory (/.oe/local).
the dlc path used for the current build.
the build output directory (default to /.oe/bin).
the build configuration name for the current build.
the current directory.

Build configuration properties

The properties of this build configuration.

Some facts:

Properties can describe your application (for instance, the database needed to compile).
Properties can also describe options to build your application (for instance, if the compilation should also generate the xref files).
Properties are inherited from parent build configuration (if any).
For instance, this allows to define a DLC (v11) path for the project to use as default, and have a child configuration that overload this value using another DLC (v9) path.

Build steps

A list of steps to build your application.

Some facts:

Each step contains a list of tasks.
The sequential execution of these steps/tasks is called a build.
Steps (and tasks within them) are executed sequentially in the order they were defined.
A child configuration inherit the steps of its parent: they are executed before its own steps.

There are 3 kinds of steps:

‘BuildSource’ with tasks that will handle the files in your source directory (for instance, to compile procedures or copy configuration files).
‘BuildOutput’ with tasks that will handle the files in the build output directory (for instance, to create a .zip release of compiled files).
‘Free’ with tasks that will handle files outside of your source or output directory (for instance, to download dependencies before the compilation).

SAKOE CABINET

Synopsis

Cabinet files (.cab) creation and edition.

Usage

sakoe cabinet [options] [command]

Options

Short name	Long name	Description
-h	--help	Show this help text.

Commands

Short name	Long name	Description
ad	add	Add.
li	list	List only encrypted (or decrypted) files.

Argument	Description
<archive>	The path to the targeted archive(s). Several archives can be targeted, separate them with a semi-colon (i.e. ;).
<path>	A path pattern that indicates files that should be processed. Specify several paths by separating them with a semi-colon (i.e. ;).

Short name	Long name	Description
-d	--directory <path>	(Can be used multiple times) The relative target directory inside the archive. Defaults to blank which will put files in the archive root directory.
-f	--file <path>	(Can be used multiple times) The relative target file path inside the archive.
-e	--exclude <filter>	(Can be used multiple times) A path pattern that indicates paths that should be excluded from being processed. Can use wildcards (*,,?).
-er	--exclude-regex <filter>	(Can be used multiple times) A regular expression path pattern that indicates files that should be excluded from being processed.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-p	--path	Path to list.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
am	admin	The openedge database administration tool.
an	analysis	Regroup commands related to database analysis.
ba	backup	Backup a database into a single file for a future restore.
bi	before-image	Operate on database before-image file.
bu	busy	Check the usage mode of a database (busy mode).
ck	check	Check if a database is alive.
cn	connect	Get the connection string to use to connect to a database.
cp	copy	Copy a database.
cr	create	Creates a new database.
da	data	Operate on database data.
dd	datadigger	DataDigger is a tool for exploring and modifying the data of a database.
de	delete	Delete a database.
dt	dictionary	The openedge database dictionary tool.
id	index	Operate on database indexes.
ki	kill	Kill the broker/server processes running for a particular a database.
ka	kill-all	Kill all the broker/server processes running on this machine.
lg	log	Operate on database log files (.lg).
pr	project	Operates on databases belonging to a project.
re	repair	Repair/update the database control information file (.db).
rs	restore	Restore a database from a backup file.
sc	schema	Operate on database schema.
sa	start	Start a database in order to use it in multi-users mode.
so	stop	Stop a database that was started for multi-users.
st	structure	Operate on a database structure file (.st).

Short name	Long name	Description
-d	--detached	Use this option to immediately return to the prompt instead of waiting the for the program to exit.
-c	--connection <args>	(Can be used multiple times) A connection string that can be used to connect to one or more openedge database. The connection string will be used in a `CONNECT` statement.
-f	--file <path>	(Can be used multiple times) Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to a list of path of all the .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
ad	advise	Generates an html report which provides pointers to common database configuration issues.
re	report	Displays an analysis report.

Short name	Long name	Description
-a	--analysis-file <file>	The file path to a database analysis output. If empty, the analysis will be carried on automatically if the database is local.
-u	--unattended	Do not open the html report with the default browser after its creation.
-c	--connection <args>	A connection string that can be used to connect to an openedge database. The connection string will be used in a `CONNECT` statement.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-o	--options <args>	Extra options for the proutil dbanalys command
-a	--access <args>	Database access/encryption arguments: `[[-userid username [-password passwd ]] \| [ -U username -P passwd] ] [-Passphrase]`.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-ns	--no-scan	Prevents the tool from performing an initial scan of the database to display the number of blocks that will be backed up and the amount of media the backup requires.
-nc	--no-compress	Prevents the tool from compressing the backup file.
-op	--options <args>	Use options for the probkup utility (see the documentation online).
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-l	--logical-name <name>	The logical name to use for the database in the connection string.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Argument	Description
<source db path>	Path to the source database (.db file). The .db extension is optional and the path can be relative to the current directory.
<target db path>	Path to the target database (.db file). The .db extension is optional and the path can be relative to the current directory.

Short name	Long name	Description
-ni	--new-instance	Specifies that a new GUID be created for the target database.
-rp	--relative-path	Use relative path in the structure file.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-f	--file <file>	File name (physical name) of the database to create (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the name of the current directory.
-df	--df <file>	Path to the .df file containing the database schema definition. The path can be relative to the current directory.
-st	--st <file>	Path to the structure file (.st file) containing the database physical structure. The path can be relative to the current directory.
-bs	--block-size <size>	The block-size to use when creating the database. Defaults to the default block-size for the current platform (linux or windows).
-lg	--lang <lang>	The codepage/lang to use. Creates the database using an empty database located in the openedge installation $DLC/prolang/(lang).
-ni	--new-instance	Specifies that a new GUID be created for the target database.
-rp	--relative-path	Use relative path in the structure file.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
du	dump	Dump the database data in plain text files (.d).
db	dump-binary	Dump data in binary format from a database.
dq	dump-sequence	Dump the database sequence data in a plain text file (.d).
ds	dump-sql	Dump data in SQL-92 format from a database.
lo	load	Load the database data from plain text files (.d).
lb	load-binary	Load the database data from binary format files.
lk	load-bulk	Load the database data from plain text files (.d).
lq	load-sequence	Load the database sequence data from a plain text file (.d).
ls	load-sql	Load the database data from SQL-92 format files (.dsql).
tc	truncate	Deletes all the data of a given table.

Short name	Long name	Description
-t	--table <tables>	A list of comma separated table names to dump. Defaults to `ALL` which dumps every table.
-c	--connection <args>	A connection string that can be used to connect to an openedge database. The connection string will be used in a `CONNECT` statement.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-op	--options <args>	Use options for the sqldump utility (see the documentation online). Defaults to dumping every table.
-c	--connection <args>	A connection string that can be used to connect to an openedge database. The connection string will be used in a `CONNECT` statement.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-op	--options <args>	Use options for the proutil load utility (see the documentation online).
-nr	--no-rebuild	Do not rebuild indexes when loading the data.
-a	--access <args>	Database access/encryption arguments: `[[-userid username [-password passwd ]] \| [ -U username -P passwd] ] [-Passphrase]`.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-op	--options <args>	Use options for the sqlload utility (see the documentation online). Defaults to loading every table.
-c	--connection <args>	A connection string that can be used to connect to an openedge database. The connection string will be used in a `CONNECT` statement.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
in	install	Install DataDigger in the default installation path.
rm	remove	Remove DataDigger from the installation path.
ru	run	Run a new DataDigger instance.

Short name	Long name	Description
-b	--get-pre-release	Accept to install pre-release (i.e. ‘beta’) versions of the tool.
-p	--proxy <url>	The http proxy to use for this update. Useful if you are behind a corporate firewall. The expected format is: ‘http(s)://[user:password@]host[:port]’. It is also possible to use the environment variables OE_HTTP_PROXY or http_proxy to set this value.
-f	--force	Force the installation even if the tool is already installed.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

SAKOE

ABOUT

What is this tool

About this manual

Command line usage

Response file parsing

Exit code

Website

TABLE OF CONTENT

COMMANDS OVERVIEW

ABOUT THE BUILD COMMAND

Overview

Project

Build configuration

Build configuration variables

Build configuration properties

Build steps

SAKOE CABINET

Synopsis

Usage

Options

Commands

SAKOE CABINET ADD

Synopsis

Usage

Arguments

Options

Description

SAKOE CABINET LIST

Synopsis

Usage

Options

Description

SAKOE DATABASE

Synopsis

Usage

Options

Commands

SAKOE DATABASE ADMIN

Synopsis

Usage

Options

Commands

Description

SAKOE DATABASE ADMIN RUN

Synopsis

Usage

Options

SAKOE DATABASE ANALYSIS

Synopsis

Usage

Options

Commands

SAKOE DATABASE ANALYSIS ADVISE

Synopsis

Usage

Arguments

Options

Description

SAKOE DATABASE ANALYSIS REPORT

Synopsis

Usage

Options

Description

SAKOE DATABASE BACKUP

Synopsis

Usage

Arguments

Options

SAKOE DATABASE BEFORE-IMAGE

Synopsis

Usage

Options

Commands

SAKOE DATABASE BEFORE-IMAGE TRUNCATE

Synopsis

Usage

Options

Description

SAKOE DATABASE BUSY

Short name	Long name	Description
-f	--force	Mandatory option to force the removal and avoid bad manipulation.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-ro	--read-only	Start DataDigger in read-only mode (records will not modifiable).
-d	--detached	Use this option to immediately return to the prompt instead of waiting the for the program to exit.
-c	--connection <args>	(Can be used multiple times) A connection string that can be used to connect to one or more openedge database. The connection string will be used in a `CONNECT` statement.
-f	--file <path>	(Can be used multiple times) Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to a list of path of all the .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-y	--yes	Automatically answer yes on deletion confirmation.
-st	--delete-st	Also delete the structure file (.st).
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-op	--options <args>	Parameters for the proutil idxbuild command. Defaults to `activeindexes`.
-a	--access <args>	Database access/encryption arguments: `[[-userid username [-password passwd ]] \| [ -U username -P passwd] ] [-Passphrase]`.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
-op	--options <args>	Use options for the prorest utility (see the documentation online).
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Short name	Long name	Description
du	dump	Dump the schema definition (.df) of a database.
dc	dump-custom	Dump the schema definition in a custom format.
di	dump-inc	Dump an incremental schema definition (.df) by comparing 2 databases.
dd	dump-inc-df	Dump an incremental schema definition (.df) by comparing 2 .df files.
ds	dump-sql	Dump the SQL-92 schema of a database.
lo	load	Load a schema definition (.df) to a database.

Short name	Long name	Description
-t	--table <tables>	A list of comma separated table names for which we need a schema definition dump. Defaults to `ALL` which dumps every table and sequence.
-c	--connection <args>	A connection string that can be used to connect to an openedge database. The connection string will be used in a `CONNECT` statement.
-f	--file <file>	Path to a database (.db file). The .db extension is optional and the path can be relative to the current directory. Defaults to the path of the unique .db file found in the current directory.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Argument	Description
<old-db-path>	The path to the ‘old’ database. The .db extension is optional.
<new-db-path>	The path to the ‘new’ database. The .db extension is optional.
<dump-file>	Path to the output incremental .df file (extension is optional).

Short name	Long name	Description
-rf	--rename-file <file>	Path to the ‘rename file’. It is a plain text file used to identify database tables and fields that have changed names. This allows to avoid having a DROP then ADD table when you changed only the name of said table. The format of the file is simple (comma separated lines, don’t forget to add a final empty line for IMPORT): - T,old-table-name,new-table-name - F,table-name,old-field-name,new-field-name - S,old-sequence-name,new-sequence-name Missing entries or entries with an empty new name are considered to have been deleted.
-cp	--cp-params <args>	Database server internationalization startup parameters such as `-cpinternal` codepage and `-cpstream` codepage. This option will be used for openedge commands that support them (_dbutil, _mprosrv, _mprshut, _proutil).
-dl	--dlc <dir>	The path to the directory containing the Openedge installation. Will default to the path found in the `OE_DLC` or `DLC` environment variable if it exists.
-vb	--verbosity[:level]	Sets the verbosity of this command line tool. To get the ‘raw output’ of a command (without displaying the log), you can set the verbosity to `none`. Specifying this option without a level value sets the verbosity to `debug`. Not specifying the option defaults to `info`. Optionally, set the verbosity level for all commands using the environment variable `CLI_VERBOSITY`.
-lo	--log-output[:file]	Output all the log message in a file, independently of the current verbosity. This allow to have a normal verbosity in the console while still logging everything to a file. Specifying this option without a value will output to a default log file.
-wl	--with-logo	Always show the logo on start.
-pb	--progress-bar <mode>	Sets the display mode of progress bars. Specify `off` to hide progress bars and `persistent` to make them persistent. Defaults to `on`, which show progress bars but hide them when done.
-h	--help	Show this help text.

Argument	Description
<old df path>	The path to the ‘old’ database.
<new df path>	The path to the ‘new’ database.
<dump-file>	Path to the output incremental .df file (extension is optional).