Skip to content

Catalog resource

Configuration directives for the Catalog resource. Every directive is listed; value types and defaults are noted where the source provides them.

Start of the Catalog resource. At least one Catalog resource must be defined.

DB Address = <address>

This is the host address of the database server. Normally, you would specify this instead of DB Socket if the database server is on another machine. In that case, you will also specify DB Port. This directive is used only by MySQL and PostgreSQL. This directive is optional.

DB Name = <name>

This specifies the name of the database. If you use multiple catalogs (databases), you specify which one here. If you are using an external database server rather than the internal one, you must specify a name that is known to the server (i.e. you explicitly created the NGBackup tables using this name. This directive is required.

DB Port = <port>

This defines the port to be used in conjunction with DB Address to access the database if it is on another machine. This directive is used only by MySQL and PostgreSQL. This directive is optional.

DB Socket = <socket-name>

This is the name of a socket to use on the local host to connect to the database. This directive is used only by MySQL. Normally, if neither DB Socket or DB Address are specified, MySQL will use the default socket. If the DB Socket is specified, the MySQL server must reside on the same machine as the Director.

Name = <name>

The name of the Catalog. No necessary relation to the database server name. This name will be specified in the Client resource directive indicating that all catalog data for that Client is maintained in this Catalog. This directive is required.

password = <password>

This specifies the password to use when logging into the database. This directive is required.

user = <user>

This specifies what user name to use to log into the database. This directive is required.