Go to the first, previous, next, last section, table of contents.

MySQL configuration file

Used by the mysql package (mysql.pm). It defines which base must be used and parameters for the connection.

`base (mandatory)'

Name of the MySQL database to connect. Equivalent of base parameter in mysql command.

`host (optional, default localhost)'

Hostname of the machine where the database is located. May be omitted if the database is on the same machine as the application. Equivalent of the --host option of the mysql command.

`port (optional, default 3306)'

Port number of the MySQL server. May be omitted if the port number is the standard MySQL port number. Equivalent of the --port option of the mysql command.

`unixport (optional, default /var/lib/mysql/mysql.sock)'

Socket file used for communications between the server and the client when they reside on the same machine. Equivalent of the --socket option of the mysql command.

`user (optional)'

Name of the user used to connect to the MySQL database, if the authentication system is active. If it is deactivated (--skip-grant-tables) this instruction may be omitted. Equivalent of the --user option of the mysql command.

`passwd (optional)'

Password of the user used to connect to the MySQL database, if the authentication system is active. If it is deactivated (--skip-grant-tables) this instruction may be omitted. Equivalent of the --password option of the mysql command.

`auto_created (optional)'

If this instruction exists and its value is set to yes, the field named created is treated in a special way in every table. It must be of type datetime not null. Each time a record is inserted using the mysql package, if the created field does not contain any value, it is set with the current date.

`hook (optional)'

The fully qualified name of the package that implements the integration of a full text search engine. At present these values are available:

`Catalog::tools::hook_fulcrum'

See section Hook Fulcrum configuration file.

Here is an example configuration file:

#
# MySQL client configuration file
#
#
# Name of the database to connect. Mandatory.
#
base = interbat
#
# Host name. Comment if using localhost.
#
#host = enkidu
#
# Port number. Comment if using default.
#
port = 8301
#
# File name of the socket for local communications. Comment if
# using a remote host or if mysql does not support non-TCP/IP 
# communications on local host.
#
unix_port = /usr/local/lib/interbat/db/8401.sock
#
# User name. Comment if authentification is off.
#
#user = myname
#
# Password. Comment if authentification is off.
#
#passwd = mypass
#
# Uncomment to trigger special handling of the created field.
# If active, field whose name is 'created' will be filled with the 
# current date during insert.
# 
auto_created = yes
#
# Every update/delete/insert is passed to this hook
#
hook = Catalog::tools::hook_fulcrum

Go to the first, previous, next, last section, table of contents.