ESSCMD to MaxL Mapping

The following table compares ESSCMD usage to MaxL usage, and the following conversions are supported by cmd2mxl.

ESSCMD CommandESSCMD Usage ExampleMaxL Equivalent Example
ADDUSERADDUSER finance essexer1;alter user essexer1 add to group finance;
BEGINARCHIVEbeginarchive sample basic "test.txt";alter database Sample.Basic begin archive to file 'test.txt';
BEGININCBUILDDIMbeginincbuilddim;import database Sample.Basic dimensions from local text data_file 'c:\\data.txt' using local rules_file 'c:\\data_rule.rul' on error write to 'c:\\error.log';
BUILDDIMbuilddim 1 "c:\data_rul.rul" 3 "c:\data.txt" 4 "c:\error.log";Same as BEGININCDIMBUILD
CALCcalc "CALC ALL;";execute calculation 'CALC ALL' on sample.basic;
CALCDEFAULTcalcdefault;execute calculation default on Sample.Basic;
CALCLINEcalcline "CALC ALL;";execute calculation 'CALC ALL;' on sample.basic;
COPYAPPcopyapp sample sampnew;create application sampnew as sample;
COPYDBcopydb sample basic sample basic2;create or replace database sample.basic2 as sample.basic;
COPYFILTERcopyfilter sample basic westwrite sample basic westmgr;create filter sample.basic.westmgr as sample.basic.westwrite;
COPYOBJECTcopyobject "9" "sample" "basic" "calcdat" "sample" "basic" "calcdat2";alter object sample.basic.calcdat of type text copy to 'sample.basic.calcdat2';
CREATEAPPcreateapp finance;create or replace application finance;
CREATEDBcreatedb finance investor;create or replace database finance.investor;
CREATEGROUPcreategroup managers;create group managers;
CREATELOCATION

select sample basic;

createlocation hq hqserver finance investor admin password;

alter system load application sample;

alter application sample load database basic;

create location alias hq from sample.basic to finance.investor at hqserver as admin identified by 'password';

CREATEUSERcreateuser karen password;create user karen identified by 'password';
CREATEVARIABLEcreatevariable CurMnth localhost sample basic Jan;

alter database sample.basic add variable CurMnth 'Jan';

alter application sample add variable CurMnth 'Jan';

alter system add variable CurMnth 'Jan';

DELETEAPPdeleteapp sampnew;drop application sampnew cascade;
DELETEDBdeletedb demo basic;drop database demo.basic;
DELETEGROUPdeletegroup engg;drop group engg;
DELETELOCATION

select finance investor;

deletelocation hq1;

alter system load application finance;

alter application finance load database investor;

drop location alias finance.investor.hq1;

DELETELOGdeletelog sample;alter application sample clear logfile;
DELETEUSERdeleteuser rob;drop user rob;
DELETEVARIABLE

select sample basic;

deletevariable CurMnth "localhost";

alter system load application sample;

alter application sample load database basic;

alter database sample.basic drop variable CurMnth;

alter application sample drop variable CurMnth;

alter system drop variable CurMnth;

DISABLELOGINdisablelogin demo;alter application demo disable connects;
DISPLAYALIAS

select sample basic;

displayalias "default";

query database sample.basic list alias_names in alias_table 'Default';
ENABLELOGINenablelogin demo;alter application demo enable connects;
ENDARCHIVEendarchive sample basic;alter database sample.basic end archive;
ENDINCBUILDDIMENDINCBUILDDIM;See BEGININCBUILDDIM
ESTIMATEFULLDBSIZE

select sample basic;

estimatefulldbsize;

query database sample.basic get estimated size;
EXITexit;exit;
EXPORT

select sample basic;

export "c:\data.txt" 1;

alter system load application sample;

alter application sample load database basic;

export database Sample.Basic all data to data_file 'c:\\data.txt';

GETALLREPLCELLS

select samppart company;

getallreplcells "svr2" "sampeast" "east";

alter system load application samppart;

alter application samppart load database company;

refresh replicated partition samppart.company from sampeast.east at svr2;

GETAPPINFOgetappinfo "demo";display application demo;
GETAPPSTATEgetappstate demo;display application demo;
GETATTRIBUTESPECS

select sample basic;

getattributespecs;

query database sample.basic get attribute_spec;
GETATTRINFO

select sample basic;

getattrinfo "Caffeinated_True";

query database sample.basic get attribute_info 'Caffeinated_True';
GETDBINFO

select sample basic;

getdbinfo;

display database sample.basic request_history;
GETDBSTATEgetdbstate sample basic;display database sample.basic;
GETDBSTATS

select sample basic;

getdbstats;

query database sample.basic get dbstats data_block;
GETCRRATEgetcrrate;query database sample.basic get currency_rate;
GETDEFAULTCALC

select sample basic;

getdefaultcalc;

query database sample.basic get default calculation;
GETMBRCALC

select sample basic;

getmbrcalc "Profit %";

query database sample.basic get member_calculation 'Profit %';
GETMBRINFO

select sample basic;

getmbrinfo "Ounces_20";

query database sample.basic get member_info 'Ounces_20';
GETPERFSTATS

select sample basic;

getperfstats;

query database sample.basic get performance statistics kernel_cache table;
GETUPDATEDREPLCELLSSee GETALLREPLCELLSSee GETALLREPLCELLS
GETUSERINFOgetuserinfo admin;display user admin;
GETVERSIONgetversion;version;
IMPORT

select sample basic;

import 1 "c:\data.txt" 4 y 3 "c:\import.rul" n "c:\data_load.err";

alter system load application sample;

alter application sample load database basic;

import database sample.basic data from local text data_file 'c:\\data.txt' using local rules_file 'c:\\data_rule.rul' on error write to 'c:\\data_load.err';

INCBUILDDIMSee BEGININCBUILDDIMSee BEGININCBUILDDIM
LISTALIASES

select sample basic;

listaliases;

query database sample.basic list alias_table;
LISTAPPlistapp;display application all;
LISTDBlistdb;display database all;
LISTFILESlistfiles "" "sample" "basic";query database sample.basic list all file information;
LISTFILTERSlistfilters sample basic;display filter on database Sample.Basic;
LISTGROUPSlistgroups;display group all;
LISTGROUPUSERSlistgroupusers finance;display user in group finance;
LISTLINKEDOBJECTS

select sample basic;

listlinkedobjects "Fiona" "07/07/2003";

query database sample.basic list lro by Fiona before '07/07/2003';
LISTLOCATIONS

select sample basic;

listlocations;

alter system load application sample;

alter application sample load database basic;

display location alias on database sample.basic;

LISTLOCKSlistlocks;display lock;
LISTLOGINSlistlogins;display session all;
LISTOBJECTSlistobjects "2" "Sample" "Basic";display object of type calc_script on database sample.basic;
LISTUSERSlistusers;display user all;
LISTVARIABLESlistvariables localhost sample basic;display variable on database sample.basic;
LOADALIAS

select sample basic;

loadalias "special_flavors" "C:\Hyperion\products\Essbase\EssbaseServer\app\sample\basic\seasonal.txt";

alter database sample.basic load alias_table 'special_flavors' from data_file "$ARBORPATH\\app\\sample\\basic\\seasonal.txt";
LOADAPPloadapp sample;alter system load application sample;
LOADDBloaddb sample basic;alter application sample load database basic;
LOADDATA

select sample basic;

loaddata 3 "c:\data.txt";

alter system load application sample;

alter application sample load database basic;

import database sample.basic data from local text data_file 'c:\\data.txt' on error abort;

LOGINlogin local admin password;login admin 'password' on local;
LOGOUTlogout;logout;
LOGOUTALLUSERSlogoutallusers y;alter system logout session all;
LOGOUTUSERAvailable only in interactive ESSCMD sessions.alter system logout session 4294967295;
OUTPUT

output 1 c:\test.log;

output 4;

spool on to 'c:\test.log';

spool off;

PURGELINKEDOBJECTSpurgelinkedobjects "Fiona" "07/07/2002";alter database sample.basic delete lro by 'fiona' before '07/07/2002';
PUTALLREPLCELLS

select sampeast east;

putallreplcells svr1 samppart company;

alter system load application sampeast;

alter application sampeast load database east;

refresh replicated partition sampeast.east from samppart.company at svr1 updated data;

PUTUPDATEDREPLCELLSSee PUTALLREPLCELLSSee PUTALLREPLCELLS
REMOVELOCKSremovelocks "2";drop lock held by Fiona;
REMOVEUSERremoveuser finance steve;alter user steve remove from group finance;
RENAMEAPPrenameapp sample newsamp1;alter application sample rename to newsamp1;
RENAMEDBrenamedb sample basic newbasic;alter database sample.basic rename to newbasic;
RENAMEFILTERrenamefilter sample basic westmgr allwest;

create or replace filter sample.basic.westmgr as sample.basic.allwest;

drop filter sample.basic.westmgr;

RENAMEOBJECTRENAMEOBJECT "9" "sample" "basic" "calcdat" "calcdat2";alter object sample.basic.calcdat of type text rename to 'calcdat2';
RENAMEUSERrenameuser steve_m m_steve;alter user steve_m rename to m_steve;
RESETDB

select sample basic;

resetdb;

alter database sample.basic reset;
RESETPERFSTATSresetperfstats enable;alter database sample.basic set performance statistics enabled;
RUNCALC

The only command supported is the server based calc script execution.

Select Sample Basic;

Runcalc 2 one;

execute calculation Sample.Basic.one;
RUNREPTselect sample basic; runrept 2 complex "c:\complex.out";

alter system load application sample;

alter application load database basic;

export database sample.basic using server report_file 'complex' to data_file 'c:\\complex.out';

SELECTselect sample basic;

alter system load application sample;

alter application load database basic;

SETALIAS

select sample basic;

setalias "long names";

alter database sample.basic set active alias_table 'Long Names';
SETAPPSTATEsetappstate sample "" y y 4 y y y y 1000 1000;

alter application sample enable startup;

alter application sample enable autostartup;

alter application sample set minimum permission manager;

alter application sample enable connects;

alter application sample enable commands;

alter application sample enable updates;

alter application sample enable security;

alter application sample set lock_timeout after 1000 seconds;

alter application sample set max_lro_file_size 1000 kb;

SETDBSTATEsetdbstate "" "Y" "Y" 4 3145728 "Y" "Y" "Y" "" "" 0 1048576 1025 "Y";

alter database sample.basic enable startup;

alter database sample.basic enable autostartup;

alter database sample.basic set minimum permission manager;

alter database sample.basic set data_cache_size 3145728;

alter database sample.basic enable aggregate_missing;

alter database sample.basic enable two_pass_calc;

alter database sample.basic enable create_blocks;

alter database sample.basic set currency_conversion division;

alter database sample.basic set index_cache_size 1048576;

alter database sample.basic enable compression;

SETDBSTATEITEM

.

See the alter database statement.
SETDEFAULTCALC

select sample basic;

setdefaultcalc "CALC ALL;";

alter database sample.basic set default calculation as 'CALC ALL';
SETDEFAULTCALCFILE

select sample basic;

setdefaultcalcfile defcalc;

Create a calculation file in the server containing the calculation string. Then, alter database sample.sasic set default calculation sample.basic.defcalc; will set the default calculation.
SETMSGLEVELsetmsglevel 2;

set message level all;

Note:

This is part of the separate MaxL Shell grammar, not the MaxL language itself. You can use set message level with the MaxL Shell, but it is not embeddable in Perl.

SETPASSWORDsetpassword steve newpass;alter user steve set password newpass;
SHUTDOWNSERVERshutdownserver local admin password;

login admin 'password' on local;

alter system shutdown;

SLEEPsleep 10;shell sleep 10;
UNLOADALIAS

select sample basic;

unloadalias "flavors";

alter database sample.basic unload alias_table 'flavors';
UNLOADAPPunloadapp sample;alter system unload application sample;
UNLOADDBunloaddb sample basic;alter application sample unload database basic;
UNLOCKOBJECTunlockobject "1" "sample" "basic" "basic";alter object 'sample.basic.basic' of type outline unlock;
UPDATE

select sample.basic

update "Jan Sales '100-10' Florida Actual 220";

import database sample.basic from data_string 'Jan Sales 100-10 Florida Actual 220';
UPDATEFILEupdatefile 3 "c:\data.txt" 1;same as LOADDATA;
UPDATEVARIABLEupdatevariable hot_product local sample basic "100-10";

alter system set variable 'hot_product' '100-10';

alter application sample set variable 'hot_product' "100-10";

alter database Sample.Basic set variable 'hot_product' '100-10';

VALIDATEvalidate;alter database sample.basic validate data to local logfile 'validation.txt';