create_db

Creates a new database and its associated configuration file for use with other vcluster commands.

Creates a new database and its associated configuration file for use with other vcluster commands.

Syntax

vcluster create_db { options }

Required options

--catalog-path string: The absolute path to the catalog directory.

--data-path string: The absolute path to the data directory. This should be the same for all nodes in the database.

{ -d | --db-name } string: The name of the database. You should only use this option if you want to override the database name in your configuration file. This string must conform to the format used for database names.

--hosts strings: A comma-separated list of hosts in database.

Eon options

The following options are required for creating Eon Mode databases, the database mode primarily supported by vcluster:

--communal-storage-location string: [Eon only] The absolute path of your communal storage location.

--shard-count int: [Eon only] The number of shards in the database.

Options

--broadcast

Configures Spread to use UDP broadcast traffic between nodes on the same subnet. Do not combine this option with --point-to-point.

Up to 80 Spread daemons are supported by broadcast traffic. You can exceed the 80-node limit by using large cluster mode, which only installs the Spread daemon on a subset of your nodes.

Default: Disabled

--cert-file string: The absolute path to the certificate file. If you specify this option, you must also specify --key-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.

{ -c | --config } string: The path to write the configuration file.
Default: /opt/vertica/config/vertica_cluster.yaml

--config-param PARAMETER=VALUE[,...]

A comma-separated list of PARAMETER=VALUE pairs. Parameters specified with this option override the ones in configuration files, if any, and take the following parameters:

AWSAuth
AWSEndpoint
AWSEnableHttps
AWSRegion

--depot-path string: [Eon only] The absolute path to depot directory.

--depot-size string: [Eon only] Size of depot in one of the following formats:

integer{K|M|G|T}, where K is kilobytes, M is megabytes, G is gigabytes, and T is terabytes.
integer%, which expresses the depot size as a percentage of the total disk size.

--force-cleanup-on-failure

Deletes directories created by create_db upon failure.

--force-overwrite-file

Overwrites the current configuration file, if any.

--force-removal-at-creation

Deletes existing database directories before attempting to create the database.

--get-aws-credentials-from-env-vars

[Eon only] Retrieves AWS credentials from the following environment variables:

$AWS_ACCESS_KEY_ID
$AWS_SECRET_ACCESS_KEY

{ -h | --help }: Prints help text.

--ipv6: Whether the hosts use IPv6 addresses. Hostnames resolve to IPv4 by default.

--key-file string: Path to the key file. If you specify this option, you must also specify --cert-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.

--large-cluster int: Enables the large cluster layout and sets the number of control nodes. The effect of this option is slightly different on Enterprise and Eon databases. For details, see Enabling large cluster.
Default: -1 (Disabled)
--license string: The absolute path to a license file. The path to this license must be the same on all nodes.

{ -l | --log-path } string: The absolute path for debug logs.
Default: /opt/vertica/log/vcluster.log

{ -p | --password } string: The database password.

--password-file string: The absolute path to a file containing the database password.
If you pass a dash(-) (that is, `--password-file -`), the password is read from STDIN.

Important
Your database password cannot include single quotes.

--point-to-point

Configures Spread to use point-to-point communication between all Vertica nodes. You should use this option if your nodes are not on the same subnet and for virtual environments. Do not combine this option with --broadcast.

Up to 80 Spread daemons are supported by point-to-point communication. You can exceed the 80-node limit by using large cluster mode, which only installs the Spread daemon on a subset of your nodes.

Default: Enabled

--read-password-from-prompt: Prompts the user to enter the password.

--skip-package-install: Skips installing the packages in /opt/vertica/packages.
Default: Disabled
--startup-timeout int: The time, in seconds, to wait for the nodes to start after database creation.
Default: 300

--verbose: Shows the details of VCluster run in the console.

Examples

Create a database with the nodes 192.0.2.0, 192.0.2.1, and 192.0.2.2 with the password in /password.txt:

$ vcluster create_db --db-name vertica_db \
    --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
    --catalog-path /data --data-path /data \
    --password-file password.txt