lt_createdb

lt_createdb — creates a new LightDB database.

Synopsis

lt_createdb [connection-option...] [option...] [dbname [description]]

Description

lt_createdb is a tool to create a LightDB database.

lt_createdb is a wrapper for the createdb command. It is equivalent to creating a database using the createdb command directly. However, in a distributed environment (Canopy), it automatically creates the database on all nodes, and these databases together form a distributed cluster.

Note: Canopy is related to databases. This tool only checks the deployment status of Canopy in the LightDB database, retrieves the list of Canopy nodes from the LightDB database, and then creates a database with the same name on each node.

Options

lt_createdb accepts the following command-line arguments:

dbname

Specifies the name of the database to be created. The name must be unique among all LightDB databases in this cluster. The default is to create a database with the same name as the current system user.

-D tablespace
--tablespace=tablespace

Specifies the default tablespace for the database. (This name is processed as a double-quoted identifier.)

-e
--echo

Echo the commands that lt_createdb generates and sends to the server.

-E encoding
--encoding=encoding

Specifies the character encoding scheme to be used in this database. The character sets supported by the LightDB server are described in Section 21.3.1.

-l locale
--locale=locale

Specifies the locale to be used in this database. This is equivalent to specifying both --lc-collate and --lc-ctype.

--lc-collate=locale

Specifies the LC_COLLATE setting to be used in this database.

--lc-ctype=locale

Specifies the LC_CTYPE setting to be used in this database.

-O owner
--owner=owner

Specifies the database user who will own the new database. (This name is processed as a double-quoted identifier.)

-T template
--template=template

Specifies the template database from which to build this database. (This name is processed as a double-quoted identifier.)

--compatible-type=compatible-type

compatible type. TYPE=off: not compatible with other database features. off, mysql and oracle can be set.

--mysql-lower-case=mysql-lower-case

Whether to enable the all-lowercase feature in MySQL compatibility mode. The value is one of (1, true, on, 0, false, off), the default value is 1.

--ascii-zero-store-value=ascii-zero-store-value

Whether to store another ASCII value for ASCII ZERO. Available value range from 0 to 32 (including 0 and 32).

-V
--version

Print the lt_createdb version and exit.

-?
--help

Show help about lt_createdb command line arguments, and exit.

lt_createdb also accepts the following command-line arguments for connection parameters:

-h host
--host=host

Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket.

-p port
--port=port

Specifies the TCP port or the local Unix domain socket file extension on which the server is listening for connections.

-U username
--username=username

User name to connect as.

-w
--no-password

Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a .pgpass file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.

-W
--password

Force lt_createdb to prompt for a password before connecting to a database.

This option is never essential, since lt_createdb will automatically prompt for a password if the server demands password authentication. However, lt_createdb will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt.

--maintenance-db=dbname

Specifies the name of the database to connect to when creating the new database. If not specified, the postgres database will be used; if that does not exist (or if it is the name of the new database being created), template1 will be used. This can be a connection string. If so, connection string parameters will override any conflicting command line options.

Environment

LTDATABASE

If set, the name of the database to create, unless overridden on the command line.

LTHOST
LTPORT
LTUSER

Default connection parameters. LTUSER also determines the name of the database to create, if it is not specified on the command line or by LTDATABASE.

LT_COLOR

Specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

This utility, like most other LightDB utilities, also uses the environment variables supported by libpq (see Section 31.14).

Examples

Execute on a cn node to create a distributed database named demo:

$ lt_createdb demo

To create a non-distributed database named demo using the template1 template database on a non-cn node host eden with port 5000, here are the command-line command:

$ lt_createdb -p 5000 -h eden -T template1 -e demo