databaseconsoledump
databaseconsoledump
DATABASE
,
OPTION
,
VALUE

The databaseconsoledump statement dumps the raw contents of the specified database to the console in comma delimited format.

Parameters

This statement has three parameters:

database – name of the database to dump, or "" for the current database.

option – additional option/value pairs, see below.

value – additional option/value pairs, see below.

Description

This statement dumps the raw contents of the specified database to the console in comma delimited format. This statement was developed for ProVUE’s internal use during development of Panorama, but is available for anyone to use.

Important Note: This statement only works when running Panorama from Terminal.app, if you are running Panorama normally (from the Finder), this statement is ignored.

To dump the current database, just use a single empty parameter.

    databaseconsoledump ""

You can also specify any open database:

    databaseconsoledump "Contacts"

In the console, the dump will look something like this:

    DUMP DATABASE: Contacts AT: 6:32:22 pm ----------------------
    QUERY: State="CA"
    ID:TS --- First, Last, Address, City, State
    3:0 =0= Joe,Smith,134 Peach Street, Pasadena, CA
    5:0 =0= Suzanne,Walters,893 Lake Avenue, Sierra Madre, CA

The first line lists the database name, the time, and the caption if you have specified one (see Dump Options below).

The second line lists the query formula if you have specified one (see Dump Options below).

The third line is the database header. It starts with `ID:TS ---`, then lists the field names.

The rest of the dump is the body of the database. Each line starts with the record id, then the time stamp. This will be followed by either = (a selected record) or - (not selected). Next is the summary level, then another = or -. The rest of the line is the data in comma separated format.

#### DUMP OPTIONS

Additional parameters can be added as option/value pairs. This example specifies that only records in the state of California should be dumped.

    databaseconsoledump "Contacts","QUERY",{State="CA"}

The available options are QUERY and CAPTION. (Note, these example show the option names in all upper case, but they can be any mix of upper and lower case.)

The QUERY option specifies what records to include in the dump. If this parameter is empty or missing, all records will be dumped.

The CAPTION option specifies a caption that will be included in the first line of the dump. This can help you remember which dump is which if you are using this command over and over again.

See Also

- serverdatabaseconsoledump -- dumps the raw contents of the specified database on the server to the console in comma delimited format.

History

Version | Status | Notes
10.2 | New | New in this version.