showdb

Function

Description

showdb displays a table with the names, contents and access methods of the sequence databases configured for your EMBOSS installation.

Usage

Command line arguments


Input file format

None.

Output file format

The output is a simple table.

Type 'P' indicates that this is a Protein database.

Type 'N' indicates that this is a Nucleic database.

'OK' under ID, Qry or All indicates that that access method can be used on this database. A '-' indicates that you cannot access this database in that way.

Note that 'OK' does not mean that the database is working correctly. It simply means that showdb has read the database definition correctly and that this method of access to the database should be possible.

If you are setting up a new database, then you should check that it works correctly by extracting entries from it using seqret.

When the -html qualifier is specified, then the output will be wrapped in HTML tags, ready for inclusion in a Web page. Note that tags such as <HTML>, <BODY>, </BODY> and </HTML> are not output by this program as the table of databases is expected to form only part of the contents of a web page - the rest of the web page must be supplied by the user.

Data files

The databases are specified in the files "emboss.defaults" for site wide definitions, and "~/.embossrc" for the user's own settings.

Notes

EMBOSS provides excellent database support. All the common sequence formats you are likely to come across are supported. There are three basic levels of database query with different ways to search for and retrieve entries: entry A single entry specified by database ID or accession number is retrieved. For example "embl:x13776". query One or more entries matching a wildcard string in the USA are retrieved (this can be slow for some methods). For example you can specify all of the human PAX proteins in SWISS_PROT by: swissprot:pax*_human. all All entries are read sequentially from a database. For example to specify all entries in the database use embl:*.

One or more query levels may be available for a database depending on the database in question and how it has been setup and indexed. Each database and access method must be configured for it to be available for use. This involves editing one of the EMBOSS configuration files, either your own personal .embossrc or the installation-wide emboss.default file. The emboss.default file will typically contain the definitions of the test databases (tsw, tembl, tpir, etc) used in the usage examples for the application documentation and serve as example database definitions. For more information, see the EMBOSS Administrators Manual. You can run showdb to see the databases and access methods that have been configured successfully.

References

None.

Warnings

Where the string OK is given next to a database is listed in showdb output, this means showdb has read the database definition correctly and that this access method is in principle possible, in other words, the database has been configured correctly.. It does not mean that the database or access method are available or working correctly. You should check things are ok by running, for example, seqret to retrieve an entry.

Diagnostic Error Messages

"The database 'xyz' does not exist" You have supplied the name of a database with the -database qualifier, but that database does not exist as far as EMBOSS is concerned.

Exit status

It always exits with status 0, unless the above diagnostic message is displayed.

Known bugs

None noted.

Author(s)

History

Target users

Comments