Postgres Pro Standard : Документация: 16: clusterdb : Компания Postgres Professional

clusterdb
Пред.	Наверх	Клиентские приложения Postgres Pro	Начало	След.

clusterdb

clusterdb — кластеризовать базу данных Postgres Pro

Синтаксис

clusterdb [параметр-подключения...] [ --verbose | -v ] [ --table | -t таблица ] ... [dbname]

clusterdb [параметр-подключения...] [ --verbose | -v ] --all | -a

Описание

clusterdb это приложение для повторной кластеризации таблиц базы данных Postgres Pro. Утилита находит ранее кластеризованные таблицы и проводит операцию на основании последнего использованного индекса. Затрагиваются лишь ранее кластеризованные таблицы.

clusterdb — это обёртка для SQL-команды CLUSTER. Кластеризация баз данных с её помощью по сути не отличается от выполнения того же действия при обращении к серверу другими способами.

Параметры

clusterdb принимает следующие аргументы командной строки:

-a --all: Кластеризовать все базы данных.
[-d] dbname [--dbname=]dbname: Указывает имя базы данных для кластеризации, когда не используется параметр -a/--all. Если это указание отсутствует, имя базы определяется переменной окружения PGDATABASE. Если эта переменная не установлена, именем базы будет имя пользователя, указанное для подключения. В аргументе имя_бд может задаваться строка подключения. В этом случае параметры в строке подключения переопределяют одноимённые параметры, заданные в командной строке.
-e --echo: Вывести команды к серверу, генерируемые при выполнении clusterdb.
-q --quiet: Подавлять вывод сообщений о прогрессе выполнения.
-t таблица --table=таблица: Кластеризовать таблицу. Возможно множественное использование параметра -t.
-v --verbose: Вывести подробную информацию во время процесса.
-V --version: Вывести версию clusterdb и прервать дальнейшее выполнение.
-? --help: Вывести справку по аргументам команды clusterdb.

clusterdb также принимает из командной строки параметры подключения:

-h сервер --host=сервер

Указывает имя компьютера, на котором работает сервер. Если значение начинается с косой черты, оно определяет каталог Unix-сокета.

-p порт --port=порт

Указывает TCP-порт или расширение файла локального Unix-сокета, через который сервер принимает подключения.

-U имя_пользователя --username=имя_пользователя

Имя пользователя, под которым производится подключение.

-w --no-password

Не выдавать запрос на ввод пароля. Если сервер требует аутентификацию по паролю и пароль не доступен с помощью других средств, таких как файл .pgpass, попытка соединения не удастся. Этот параметр может быть полезен в пакетных заданиях и скриптах, где нет пользователя, который вводит пароль.

-W --password

Принудительно запрашивать пароль перед подключением к базе данных.

Это несущественный параметр, так как clusterdb запрашивает пароль автоматически, если сервер проверяет подлинность по паролю. Однако чтобы понять это, clusterdb лишний раз подключается к серверу. Поэтому иногда имеет смысл ввести -W, чтобы исключить эту ненужную попытку подключения.

--maintenance-db=dbname

Когда используется ключ -a/--all, выполняется подключение к указанной базе данных для определения списка подлежащих кластеризации баз данных. Если ключ не указан, будет выбрана база postgres, а если она не существует — template1. В данном аргументе может задаваться строка подключения. В этом случае параметры в строке подключения переопределяют одноимённые параметры, заданные в командной строке. Кроме того, все параметры в строке подключения, за исключением имени базы, будут использоваться и при подключении к другим базам данных.

Переменные окружения

PGDATABASE PGHOST PGPORT PGUSER: Параметры подключения по умолчанию
PG_COLOR: Выбирает вариант использования цвета в диагностических сообщениях. Возможные значения: always (всегда), auto (автоматически) и never (никогда).

Эта утилита, как и большинство других утилит Postgres Pro, также использует переменные среды, поддерживаемые libpq (см. Раздел 33.15).

Диагностика

В случае возникновения трудностей, обратитесь к CLUSTER и psql. Переменные окружения и параметры подключения по умолчанию libpq будут применены при запуске утилиты, это следует учитывать при диагностике.

Примеры

Для кластеризации базы данных test:

$ clusterdb test

Для кластеризации отдельной таблицы foo базы данных xyzzy:

$ clusterdb --table=foo xyzzy

См. также

CLUSTER

Пред.	Наверх	След.
Клиентские приложения Postgres Pro	Начало	createdb

clusterdb
Prev	Up	Postgres Pro Client Applications	Home	Next

clusterdb

clusterdb — cluster a Postgres Pro database

Synopsis

clusterdb [connection-option...] [ --verbose | -v ] [ --table | -t table ] ... [dbname]

clusterdb [connection-option...] [ --verbose | -v ] --all | -a

Description

clusterdb is a utility for reclustering tables in a Postgres Pro database. It finds tables that have previously been clustered, and clusters them again on the same index that was last used. Tables that have never been clustered are not affected.

clusterdb is a wrapper around the SQL command CLUSTER. There is no effective difference between clustering databases via this utility and via other methods for accessing the server.

Options

clusterdb accepts the following command-line arguments:

-a --all: Cluster all databases.
[-d] dbname [--dbname=]dbname: Specifies the name of the database to be clustered, when -a/--all is not used. If this is not specified, the database name is read from the environment variable PGDATABASE. If that is not set, the user name specified for the connection is used. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.
-e --echo: Echo the commands that clusterdb generates and sends to the server.
-q --quiet: Do not display progress messages.
-t table --table=table: Cluster table only. Multiple tables can be clustered by writing multiple -t switches.
-v --verbose: Print detailed information during processing.
-V --version: Print the clusterdb version and exit.
-? --help: Show help about clusterdb command line arguments, and exit.

clusterdb 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 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 clusterdb to prompt for a password before connecting to a database.

This option is never essential, since clusterdb will automatically prompt for a password if the server demands password authentication. However, clusterdb 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

When the -a/--all is used, connect to this database to gather the list of databases to cluster. If not specified, the postgres database will be used, or if that does not exist, template1 will be used. This can be a connection string. If so, connection string parameters will override any conflicting command line options. Also, connection string parameters other than the database name itself will be re-used when connecting to other databases.

Environment

PGDATABASE PGHOST PGPORT PGUSER: Default connection parameters
PG_COLOR: Specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

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

Diagnostics

In case of difficulty, see CLUSTER and psql for discussions of potential problems and error messages. The database server must be running at the targeted host. Also, any default connection settings and environment variables used by the libpq front-end library will apply.

Examples

To cluster the database test:

$ clusterdb test

To cluster a single table foo in a database named xyzzy:

$ clusterdb --table=foo xyzzy

clusterdb

Синтаксис

Описание

Параметры

Переменные окружения

Диагностика

Примеры

См. также

clusterdb

Synopsis

Description

Options

Environment

Diagnostics

Examples

See Also