The eyedbadmin command is used for most of the EyeDB administration operations. It is installed in /usr/bin for standard EyeDB installations.
The eyedbadmin command has the following syntax:
eyedbadmin topic command options...
where
topic
is one of the subsystem adressed by the command (database, user, index...) and
command
is the command relative to this subsystem.
Help on the eyedbadmin command can be obtained with the help command for general help (Example 1.1, “eyedbadmin help”) or topic help (Example 1.2, “eyedbadmin help on topic”):
Example 1.1. eyedbadmin help
eyedbadmin help
eyedbadmin usage:
eyedbadmin --help
eyedbadmin --help-eyedb-options
eyedbadmin TOPIC --help
eyedbadmin TOPIC COMMAND --help
eyedbadmin TOPIC COMMAND OPTIONS
where TOPIC is one of the following:
database | db
datafile | dtf
dataspace | dsp
user | usr
index | idx
Example 1.2. eyedbadmin help on topic
eyedbadmin database help
eyedbadmin database usage:
eyedbadmin database --help
eyedbadmin database COMMAND OPTIONS
where COMMAND is one of the following:
create
delete
list
move
copy
rename
defaccess
export
import
setobjcount
getobjcount
setlogsize
getlogsize
eyedbadmin accepts a list of options shared by all the topics, described in Example 1.3, “eyedbadmin help on topic”.
Example 1.3. eyedbadmin help on topic
eyedbadmin --help-eyedb-options
Common Options:
-U USER|@, --user=USER|@ User name
-P [PASSWD], --passwd[=PASSWD] Password
--host=HOST eyedbd host
--port=PORT eyedbd port
--inet Use the tcp_port variable if port is not set
--dbm=DBMFILE EYEDBDBM database file
--conf=CONFFILE Client Configuration file
--server-conf=CONFFILE Server Configuration file (used for local opening)
--default-file-mask=MASK Default file mask
--default-file-group=GROUP Default file group
--maximum-server-memory-size=SIZE Maximum server memory size (in Mb)
--logdev=LOGFILE Output log file
--logmask=MASK Output log mask
--logdate=on|off Control date display in output log
--logtimer=on|off Control timer display in output log
--logpid=on|off Control pid display in output log
--logprog=on|off Control progname display in output log
--error-policy=VALUE Control error policy: status|exception|abort|stop|echo
--trans-def-mag=MAGORDER Default transaction magnitude order
--arch Display the client architecture
-v, --version Display the version
--help-logmask Display logmask usage
--help-eyedb-options Display this message
The following options are the most usefull:
--user=user
: specifies the user name for EyeDB authentication; if user is "@", then the Unix user name is used
--passwd=passwd
: specifies the user password for EyeDB authentication
--host=host
: specifies the host name of the machine running the EyeDB server
--port=port
: specifies the TCP port number for a TCP connection to the EyeDB server
A set of shortcuts have been defined for eyedbadmin most used topics and subcommands. These shortcuts are symbolic links, created at installation time and located in binaries installation directories. Shorcuts can be used as any shell command and accept the same arguments and options as their eyedbadmin equivalents.
The list of eyedbadmin shortcuts is the following:
Table 1.1. List of eyedbadmin shortcuts
| Shortcut | eyedbadmin equivalent |
|---|---|
| eyedb_dbcreate | eyedbadmin database create |
| eyedb_dbdelete | eyedbadmin database delete |
| eyedb_dblist | eyedbadmin database list |
| eyedb_dbrename | eyedbadmin database rename |
| eyedb_dbexport | eyedbadmin database export |
| eyedb_dbimport | eyedbadmin database import |
| eyedb_dtfcreate | eyedbadmin datafile create |
| eyedb_dtfdelete | eyedbadmin datafile delete |
| eyedb_dtflist | eyedbadmin datafile list |
| eyedb_dspcreate | eyedbadmin dataspace create |
| eyedb_dspdelete | eyedbadmin dataspace delete |
| eyedb_dsplist | eyedbadmin dataspace list |
| eyedb_useradd | eyedbadmin user add |
| eyedb_userdelete | eyedbadmin user delete |
| eyedb_userlist | eyedbadminuser list |
| eyedb_userpasswd | eyedbadmin user passwd |