Search PostgreSQL documentation

oauth_client_idCommand-line ToolsPG18oauth_client_id An OAuth 2.0 client identifier, as issued by the authorization server. If the PostgreSQL server requests an OAuth token for the connection (and if no custom OAuth hook is ins…Database Connection Control Functions › Parameter Key Words oauth_client_secretCommand-line ToolsPG18oauth_client_secret The client password, if any, to use when contacting the OAuth authorization server. Whether this parameter is required or not is determined by the OAuth provider; "public…Database Connection Control Functions › Parameter Key Words oauth_issuerCommand-line ToolsPG18oauth_issuer The HTTPS URL of a trusted issuer to contact if the server requests an OAuth token for the connection. This parameter is required for all OAuth connections; it should exactly ma…Database Connection Control Functions › Parameter Key Words oauth_scopeCommand-line ToolsPG18oauth_scope The scope of the access request sent to the authorization server, specified as a (possibly empty) space-separated list of OAuth scope identifiers. This parameter is optional and …Database Connection Control Functions › Parameter Key Words optionsCommand-line ToolsPG18options Specifies command-line options to send to the server at connection start. For example, setting this to -c geqo=off or --geqo=off sets the session's value of the geqo parameter to off…Database Connection Control Functions › Parameter Key Words passfileCommand-line ToolsPG18passfile Specifies the name of the file used to store passwords (see Section 32.16). Defaults to ~/.pgpass, or %APPDATA%\postgresql\pgpass.conf on Microsoft Windows. (No error is reported if…Database Connection Control Functions › Parameter Key Words passwordCommand-line ToolsPG18password Password to be used if the server demands password authentication.Database Connection Control Functions › Parameter Key Words pg_amcheckCommand-line ToolsPG18pg_amcheck pg_amcheck — checks for corruption in one or more PostgreSQL databases Synopsis pg_amcheck [option...] [dbname]pg_amcheck pg_amcheck --allCommand-line ToolsPG18-a--all Check all databases, except for any excluded via --exclude-database.pg_amcheck › Options pg_amcheck --checkuniqueCommand-line ToolsPG18--checkunique For each index with unique constraint checked, verify that no more than one among duplicate entries is visible in the index using amcheck's checkunique option.pg_amcheck › Options pg_amcheck --database=patternCommand-line ToolsPG18-d pattern--database=pattern Check databases matching the specified pattern, except for any excluded by --exclude-database. This option can be specified more than once.pg_amcheck › Options pg_amcheck --echoCommand-line ToolsPG18-e--echo Echo to stdout all SQL sent to the server.pg_amcheck › Options pg_amcheck --endblock=blockCommand-line ToolsPG18--endblock=block End checking at the specified block number. An error will occur if the table relation being checked has fewer than this number of blocks. This option does not apply to index…pg_amcheck › Options pg_amcheck --exclude-database=patternCommand-line ToolsPG18-D pattern--exclude-database=pattern Exclude databases matching the given pattern. This option can be specified more than once.pg_amcheck › Options pg_amcheck --exclude-index=patternCommand-line ToolsPG18-I pattern--exclude-index=pattern Exclude indexes matching the specified pattern. This option can be specified more than once. This is similar to the --exclude-relation option, except that i…pg_amcheck › Options pg_amcheck --exclude-relation=patternCommand-line ToolsPG18-R pattern--exclude-relation=pattern Exclude relations matching the specified pattern. This option can be specified more than once. As with --relation, the pattern may be unqualified, schema…pg_amcheck › Options pg_amcheck --exclude-schema=patternCommand-line ToolsPG18-S pattern--exclude-schema=pattern Exclude tables and indexes in schemas matching the specified pattern. This option can be specified more than once. As with --schema, the pattern may be dat…pg_amcheck › Options pg_amcheck --exclude-table=patternCommand-line ToolsPG18-T pattern--exclude-table=pattern Exclude tables matching the specified pattern. This option can be specified more than once. This is similar to the --exclude-relation option, except that it…pg_amcheck › Options pg_amcheck --exclude-toast-pointersCommand-line ToolsPG18--exclude-toast-pointers By default, whenever a toast pointer is encountered in a table, a lookup is performed to ensure that it references apparently-valid entries in the toast table. These…pg_amcheck › Options pg_amcheck --heapallindexedCommand-line ToolsPG18--heapallindexed For each index checked, verify the presence of all heap tuples as index tuples in the index using amcheck's heapallindexed option.pg_amcheck › Options pg_amcheck --helpCommand-line ToolsPG18-?--help Show help about pg_amcheck command line arguments, and exit.pg_amcheck › Options pg_amcheck --host=hostnameCommand-line ToolsPG18-h hostname--host=hostname 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.pg_amcheck › Options pg_amcheck --index=patternCommand-line ToolsPG18-i pattern--index=pattern Check indexes matching the specified pattern, unless they are otherwise excluded. This option can be specified more than once. This is similar to the --relation opt…pg_amcheck › Options pg_amcheck --install-missing=schemaCommand-line ToolsPG18--install-missing--install-missing=schema Install any missing extensions that are required to check the database(s). If not yet installed, each extension's objects will be installed into the…pg_amcheck › Options pg_amcheck --jobs=numCommand-line ToolsPG18-j num--jobs=num Use num concurrent connections to the server, or one per object to be checked, whichever is less. The default is to use a single connection.pg_amcheck › Options pg_amcheck --maintenance-db=dbnameCommand-line ToolsPG18--maintenance-db=dbname Specifies a database or connection string to be used to discover the list of databases to be checked. If neither --all nor any option including a database pattern is …pg_amcheck › Options pg_amcheck --no-dependent-indexesCommand-line ToolsPG18--no-dependent-indexes By default, if a table is checked, any btree indexes of that table will also be checked, even if they are not explicitly selected by an option such as --index or --rel…pg_amcheck › Options pg_amcheck --no-dependent-toastCommand-line ToolsPG18--no-dependent-toast By default, if a table is checked, its toast table, if any, will also be checked, even if it is not explicitly selected by an option such as --table or --relation. This …pg_amcheck › Options pg_amcheck --no-passwordCommand-line ToolsPG18-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 wi…pg_amcheck › Options pg_amcheck --no-strict-namesCommand-line ToolsPG18--no-strict-names By default, if an argument to --database, --table, --index, or --relation matches no objects, it is a fatal error. This option downgrades that error to a warning.pg_amcheck › Options pg_amcheck --on-error-stopCommand-line ToolsPG18--on-error-stop After reporting all corruptions on the first page of a table where corruption is found, stop processing that table relation and move on to the next table or index. Note that …pg_amcheck › Options pg_amcheck --parent-checkCommand-line ToolsPG18--parent-check For each btree index checked, use amcheck's bt_index_parent_check function, which performs additional checks of parent/child relationships during index checking. The default i…pg_amcheck › Options pg_amcheck --passwordCommand-line ToolsPG18-W--password Force pg_amcheck to prompt for a password before connecting to a database. This option is never essential, since pg_amcheck will automatically prompt for a password if the serve…pg_amcheck › Options pg_amcheck --port=portCommand-line ToolsPG18-p port--port=port Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.pg_amcheck › Options pg_amcheck --progressCommand-line ToolsPG18-P--progress Show progress information. Progress information includes the number of relations for which checking has been completed, and the total size of those relations. It also includes t…pg_amcheck › Options pg_amcheck --relation=patternCommand-line ToolsPG18-r pattern--relation=pattern Check relations matching the specified pattern, unless they are otherwise excluded. This option can be specified more than once. Patterns may be unqualified, e.g…pg_amcheck › Options pg_amcheck --rootdescendCommand-line ToolsPG18--rootdescend For each index checked, re-find tuples on the leaf level by performing a new search from the root page for each tuple using amcheck's rootdescend option. Use of this option imp…pg_amcheck › Options pg_amcheck --schema=patternCommand-line ToolsPG18-s pattern--schema=pattern Check tables and indexes in schemas matching the specified pattern, unless they are otherwise excluded. This option can be specified more than once. To select only…pg_amcheck › Options pg_amcheck --skip=optionCommand-line ToolsPG18--skip=option If all-frozen is given, table corruption checks will skip over pages in all tables that are marked as all frozen. If all-visible is given, table corruption checks will skip ove…pg_amcheck › Options pg_amcheck --startblock=blockCommand-line ToolsPG18--startblock=block Start checking at the specified block number. An error will occur if the table relation being checked has fewer than this number of blocks. This option does not apply to i…pg_amcheck › Options