| Subcmd |
Description |
| close |
|
|
|
Closes the database, destroys the object.
|
|
|
| get info |
|
|
|
Retrieves the description of the database. The result is a
list suitable for array set.
|
|
|
| get recnum |
|
|
|
Retrieves the number of records in the database.
|
|
|
| get appinfo |
|
|
|
Retrieves the application information block of the
database. The result depends on the chosen converter, but
usually is a list suitable for array set.
See Conversions commands for the description of the formats
returned by the converters for the standard databases.
|
|
|
| get sortinfo |
|
|
|
Retrieves the sort information block of the database. The
result depends on the chosen converter, but usually is a list
suitable for array set.
See Conversions commands for the description of the formats
returned by the converters for the standard databases.
|
|
|
| get recordlist |
|
?-sorted?
|
|
Retrieves a list containing the ids of all records in the
database. Using the -sorted option causes them to be
sorted by increasing index numbers.
|
|
|
| get record |
|
?-byId? id|idx
|
|
Retrieves the specified record of the database. The result
is a 4-element list containing the id of the record, its
category (a number), its attributes (as a list of attribute
flags) and the (possibly converted) record contents, in this
order. The format of the record contents depends on the chosen
converter, but usually is a list suitable for array set.
See Conversions commands for the description of the formats
returned by the converters for the standard databases.
Using the -byId option causes the system to interpret
the following number as a record id, else as a record index (in
the range 0 .. get recnum).
Allowed only for non-resource databases.
Generated attributes are:
- archive
- Tagged for archival during next sync
- delete
- Tagged for deletion during next sync
- dirty
- Record modified since the last sync
- locked
-
Record currently locked by an application
on the pilot.
- secret
-
The record is `secret`. But accessible nevertheless.
This is a command to the pilot to show the record only
after entering a password. It neither affects data
transfers, nor does it encrypt the record.
|
|
|
| get nextModified |
|
?cat?
|
|
The same as above, but the record is implicitly specified as
the next record after the last which is marked as modified. If a
category is specified it is the next modified record
with the given category. See resetIndex too.
Allowed only for non-resource databases.
|
|
|
| get nextInCategory |
|
cat
|
|
The same as above, but the record is implicitly specified as
the next record with the given category. See
resetIndex too.
Allowed only for non-resource databases.
|
|
|
| get resource |
|
idx
|
|
Retrieves the resource record with the specified index from the
database. The result is a 2-element list containing the resource
type and the (possibly converted) resource contents, in this order.
The format of the resource contents depends on the chosen converter,
but usually is a list suitable for array set.
Allowed only for resource databases, i.e. applications.
The resource type is a character string, like the database
creator/type information.
|
|
|
| set appinfo |
|
data
|
|
Write the application information block of the database.
data has to be in the same format as returned by
get appinfo, for the same setting of the converter
option.
|
|
|
| set sortinfo |
|
data
|
|
Write the sort information block of the database.
data has to be in the same format as returned by
get sortinfo, for the same setting of the converter
option.
|
|
|
| set record |
|
id {cat attr data}
|
|
Write a record into the database. data has to be in
the same format as returned by the various
get record-commands, for the same setting of the
converter option.
attr is a list containing database attributes, as
explained before.
|
|
|
| set resource |
|
id {type data}
|
|
Write a resource into the database. data has to be in
the same format as returned by get resource, for the
same setting of the converter option.
|
|
|
| category move |
|
from to
|
|
Changes the cateegory of all entries with category from
to category to. Returns an empty string.
Categories are identified by integer numbers in the range 0 .. 15
(There are no more than 16 categories).
|
|
|
| category delete |
|
id
|
|
Deletes the category 'id' (but not the entries using it ?). Returns
an empty string.
|
|
|
| cleanup |
|
|
|
Delete all records marked for deletion. Returns an empty string.
|
|
|
| resetSync |
|
|
|
Resets the flags governing the sync process (dirty, archive)
for all records in database.
|
|
|
| resetIndex |
|
|
|
Resets the internal pointer for the next...
commands to the start of the database.
|
|
|
| delete record |
|
id|'all'
|
|
Deletes one or all records, if one based upon id
|
|
|
| delete resource |
|
type id|'all'
|
|
Deletes one or all resources, if one based upon id and type.
|
|
|
| foreach |
|
?-modified? ?-category cat? var script
|
|
Iterator, wrapper around the resetIndex and
next... commands to simplify access to the database.
Cannot be nested for a single database!
Not yet implemented.
|
|
|
| cget |
|
-option
|
|
Returns the value associated to the specified option.
Recognized options are:
|
|
|
| configure |
|
?-option ?value??...
|
|
Returns a list of options if called without arguments.
Returns the value associated to the option if called
with a single option and no value. Sets the values of
given options to the specified information.
|
|
|