rdm-info
Database Info Utility
Synopsis
rdm-info [OPTION]… db-uri
Description
rdm-info is a command-line utility to retrieve meta information about the specified RaimaDB database for maintenance purposes.
Options
Short options can be combined into one string starting with a single '-'. Mandatory arguments to long options are mandatory for short options too. Long option arguments can also be specified in a separate argument.
| -h, --help | Display this usage information |
| --version | Display the version information |
| -q, --quiet | Quiet mode. No information will be displayed |
| --key=key | Specify the encryption key for the database ([algorithm:]passcode). The valid algorithms are xor, aes128, aes192 and aes256. The AES algorithms are only available for packages that have strong encryption support. If an algorithm is not specified, the default is aes128 for strong encryption packages and xor otherwise. |
| --docroot=path | Document root to use instead of the current working directory. The environment variable RDM_DOCROOT can also be used. (See Document Root (docroot)) |
| -a, --all | All the info available. This option implies
'--pack', '--drawers', and '--users'. |
| -d, --drawers | Request information about drawers. |
| -p, --pack | Request information about the pack. |
| -u, --users | Request information about users. |
| -t, --trans=count_or_range | Request information about transactions. One or two
numbers can be specified separated by comma.
Specify 'count' or 'from,to'. |
| --log-level=level | Set the log level ('--log-level=all', '--log-level=error', '--log-level=warning', '--log-level=info', '--log-level=mesg', or a number (5-99)) - the default is '99') |
| --err-level=level | Set the error level (all, error, warning, info, mesg,or a number (5-99)) - the default is info) |
| --use-ssl | Use SSL for remote connections |
| db-uri | An RDM database name or URI. See Database Identifier (db-uri) for more information. |
Comments
Specifying a database name will by default open the database in the current working directory. However, specifying a database URI will open the database on a remote TFServer. Examples of database name or URIs:
'MY_DB', 'tfs-tcp://localhost:21553/MY_DB', 'tfs-shm://MY_TFS/MY_DB'.
Information about the pack include the following information for each pack file: The pack file name, the size of the pack file, whether the file have been memory mapped, the hold count, and whether the file may be needed after a system crash.
Information about the drawers include the following information for each drawer: The drawer ID (in base 16), the minimum and maximum pack file name for which content for this drawer is located, the used total for tree entries, and the space "in use" in the pack files.
Please note that the space usage is an estimate since the tree-header (the first part of B-tree or R-tree nodes excluding the key) does not have a static size (re-encoding after vacuuming may change its size).
This utility is uses the rdm_dbGetInfo() function to retrieve the database meta information in JSON format.