Category: SET Commands

SET (EntitySet/Data Relationship Attribute)

SET (EntitySet/Data Relationship Attribute)

Modifies the value of an attribute of a database object.

Syntax

SET tablename tabletype [ “ZIMSERV” | “JDBCSAM” | alias name ]

SET tablename [ remname |  remowner ] value

SET fieldname [ remname ] value

tablenameis the name of an EntitySet or data relationship
fieldnameis the name of a field in an EntitySet or data relationship
TABLETYPEis the option to modify the location of tablename
REMNAMEis the option to modify the Remote Name of tablename or fieldname
REMOWNERis the option to modify the Remote Owner Name of tablename
alias nameis or as defined in the configuration file “zimalias.zim”.
valueis an expression that evaluates to a string

Comments

These two forms of the SET command modify attributes of EntitySets, data relationships, and fields that affect client-server behavior.

These commands affect the internal value of these attributes. They do not update the external data dictionary. It is prudent to modify the data dictionary to conform to any new attribute values that are set. The utility ZIMFILES can be used to display internal values of any database object.

When modifying TABLETYPE, the value must be a valid SAM name or custom server name. This is equivalent to modifying EntType in EntitySets or RelType in Relationships and then performing “erase” and “create” commands on the EntitySet or data relationship.

Changing the REMNAME or REMOWNER to the value null string (”) removes any Remote Name or Remote Owner Name associated with the database object.

The SET REMOWNER command is equivalent to changing the “RemoteOwner” in “EntitySets” or “Relationships” and then recreating the EntitySet or relationship.

The SET REMNAME command is equivalent to changing the “RemoteName” in “EntitySets” or “Relationships” and then recreating the EntitySet or relationship.

Any compiled Zim programs that reference database objects that have been modified with these commands should be recompiled.

Example 1

To modify the EntitySet Customers so that it is under the control of an Oracle SQL server, enter

> set Customers tabletype 'jdbcsam'
> set MyEnt tabletype 'zimserv'

Example 2

To modify the Remote Name of the field ZIP in EntitySet customers, enter

> set Customers.ZIP remname '"ZIP or Postal Code"'

When modifying the attribute of a field, qualify it with its entity set or relationship name to avoid ambiguity. Note that double quotation marks are included in the REMNAME value. Most database engines require double quotation marks around the column name if it contains embedded blanks.

Example 3

To remove the Remote Name of the field ZIP in EntitySet customers that was added above, enter

> set Customers.ZIP remname ''

See Also

Remote Name Mapping

SET COMMANDTIMING

Displays how much time each command takes to execute.

Syntax

SET COMMANDTIMING ON|OFF

Comments

The COMMANDTIMING option is set OFF by default.

The SET COMMANDTIMING command controls the output of command timing messages.

In UNIX, the format of command timing messages is

source, line, IU|RU, user ticks, elapsed user ticks, IS|RS, system ticks, elapsed system ticks

source

The name of the application document that contains the command; if it is the ZIM prompt, source is “”.

line

The line number of the line in the application document on which the command begin; if the value of source is “”, the value of line is a sequential number from the prompt.

IU|RU

Can be
IU (interpretive user execution)
RU (runtime user execution)

user ticks

The time it took to interpret the command (for interpretive execution) or the time it took to accept the command for processing (for compiled execution).

elapsed user ticks

The time it took to interpret the command, as seen by the user.

IS|RS

Can be
IS (interpretive user execution)
RS (runtime user execution)

system ticks

The system ticks used by the command. Usually, the system ticks value is lower than the user ticks value.

elapsed system ticks

The number of ticks spent by the execution of the command as seen by the system. Usually the elapsed system ticks value is lower than the elapsed user ticks value.

For Windows systems, the format of command timing messages is

source, line, I|R, user ticks, elapsed user ticks

source

The name of the application document that contains the command; if it is the ZIM prompt, source is “”.

line

The line number of the line in the application document on which the command begin; if the value of source is “”, the value of line is a sequential number from the prompt.

I|R

Can be
I (interpretive user execution)
R (runtime user execution)

user ticks

The time it took to interpret the command (for interpretive execution) or the time it took to accept the command for processing (for compiled execution).

elapsed user ticks

The time it took to interpret the command, as seen by the user.

 

See Also

SET LEXTRACE

SET TRACE

SET TRACEOUTPUT

SET XML ROWELEMENT

Defines the title of the row element

Syntax

set xml rowelement constant

Parameters

constant

A character string or an expression that evaluates to a character string

Comments

SET XML ROWELEMENT defines the identification of the row element for each row data that is printed whenever the set output format xml or xmlsimple is set. By default, ZIM prints the pair ….

Example

set save

set output format xmlsimple

set xml rowelement /p>

set output MyDoc

list 1 Docs

set restore

 

See Also

SET OUTPUT FORMAT

SET XMLHEADER

SET NULLVALUE

Specifies the characters to be displayed for $Null values.

Syntax

SET NULLVALUE constant

Parameters

constant

A character string, or an expression that evaluates to a character string.

Comments

The NULLVALUE option is set to a space character by default.

When a value to be output is $Null, the specified constant is displayed.

Example

To specify that the character constant NA is to be displayed for $Null expressions, use

> set nullvalue “NA”

As a result, a LIST command looks like this:

> list 3 Employees
 
LastName    FirstName    Salary
Smith      John        25000
Jones      NA         35000
Johnson     Janet        NA

 

See Also

$Null

Expressions and the $Null Property

SET TRACE OUTPUT

Records tracing information.

Syntax

SET TRACE OUTPUT docname [APPEND]

Parameters

docnameThe name of an application document.
All subsequent trace output is sent to the specified document.
APPENDIndicates that subsequent trace output is to be appended to the existing contents of docname.

Comments

Normally, information generated by the commands SET COMMANDTIMING, SET FLOW, SET LEXTRACE, SET STRATEGY, SET TRACE, and SET TRANSACTION FLOW is displayed on the screen. The SET TRACE OUTPUT command enables you to redirect the output to docname.

Example

set trace output RecordTrace

Redirects tracing information to an application document called RecordTrace.

set trace output terminal

Tracing information is displayed on the terminal screen.

See Also

SET FLOW

SET LEXTRACE

SET STRATEGY

SET TRACE

SET TRANSACTION FLOW

SET INFORMATION

Enables or suppresses the display of information messages.

Syntax

SET INFORMATION ON|OFF

Comments

The INFORMATION option is set ON by default.

When INFORMATION is ON, information messages are displayed. Setting INFORMATION to OFF suppresses the display of such messages. Information messages are of the form:

nnn selectedafter a FIND command
nnn addedafter an ADD command
nnn changedafter a CHANGE command
nnn deletedafter a DELETE command

All types of messages can be simultaneously turned on or off with a SET MESSAGES command.

The SET INFORMATION command has no effect on the logging of messages in the “error trace” file. Message logging is governed by the configuration option error trace.

Example

set messages on
set information off

The preceding commands set error and warning messages on, but information messages off.

See Also

SET ERRORS

SET WARNINGS

SET SQLCOMPILE

SET SQLCOMPILE

Controls the compilation of generated SQL statements within the SQL database.

Syntax

SET SQLCOMPILE ON|OFF

Comments

The SQLCOMPILE option is OFF by default. The software stores SQL statements generated in the compiled code and executes them dynamically at run time.

When SQLCOMPILE is switched ON, the software attempts to compile all generated SQL statements at the SQL database server. Before attempting to compile with SQL compiling switched on, you must be connected to the SQL database.

Changes to this setting provide control over how the SQL statements are to be executed. The query optimizers for certain SQL databases perform differently when processing SQL statements dynamically.

Example

set sqlcompile off
list all Customers format CC LastName
set sqlcompile on

Forces the statement list all Customers format CC LastName to be executed dynamically at the server within a compiled application program.

See Also

COMPILE

SET COMPILEMODE

SET EXECUTEMODE

SET SQLTRACE

UNCOMPILE

SET CHECKSETS

Controls consistency checking of result sets.

Syntax

SET CHECKSETS ON|OFF

Comments

The CHECKSETS option is set ON by default.
When CHECKSETS is ON, the software checks certain aspects of the component structure of result sets for consistency. This consistency checking is performed when a command creates a result set (using the -> (Result set) subcommand), if the set has already been defined as a result set, either in a previous set-producing command, or as a NamedSet object in the Object Dictionary. Normally, you should always leave CHECKSETS set ON.
The SET CHECKSETS command is not affected by the SET RESET and SET RESTORE commands.

Example

find Employees -> Set1

find Departments -> Set1

With CHECKSETS set ON, the second command in the preceding sequence produces an error (the component structure of the set is not consistent from one command to the next).

set checksets off

find Employees -> Set1

find Departments -> Set1

By setting CHECKSETS OFF, the command sequence produces no error.

See Also

CREATE

SET EXECUTEMODE

SET EXECUTEMODE

Controls the mode of software execution.

Syntax

SET EXECUTEMODE SQLMODE | ZIMMODE | SERVERMODE

Comments

The EXECUTEMODE option is set to SQLMODE by default.

The SQLMODE option executes SQL database code.

The SERVERMODE option executes integrated Zim server code.

The ZIMMODE option executes standard Zim code. In ZIMMODE, EntType, RelType, and so on are ignored. In this way, it can be used for testing without an effective connection.

When EXECUTEMODE is SQLMODE, Zim executes integrated server requests on the target Zim server if possible. Otherwise, it sends SQL requests to the server. When EXECUTEMODE is SQLMODE, Zim executes code against the target SQL database. By setting EXECUTEMODE to ZIMMODE, Zim executes the code as standard Zim code.

Example

To execute Zim Client-server code as standard Zim code, enter

> set executemode zimmode

See Also

COMPILE

SET COMPILEMODE

SET SQLCOMPILE

UNCOMPILE

SET STOP ERRORS

Halts the execution of an application program if an error occurs.

Syntax

SET STOP ERRORS ON|OFF

Comments

The STOP ERRORS option is OFF by default.

When STOP ERRORS is switched ON, execution is halted (by the HALT utility) when an error occurs. To resume execution after the HALT, press Enter at the HALT prompt (>>).

Compiled application programs are not affected by SET STOP ERRORS.

The ET STOP ERRORS command is not affected by the SET RESET and SET RESTORE commands.

Example

> set stop errors on
:
> list all test
procedure test (p_OwnerName)
report from Fields where OwnerName = p_OwnerName % Spelling error
… body of report …
endreport
endprocedure
> test
*** Error *** …
>>

The HALT command is executed when the execution of test results in an error. (The name of the EntitySet Fields is misspelled in the body of the procedure.)

See Also

$ErrCode

SET SELECTIVITY

SET SINGLESTEP

en_CAEnglish
pt_BRPortuguese en_CAEnglish