Index

• #Kitchen? ?????
• #??
• #Kitchen ????
• #??? ?? ??
• #??
• #??? ?? Job ?? ??
• #?????? ?? Job ????
• #?? ??? ??
• #????
• #????

Kitchen? ?????

...

??

...

• #What is Kitchen?
• #Installation
• #Launching Kitchen
• #Command line options
• #Path
• #Run a job from file
• #Run a job from Repository
• #Redirecting output
• #Return codes
• #Scheduling

What is Kitchen?

Installation

After this, you can simply unzip the distribution zip-file in a directory of your choice.
In the Kettle directory where you unzipped the file, you will find a number of files.
Under Unix-like environments (Solaris, Linux, OSX, ...) you will need to make the shell scripts executable. Execute these commands to make all shell scripts in the Kettle directory executable:

cd Kettle
chmod +x *.sh

Launching Kitchen

...

Anchor
Launching Kitchen ???? Launching Kitchen ????

?? ????? Carte? ???? ?? ???? ?????? ????.
To launch Kitchen on the different platforms these are the scripts that are provided:

• Kitchen.bat: run Kitchen on the Windows platform?? Kitchen? ??.
• kitchen.sh: Unix platform ? Mac OSX?? Kitchen? ??.

...

??? ?? ??

...

• run Kitchen on Unix platforms and Mac OSX

Kitchen can be run on any platform that has a version of the Java Runtime Environment version 1.5 or higher.

Command line options

IMPORTANT NOTES:
Windows ??????, ??? ???? On Windows system, the use of the minus ("-") ? equalin the options causes problems as well as the equal sign ("=")? ???? ??? ?? ???. ? ???, 2.2.2 ?? ??? ? ??? ?? ? ? ????.
( Because of this, from version 2.2.2 on, you can also use this format or any combination of /,- and :,=)
????? ??? ??? ?? ??? ???? ?? ?????.
?? ?? ?? ????? ???, ????(quotes or double quotes)? ?????. ??? ??? ??? ??? ???
Fields in italic represent the values that the options use.
It's important that if spaces are present in the option values, you use quotes or double quotes to keep them together. Take a look at the examples below for more info.

/option:value

??? ??? ??? ???.

...

Below are the valid options.

Display version information

-version

? ??? Kettle? ?? ?????This option displays the version of the Kettle core library (kettle.kar)? ??? ?????.
???? ??? ?? ??? ?? ?????.

...

jar).
The build version number and build date are shown as well.

Launch XML File

--file=XML????

...

filename

This option runs the job defined in the XML file. (.kjb : Kettle Job)

...

Set the logging file

-log=???? ??

????? ?? ???. ???? ?? ??(stdout) ???.

...

Logging Filename

Specifies the log file. The default is the standard output.

Set the logging level

-level=????

????? ???? Job? ????? ?? ???.
????? ??? ??? ??? ????:

• Error: ??? ???.
• Nothing: ?? ??? ?? ??.
• Minimal: ???? ??? ???.
• Basic: ??? ????.
• Detailed: ??? ????.
• Debug: ??? ???? ?? ??? ??.
• Rowlevel: (row)? ??. ? ??? ?? ???? ?? ? ? ????.

...

Logging Level

The level option sets the log level for the job that's being run.
These are the possible values:

• Error: Only show errors
• Nothing: Don't show any output
• Minimal: Only use minimal logging
• Basic: This is the default basic logging level
• Detailed: Give detailed logging output
• Debug: For debugging purposes, very detailed output.
• Rowlevel: Logging at a row level, this can generate a lot of data.

Choose a repository

-rep=?????

...

Repository name

Connect to the repository with name "Repository name".
You also need to specify the options -user, -pass, -dir ? and -job ??? ??? ??? ???.
???? KETTLE_REPOSITORY ? ? ??? ?? ? ?? ????.

...

.
You can also specify this option in the form of environment variable KETTLE_REPOSITORY.

Set the repository user name

-user=?????

??? ???? ??? ???? ??? ?? ???.
??, ???? KETTLE_USER ? ? ??? ?? ? ?? ????.

...

Username

This is the username with which you want to connect to the repository.
You can also specify this option in the form of environment variable KETTLE_USER.

Set the repository password

-pass=????

???? ?????? ???? ????.
???? KETTLE_PASSWORD ? ? ??? ?? ? ?? ????.

...

Password

The password to use to connect to the repository
You can also specify this option in the form of environment variable KETTLE_PASSWORD.

Select the repository job to run

-job=Job??

?? ? Job? ????? ???? ?? ? ??? ?????. "-dir" ???? ????? ?? ? ???.

...

 Name

Use this option to select the job to run from the repository. Please also select the directory with the "-dir" option.

List the directories in the repository

-listdir=Y

Print a listing of all the sub-directories in the repository directory specified with the option "-dir" ???? ?? ? ????? ????? ?? ?? ???? ???? ?????.

...

.

Set the repository directory

-dir=????

?? ? ???? ????? ?????. ??? ????? ??? ?? ?????.

...

directory

Specifies the directory in the repository to use. Repository directories are specified like this:

• The root directory: /
• A subdirectory: /production/Dimensions

From version 2.2.2 ?? , ?? ????? on, a / (?)? ????? ?????.

...

slash) is used to separate directories on all platforms.

List the repository jobs

-listjobs=Y

Show a list of all the jobs in the repository directory specified with the option "-dir" ???? ??? ??? ????? ?? ?? Job ???? ?????.

...

.

List the available repositories

-listrep=Y

??? ?? ??? ???? ?????.

...

Print a listing of all the defined repositories.

Don't log in to the repository

-norep=Y

???? If you have set environment variables KETTLE_REPOSITORY, KETTLE_USER, KETTLE_PASSWORD ? ?? ????, Kitchen? ???? ??? ?? ?? ?? ? ????.
?? ??, XML ??? Job? ????? ? ?, ? ??? ?? ? ? ?? ????.

??

Anchor ?? ??, you can prevent Kitchen from logging into the repository. For example if you want to launch a job from an XML file.

Path

...

cd /product/Kettle/

??? ?? Job ?? ??

...

...

Run a job from file

...

kitchen.sh -file=/PRD/updateWarehouse.kjb -level=Minimal

?????? ?? Job ????

...

...

Run a job from Repository

kitchen.bat
                    /rep:"Production Repository"
                    /job:"Update dimensions"
                    /dir:/Dimensions
                    /user:matt
                    /pass:somepassword123
                    /level:Basic

...

Redirecting output

...

kitchen.bat /file:C:\PRD\runAll.kjb /level:Basic > C:\LOG\trans.log

...

Return codes

• 0 : The job ran without a problem.
• 1 : Errors occurred during processing
• 2 : An unexpected error occurred during loading / running of the job
• 7 : The job couldn't be loaded from XML or the Repository
• 8 : Error loading steps or plugins (error in loading one of the plugins mostly)
• 9 : Command line usage printing

...

Scheduling

Schedule a job on windows

The best way to go at it is to test the command first at the dos prompt.
Then you can use the windows scheduler to launch this command.
Windows versions since Windows 2000 have a GUI for doing this accessible through the control panel. However it's also possible to use the command line to do this:

...

To see a list of the scheduled commands simply type:

at

Schedule a job on Unix

First create a shell script that runs all the jobs you need. Then you can schedule this script to run.
On Unix like systems the easiest way to schedule a command is by using the "cron table". You can do this by entering the following command:

...