settings.h File Reference

#include "variables.h"
#include "fe_utils/print.h"

Include dependency graph for settings.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_psqlSettings

Macros
#define	DEFAULT_FIELD_SEP   "|"
#define	DEFAULT_RECORD_SEP   "\n"
#define	DEFAULT_EDITOR   "vi"
#define	DEFAULT_EDITOR_LINENUMBER_ARG   "+"
#define	DEFAULT_PROMPT1   "%/%R%# "
#define	DEFAULT_PROMPT2   "%/%R%# "
#define	DEFAULT_PROMPT3   ">> "
#define	EXIT_SUCCESS   0
#define	EXIT_FAILURE   1
#define	EXIT_BADCONN   2
#define	EXIT_USER   3

Typedefs
typedef struct _psqlSettings	PsqlSettings

Enumerations
enum	PSQL_ECHO { PSQL_ECHO_NONE, PSQL_ECHO_QUERIES, PSQL_ECHO_ERRORS, PSQL_ECHO_ALL }
enum	PSQL_ECHO_HIDDEN { PSQL_ECHO_HIDDEN_OFF, PSQL_ECHO_HIDDEN_ON, PSQL_ECHO_HIDDEN_NOEXEC }
enum	PSQL_ERROR_ROLLBACK { PSQL_ERROR_ROLLBACK_OFF, PSQL_ERROR_ROLLBACK_INTERACTIVE, PSQL_ERROR_ROLLBACK_ON }
enum	PSQL_COMP_CASE { PSQL_COMP_CASE_PRESERVE_UPPER, PSQL_COMP_CASE_PRESERVE_LOWER, PSQL_COMP_CASE_UPPER, PSQL_COMP_CASE_LOWER }
enum	HistControl { hctl_none = 0, hctl_ignorespace = 1, hctl_ignoredups = 2, hctl_ignoreboth = hctl_ignorespace | hctl_ignoredups }
enum	trivalue {   TRI_DEFAULT, TRI_NO, TRI_YES, TRI_DEFAULT,   TRI_NO, TRI_YES, TRI_DEFAULT, TRI_NO,   TRI_YES, TRI_DEFAULT, TRI_NO, TRI_YES }

Variables
PsqlSettings	pset

Macro Definition Documentation

#define DEFAULT_EDITOR   "vi"

Definition at line 22 of file settings.h.

Referenced by editFile().

#define DEFAULT_EDITOR_LINENUMBER_ARG   "+"

Definition at line 23 of file settings.h.

Referenced by editFile().

#define DEFAULT_FIELD_SEP   "|"

Definition at line 15 of file settings.h.

Referenced by helpVariables(), main(), and usage().

#define DEFAULT_PROMPT1   "%/%R%# "

Definition at line 26 of file settings.h.

Referenced by main().

#define DEFAULT_PROMPT2   "%/%R%# "

Definition at line 27 of file settings.h.

Referenced by main().

#define DEFAULT_PROMPT3   ">> "

Definition at line 28 of file settings.h.

Referenced by main().

#define DEFAULT_RECORD_SEP   "\n"

Definition at line 16 of file settings.h.

Referenced by main().

#define EXIT_BADCONN   2

Definition at line 155 of file settings.h.

Referenced by CheckConnection(), main(), and MainLoop().

#define EXIT_FAILURE   1

Definition at line 152 of file settings.h.

Referenced by addtype(), appendPsqlMetaConnect(), appendShellString(), associate(), change_directory(), close_file(), dolink(), exec_command_cd(), exec_command_conninfo(), fatal_error(), get_controlfile(), getfields(), infile(), leapadd(), main(), MainLoop(), memory_exhausted(), mkdirs(), newabbr(), parse_psql_options(), pg_malloc_internal(), pg_realloc(), pg_strdup(), printTable(), printTableAddCell(), printTableAddHeader(), process_file(), process_psqlrc(), pvsnprintf(), rpytime(), rulesub(), time_overflow(), usage(), writezone(), and yearistype().

#define EXIT_SUCCESS   0

Definition at line 148 of file settings.h.

Referenced by exec_command_include(), main(), MainLoop(), parse_psql_options(), and usage().

#define EXIT_USER   3

Definition at line 157 of file settings.h.

Referenced by main(), and MainLoop().

Typedef Documentation

typedef struct _psqlSettings PsqlSettings

Enumeration Type Documentation

enum HistControl

Enumerator
hctl_none
hctl_ignorespace
hctl_ignoredups
hctl_ignoreboth

Definition at line 65 of file settings.h.

{
    hctl_none = 0,
    hctl_ignorespace = 1,
    hctl_ignoredups = 2,
    hctl_ignoreboth = hctl_ignorespace | hctl_ignoredups
} HistControl;

enum PSQL_COMP_CASE

Enumerator
PSQL_COMP_CASE_PRESERVE_UPPER
PSQL_COMP_CASE_PRESERVE_LOWER
PSQL_COMP_CASE_UPPER
PSQL_COMP_CASE_LOWER

Definition at line 57 of file settings.h.

{
    PSQL_COMP_CASE_PRESERVE_UPPER,
    PSQL_COMP_CASE_PRESERVE_LOWER,
    PSQL_COMP_CASE_UPPER,
    PSQL_COMP_CASE_LOWER
} PSQL_COMP_CASE;

enum PSQL_ECHO

Enumerator
PSQL_ECHO_NONE
PSQL_ECHO_QUERIES
PSQL_ECHO_ERRORS
PSQL_ECHO_ALL

Definition at line 35 of file settings.h.

{
    PSQL_ECHO_NONE,
    PSQL_ECHO_QUERIES,
    PSQL_ECHO_ERRORS,
    PSQL_ECHO_ALL
} PSQL_ECHO;

enum PSQL_ECHO_HIDDEN

Enumerator
PSQL_ECHO_HIDDEN_OFF
PSQL_ECHO_HIDDEN_ON
PSQL_ECHO_HIDDEN_NOEXEC

Definition at line 43 of file settings.h.

{
    PSQL_ECHO_HIDDEN_OFF,
    PSQL_ECHO_HIDDEN_ON,
    PSQL_ECHO_HIDDEN_NOEXEC
} PSQL_ECHO_HIDDEN;

enum PSQL_ERROR_ROLLBACK

Enumerator
PSQL_ERROR_ROLLBACK_OFF
PSQL_ERROR_ROLLBACK_INTERACTIVE
PSQL_ERROR_ROLLBACK_ON

Definition at line 50 of file settings.h.

{
    PSQL_ERROR_ROLLBACK_OFF,
    PSQL_ERROR_ROLLBACK_INTERACTIVE,
    PSQL_ERROR_ROLLBACK_ON
} PSQL_ERROR_ROLLBACK;

enum trivalue

Enumerator
TRI_DEFAULT
TRI_NO
TRI_YES
TRI_DEFAULT
TRI_NO
TRI_YES
TRI_DEFAULT
TRI_NO
TRI_YES
TRI_DEFAULT
TRI_NO
TRI_YES

Definition at line 73 of file settings.h.

{
    TRI_DEFAULT,
    TRI_NO,
    TRI_YES
};

Variable Documentation

PsqlSettings pset

Definition at line 33 of file startup.c.

Referenced by AcceptResult(), CheckConnection(), ClearOrSaveResult(), command_no_begin(), connection_warnings(), ConnectionUp(), describeAccessMethods(), describeAggregates(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOneTSParser(), describeOperators(), describePublications(), DescribeQuery(), describeRoles(), describeSubscriptions(), describeTableDetails(), describeTablespaces(), describeTypes(), do_connect(), do_copy(), do_lo_export(), do_lo_import(), do_lo_list(), do_lo_unlink(), do_pset(), do_watch(), echo_hidden_command(), exec_command(), exec_command_a(), exec_command_C(), exec_command_conninfo(), exec_command_crosstabview(), exec_command_echo(), exec_command_ef_ev(), exec_command_encoding(), exec_command_errverbose(), exec_command_f(), exec_command_g(), exec_command_gdesc(), exec_command_gexec(), exec_command_gset(), exec_command_help(), exec_command_html(), exec_command_password(), exec_command_print(), exec_command_prompt(), exec_command_pset(), exec_command_reset(), exec_command_s(), exec_command_set(), exec_command_sf_sv(), exec_command_slash_command_help(), exec_command_t(), exec_command_T(), exec_command_timing(), exec_command_unset(), exec_command_x(), ExecQueryTuples(), ExecQueryUsingCursor(), fail_lo_xact(), finish_lo_xact(), finishInput(), get_create_object_cmd(), get_prompt(), handleCopyIn(), HandleSlashCmds(), helpSQL(), helpVariables(), indexOfColumn(), initializeInput(), is_select_command(), is_superuser(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listOneExtensionContents(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), lookup_object_oid(), MainLoop(), objectDescription(), parse_slash_copy(), permissionsList(), pg_send_history(), print_lo_result(), printACLColumn(), printCrosstab(), printHistory(), PrintNotifications(), PrintQueryResults(), PrintQueryStatus(), PrintQueryTuples(), PrintResultsInCrosstab(), printSSLInfo(), process_file(), ProcessResult(), psql_error(), psql_get_variable(), PSQLexec(), PSQLexecWatch(), SendQuery(), session_username(), SetCancelConn(), setQFout(), SetResultVariables(), skip_white_space(), slashUsage(), standard_strings(), start_lo_xact(), StoreQueryTuple(), SyncVariables(), UnsyncVariables(), and usage().