Mini SQL 2.0
User Guide
User Guide
Standard Programs and Utilities
msql [-h host] [-f confFile] database
Options
| -h | Specify a remote hostname or IP address on which the mSQL server is running. The default is to connect to a server on the localhost using a UNIX domain socket rather than TCP/IP (which gives better performance). |
| -f | Specify a non-default configuration file to be loaded. The default action is to load the standard configuration file located in INST_DIR/msql.conf (usually /usr/local/Hughes/msql.conf). Please see the msqlLoadConfigFile entry in the API section of this manual to understand the method used to select the config file from the specified file name. |
The mSQL monitor is an interactive interface to the mSQL server. It allows you to submit SQL commands directly to the server. Any valid mSQL syntax can be entered at the prompt provided by the mSQL monitor. For example, by typing a "create table" clause at the mSQL monitor prompt you can instruct the database server to create the specified table. The mSQL monitor is intended to be used as a mechanism for creating your database tables and for submitting ad-hoc SQL queries to the server. It is not intended to be used for client application development other than for testing queries before they are coded into your applications.
Control of the monitor itself is provided by four internal
commands. Each command is comprised of a backslash followed by a single
character. The available commands are
| \q | Quit (also achieved by entering Control-D) |
| \g | Go (Send the query to the server) |
| \e | Edit (Edit the previous query) |
| \p | Print (Print the query buffer) |
relshow [-h host] [-f confFile] [database [rel [idx] ] ]
Options
| -h | Specify a remote hostname or IP address on which the mSQL server is running. The default is to connect to a server on the localhost using a UNIX domain socket rather than TCP/IP (which gives better performance). |
| -f | Specify a non-default configuration file to be loaded. The default action is to load the standard configuration file located in INST_DIR/msql.conf (usually /usr/local/Hughes/msql.conf). Please see the msqlLoadConfigFile entry in the API section of this manual to understand the method used to select the config file from the specified file name. |
Relshow is used to display the structure of the contents of mSQL databases. If no arguments are given, relshow will list the names of the databases currently defined. If a database name is given it will list the tables defined in that database. If a table name is also given then it will display the structure of the table (i.e. field names, types, lengths etc).
If an index name is provided along with the database and
table names, relshow will display the structure of the specified index
including the type of index and the fields that comprise the index.
msqladmin [-h host] [-f confFile] [-q] Command
Options
| -h | Specify a remote hostname or IP address on which the mSQL server is running. The default is to connect to a server on the localhost using a UNIX domain socket rather than TCP/IP (which gives better performance). |
| -f | Specify a non-default configuration file to be loaded. The default action is to load the standard configuration file located in INST_DIR/msql.conf (usually /usr/local/Hughes/msql.conf). Please see the msqlLoadConfigFile entry in the API section of this manual to understand the method used to select the config file from the specified file name. |
| -q | Put msqladmin into quiet mode. If this flag is specified, msqladmin will not prompt the user to verify dangerous actions (such as dropping a database). |
msqladmin is used to perform administrative operations
on an mSQL database server. Such tasks include the creation of databases,
performing server shutdowns, etc. The available commands for msqladmin
are
| create db_name | Creates a new database called db_name. |
| drop db_name | Removes the database called db_name from the server. This will also delete all data contained in the database! |
| shutdown | Terminates the mSQL server. |
| reload | Forces the server to reload ACL information. |
| version | Displays version and configuration information about the currently running server. |
| stats | Displays server statistics. |
| copy fromDB toDB | Copies the contents of the database specified as the fromDB into a newly created database called toDB. If the toDB already exists an error will be returned. This command provides a simple mechanism for creating a backup copy of a data for use as a test or development environment. |
| move fromDB toDB | Renames an existing database called fromDB to toDB. The data is not modified in any way. |
Note :
most administrative functions can only be executed by the user specified
in the run-time configuration as the admin user. They can also only be
executed from the host on which the server process is running (e.g. you
cannot shutdown a remote server process).
msqldump [-h host] [-f confFile] [-c] [-v] database [table]
Options
| -h | Specify a remote hostname or IP address on which the mSQL server is running. The default is to connect to a server on the localhost using a UNIX domain socket rather than TCP/IP (which gives better performance). |
| -f | Specify a non-default configuration file to be loaded. The default action is to load the standard configuration file located in INST_DIR/msql.conf (usually /usr/local/Hughes/msql.conf). Please see the msqlLoadConfigFile entry in the API section of this manual to understand the method used to select the config file from the specified file name. |
| -c | Include column names in INSERT commands generated by the dump. |
| -v | Run in verbose mode. This will display details such as connection results, etc. |
msqldump produces an ASCII text file containing valid
SQL commands that will recreate the table or database dumped when piped
through the mSQL monitor program. The output will include all CREATE TABLE
commands required to recreate the table structures, CREATE INDEX commands
to recreate the indices, and INSERT commands to populate the tables with
the data currently contained in the tables. If sequences are defined on
any of the tables being dumped, a CREATE SEQUENCE command will be generated
to ensure the sequence is reset to its current value.
msqlexport [-h host] [-f conf] [-v] [-s Char] [-q Char] [-e Char] database table
Options
| -h | Specify a remove hostname or IP address on which the mSQL server is running. The default is to connect to a server on the localhost using a UNIX domain socket rather than TCP/IP (which gives better performance). |
| -f | Specify a non-default configuration file to be loaded. The default action is to load the standard configuration file located in INST_DIR/msql.conf (usually /usr/local/Hughes/msql.conf). Please see the msqlLoadConfigFile entry in the API section of this manual to understand the method used to select the config file from the specified file name. |
| -v | Verbose mode. |
| -s | Use the character Char as the separation character. The default is a comma. |
| -q | Quote each value with the specified character. |
| -e | Use the specified Char as the escape character. The default is \ |
msqlexport produces an ASCII export of the data from the specified table. The output produced can be used as input to other programs such as spreadsheets. It has been designed to be as flexible as possible. The user may specify the character to use to separate the fields, the character to use to escape the separator character if it appears in the data, and whether the data should be quoted and if so what character to use as the quote character. The output is sent to stdout with one data row per line.
An example use of msqlexport would be to create a Comma
Separated Values (CSV) file to be imported into a popular spreadsheet application
such as Microsoft Excel. The CSV format uses a comma to separate data fields
and quotation marks to quote the individual values. If a value contains
a quotation mark, it is escaped by prefixing it with another quotation
mark. To generate a CSV representation of a table called staff in the company
database, the msqlexport command below would be used.
msqlimport [-h host] [-f conf] [-v] [-s Char] [-q Char] [-e Char] database table
Options
| -h | Specify a remote hostname or IP address on which the mSQL server is running. The default is to connect to a server on the localhost using a UNIX domain socket rather than TCP/IP (which gives better performance). |
| -f | Specify a non-default configuration file to be loaded. The default action is to load the standard configuration file located in INST_DIR/msql.conf (usually /usr/local/Hughes/msql.conf). Please see the msqlLoadConfigFile entry in the API section of this manual to understand the method used to select the config file from the specified file name. |
| -v | Verbose mode. |
| -s | Use the character Char as the separation character. The default is a comma. |
| -q | Remove quotes around field values if they exist (the specified character is the quote character). |
| -e | Use the specified Char as the escape character. The default is \ |
msqlimport loads a flat ASCII data file into an mSQL database table. The file can be formatted using any character as the column separator. When passed through msqlimport, each line of the text file will be loaded as a row in the database table. The separation character, as specified by the -s flag, will be used to split the line of text into columns. If the data uses a specific character to escape any occurrence of the separation character in the data, the escape character can be specified with the -e flag and will be removed from the data before it is inserted. Some data formats (such as the CSV format) will enclose an entire value in quotation marks. The -q option can be used to indicate such a format and to specify the character being used for quoting.
To import a file formatted in the Comma Separated Values
format (CSV) into a table called staff in the company database, the msqlimport
command below would be used.