coredb

Documentation

Overview

Coredb is used for maintenance of the core (SRD) database, including loading local items to the database and saving core data to files.

SYNOPSIS

(If using the full GMA core tool suite)

gma go coredb [options (see below) ...]

(Otherwise)

coredb -h
coredb -help
coredb [-debug flags] [-export file] [-filter [!]re] [-ignore-case] [-import file] [-log file] [-preferences file] [-srd] [-type list]
coredb [-D flags] [-e file] [-f [!]re] [-I] [-i file] [-l file] [-preferences file] [-srd] [-t list]

OPTIONS

The command-line options described below have a long form (e.g., -log) and a short form (e.g., -l) which are equivalent. In either case, the option may be introduced with either one or two hyphens (e.g., -log or --log).

Options which take parameter values may have the value separated from the option name by a space or an equals sign (e.g., -log=path or -log path), except for boolean flags which may be given alone (e.g., -I) to indicate that the option is set to “true” or may be given an explicit value which must be attached to the option with an equals sign (e.g., -I=true or -I=false).

You may not combine multiple single-letter options into a single composite argument, (e.g., the options -I and -h would need to be entered as two separate options, not as -Ih).

-D, -debug flags
    Adds debugging messages to coredb's output. The flags
    value is a comma-separated list of debug flag names, which
    may be any of the following:

    all      Enable all debugging messages
    none     Disable all debugging messages
    queries  Database queries
    misc     Miscellaneous debugging messages

-e, -export file
    Write database entries to the named file.

-f, -filter [!]regex
    When importing or exporting, only include entries matching the regular expression
    regex. If regex begins with a '!' character, all entries which do NOT match the
    expression are included.

    The regex is matched against the Code and Name fields. If either matches, then
    the entry is included (or excluded). For languages, the Language field is checked.
    For monsters in the bestiary, the Code and Species fields are checked.

-h, -help
    Print a command summary and exit.

-I, -ignore-case
  Regex matching (-f/-filter option) is done irrespective of case.

-i, -import file
    Read the contents of the file into the database.

-l, -log file
    Write log messages to the named file instead of stdout.
    Use "-" for the file to explicitly send to stdout.

-preferences file
    Use a custom profile instead of the default.

-srd
    Normally, all entries imported by coredb into the database are assumed
    to be local entries added for the user's campaign. Entries exported to
    a file will only be local entries, ignoring the SRD entries initially
    loaded from community data by "gma initdb". With this option, the inverse
    is true: only the SRD entries will be exported and anything imported will
    be assumed to be non-local SRD data.

-t, -type list
    Entries exported will include only database entries of the specified
    type(s). When importing, any records in the import file which are not
    of the specified type(s) will be skipped over.

    The list parameter is a comma-separated list of type names, which
    may be any of the following:

    all         All entry types
    none        Reset list to empty before adding more types
    bestiary    Creatures
    class[es]   Classes
    feat[s]     Feats
    language[s] Languages
    skill[s]    Skills
    spell[s]    Spells
    weapon[s]   Weapons