{"Entry":{"collection":"conn","key":"options","name":"options","aliases":["PGOPTIONS","options"],"metadata":{"aliases":["PGOPTIONS","options"],"category":"Session and protocol","content_hash":"146fa10f3f4cd5a29985fb01cf415fc8665daa89b39ef3c8c8ab6aa07d984f99","imported_at":"2026-09-30T00:40:35.007906+08:00","name":"options","name_zh":"","slug":"options","summary":"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 . Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash ( \\ ); write \\\\ to represent a literal backslash. For a detailed discussion of the available options, consult Chapter 19 ."}},"Definition":{"Collection":"conn","Key":"options","SourceDatabase":"center","Version":"18","SourceTable":"connection_parameter","SourceKey":"options","SourceRevision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","Facts":{"comparison_data":{"compiled_default_expression":"DefaultOption","default_evidence":[],"definition":"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 . Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash ( \\ ); write \\\\ to represent a literal backslash. For a detailed discussion of the available options, consult Chapter 19 .","documented":true,"environment":"PGOPTIONS","keyword":"options"},"comparison_hash":"e790fec12774b1586d61466686d597d9846e81a4ac8af3c05a272af9bde1e14b","default_evidence":[],"description":["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 . Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash ( \\ ); write \\\\ to represent a literal backslash. For a detailed discussion of the available options, consult Chapter 19 ."],"documented":true,"environment":[{"description":"PGOPTIONS behaves the same as the options connection parameter.","name":"PGOPTIONS","source_url":"/docs/18/libpq-envars.html"}],"facts":[{"label":"Client library","value":"libpq 18.6"},{"label":"Manual definition","value":"Documented"},{"label":"Source environment fallback","value":"PGOPTIONS"},{"label":"Compiled fallback expression","value":"DefaultOption"}],"keyword":"options","manual_html":"\u003cdiv\u003e\u003cdl class=\"variablelist\"\u003e\u003cdt id=\"LIBPQ-CONNECT-OPTIONS\"\u003e\u003cspan class=\"term\"\u003e\u003ccode class=\"literal\"\u003eoptions\u003c/code\u003e\u003c/span\u003e \u003c/dt\u003e\u003cdd\u003e\n\u003cp\u003eSpecifies command-line options to send to the server at connection start. For example, setting this to \u003ccode class=\"literal\"\u003e-c geqo=off\u003c/code\u003e or \u003ccode class=\"literal\"\u003e--geqo=off\u003c/code\u003e sets the session's value of the \u003ccode class=\"varname\"\u003egeqo\u003c/code\u003e parameter to \u003ccode class=\"literal\"\u003eoff\u003c/code\u003e. Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash (\u003ccode class=\"literal\"\u003e\\\u003c/code\u003e); write \u003ccode class=\"literal\"\u003e\\\\\u003c/code\u003e to represent a literal backslash. For a detailed discussion of the available options, consult \u003ca class=\"xref\" href=\"/docs/18/runtime-config.html\" title=\"Chapter 19. Server Configuration\"\u003eChapter 19\u003c/a\u003e.\u003c/p\u003e\n\u003c/dd\u003e\u003c/dl\u003e\u003c/div\u003e","manual_path":"libpq-connect.html#LIBPQ-CONNECT-OPTIONS","precedence_evidence":["The following environment variables can be used to select default connection parameter values, which will be used by PQconnectdb , PQsetdbLogin and PQsetdb if no value is directly specified by the calling code. These are useful to avoid hard-coding database connection information into simple client applications, for example.","Service names can be defined in either a per-user service file or a system-wide file. If the same service name exists in both the user and the system file, the user file takes precedence. By default, the per-user service file is named ~/.pg_service.conf . On Microsoft Windows, it is named %APPDATA%\\postgresql\\.pg_service.conf (where %APPDATA% refers to the Application Data subdirectory in the user's profile). A different file name can be specified by setting the environment variable PGSERVICEFILE . The system-wide file is named pg_service.conf . By default it is sought in the etc directory of the PostgreSQL installation (use pg_config --sysconfdir to identify this directory precisely). Another directory, but not a different file name, can be specified by setting the environment variable PGSYSCONFDIR .","Connection parameters obtained from a service file are combined with parameters obtained from other sources. A service file setting overrides the corresponding environment variable, and in turn can be overridden by a value given directly in the connection string. For example, using the above service file, a connection string service=mydb port=5434 will use host somehost , port 5434 , user admin , and other parameters as set by environment variables or built-in defaults."],"related":[{"label":"Connection service file","url":"/docs/18/libpq-pgservice.html"},{"label":"Password file","url":"/docs/18/libpq-pgpass.html"},{"label":"All libpq environment variables","url":"/docs/18/libpq-envars.html"}],"release":{"channel":"stable","evidence_kind":"English manual and source declarations","label":"18.6","major":"18","manifest":{"index":"index.html","major":"18","pages":1148,"pdf":{"A4":{"built_at":"2026-09-26","bytes":15865106,"pages":3154,"sha256":"19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190","url":"/files/documentation/pdf/18/postgresql-18-A4.pdf"},"US":{"built_at":"2026-09-26","bytes":15748059,"pages":3328,"sha256":"facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319","url":"/files/documentation/pdf/18/postgresql-18-US.pdf"}},"release":"18.6","source_mode":"en SGML built with pinned official archive","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","source_url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","svg_assets":3,"tree":"18"},"ref":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","revision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"},"sections":[{"paragraphs":["The following environment variables can be used to select default connection parameter values, which will be used by PQconnectdb , PQsetdbLogin and PQsetdb if no value is directly specified by the calling code. These are useful to avoid hard-coding database connection information into simple client applications, for example.","Service names can be defined in either a per-user service file or a system-wide file. If the same service name exists in both the user and the system file, the user file takes precedence. By default, the per-user service file is named ~/.pg_service.conf . On Microsoft Windows, it is named %APPDATA%\\postgresql\\.pg_service.conf (where %APPDATA% refers to the Application Data subdirectory in the user's profile). A different file name can be specified by setting the environment variable PGSERVICEFILE . The system-wide file is named pg_service.conf . By default it is sought in the etc directory of the PostgreSQL installation (use pg_config --sysconfdir to identify this directory precisely). Another directory, but not a different file name, can be specified by setting the environment variable PGSYSCONFDIR .","Connection parameters obtained from a service file are combined with parameters obtained from other sources. A service file setting overrides the corresponding environment variable, and in turn can be overridden by a value given directly in the connection string. For example, using the above service file, a connection string service=mydb port=5434 will use host somehost , port 5434 , user admin , and other parameters as set by environment variables or built-in defaults."],"title":"Default resolution and service-file precedence"},{"paragraphs":["PGOPTIONS behaves the same as the options connection parameter."],"title":"Environment variable evidence"},{"paragraphs":["ssl options are allowed even without client SSL support because the client can still handle SSL modes \"disable\" and \"allow\". Other parameters have no effect on non-SSL connections, so there is no reason to exclude them since none of them are mandatory.","As with SSL, all GSS options are exposed even in builds that don't have support."],"title":"Source declaration notes"}],"signature":"options","source_option":{"compiled_default_expression":"DefaultOption","declaration":"\"options\", \"PGOPTIONS\", DefaultOption, NULL, \"Backend-Options\", \"\", 40, offsetof(struct pg_conn, pgoptions)","environment":"PGOPTIONS","keyword":"options","source_notes":["ssl options are allowed even without client SSL support because the client can still handle SSL modes \"disable\" and \"allow\". Other parameters have no effect on non-SSL connections, so there is no reason to exclude them since none of them are mandatory.","As with SSL, all GSS options are exposed even in builds that don't have support."]},"sources":[{"anchor":"LIBPQ-CONNECT-OPTIONS","file":"libpq-connect.html","label":"18.6 English manual · libpq-connect.html","sha256":"c26a7fc3dcda6066cfe540641ae2690faf3d3c03277f30b4dfc2328ab45c212f","url":"/docs/18/libpq-connect.html#LIBPQ-CONNECT-OPTIONS"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","file":"src/interfaces/libpq/fe-connect.c","label":"18.6 libpq connection option declarations","sha256":"44a6e386cbfd67ebe768d6ef5493098119c2e6b4796239d53e5ed7b122b206a5","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"anchor":"","file":"libpq-envars.html","label":"18.6 English manual · libpq-envars.html","sha256":"d64db73f3d48127bb984a5f775e77b7bcca2ba4bd218333cf24a45fcdd7c4363","url":"/docs/18/libpq-envars.html"},{"anchor":"","file":"libpq-pgservice.html","label":"18.6 English manual · libpq-pgservice.html","sha256":"6035a3f0ee1d0fd80db5bf58834390b884eecd23206659bdf6f07560deea5aa7","url":"/docs/18/libpq-pgservice.html"}],"tables":[{"columns":[{"key":"name","label":"Variable"},{"key":"description","label":"Documented behavior"}],"key":"environment","rows":[{"description":"PGOPTIONS behaves the same as the options connection parameter.","name":{"text":"PGOPTIONS","url":"/docs/18/libpq-envars.html"}}],"title":"Environment fallback"}]},"ManualEvidence":{"manual_path":"libpq-connect.html#LIBPQ-CONNECT-OPTIONS","release":{"channel":"stable","evidence_kind":"English manual and source declarations","label":"18.6","major":"18","manifest":{"index":"index.html","major":"18","pages":1148,"pdf":{"A4":{"built_at":"2026-09-26","bytes":15865106,"pages":3154,"sha256":"19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190","url":"/files/documentation/pdf/18/postgresql-18-A4.pdf"},"US":{"built_at":"2026-09-26","bytes":15748059,"pages":3328,"sha256":"facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319","url":"/files/documentation/pdf/18/postgresql-18-US.pdf"}},"release":"18.6","source_mode":"en SGML built with pinned official archive","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","source_url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","svg_assets":3,"tree":"18"},"ref":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","revision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"},"sources":[{"anchor":"LIBPQ-CONNECT-OPTIONS","file":"libpq-connect.html","label":"18.6 English manual · libpq-connect.html","sha256":"c26a7fc3dcda6066cfe540641ae2690faf3d3c03277f30b4dfc2328ab45c212f","url":"/docs/18/libpq-connect.html#LIBPQ-CONNECT-OPTIONS"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","file":"src/interfaces/libpq/fe-connect.c","label":"18.6 libpq connection option declarations","sha256":"44a6e386cbfd67ebe768d6ef5493098119c2e6b4796239d53e5ed7b122b206a5","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"anchor":"","file":"libpq-envars.html","label":"18.6 English manual · libpq-envars.html","sha256":"d64db73f3d48127bb984a5f775e77b7bcca2ba4bd218333cf24a45fcdd7c4363","url":"/docs/18/libpq-envars.html"},{"anchor":"","file":"libpq-pgservice.html","label":"18.6 English manual · libpq-pgservice.html","sha256":"6035a3f0ee1d0fd80db5bf58834390b884eecd23206659bdf6f07560deea5aa7","url":"/docs/18/libpq-pgservice.html"}]},"MeasuredEvidence":{}},"Text":{"Collection":"conn","Key":"options","SourceDatabase":"center","Version":"18","Locale":"en","Title":"options","Summary":"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 . Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash ( \\ ); write \\\\ to represent a literal backslash. For a detailed discussion of the available options, consult Chapter 19 .","BodyHTML":"\u003cdiv\u003e\u003cdl\u003e\u003cdt id=\"LIBPQ-CONNECT-OPTIONS\"\u003e\u003cspan\u003e\u003ccode\u003eoptions\u003c/code\u003e\u003c/span\u003e \u003c/dt\u003e\u003cdd\u003e\n\u003cp\u003eSpecifies command-line options to send to the server at connection start. For example, setting this to \u003ccode\u003e-c geqo=off\u003c/code\u003e or \u003ccode\u003e--geqo=off\u003c/code\u003e sets the session\u0026#39;s value of the \u003ccode\u003egeqo\u003c/code\u003e parameter to \u003ccode\u003eoff\u003c/code\u003e. Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash (\u003ccode\u003e\\\u003c/code\u003e); write \u003ccode\u003e\\\\\u003c/code\u003e to represent a literal backslash. For a detailed discussion of the available options, consult \u003ca href=\"/docs/18/runtime-config.html\" rel=\"nofollow\"\u003eChapter 19\u003c/a\u003e.\u003c/p\u003e\n\u003c/dd\u003e\u003c/dl\u003e\u003c/div\u003e","SourceRevision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","ContentHash":"16dac1f7fb6538415ffd6a2e0420d2f75300b486fd1791ea4c8713041c1f97da","Payload":{"description":["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 . Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash ( \\ ); write \\\\ to represent a literal backslash. For a detailed discussion of the available options, consult Chapter 19 ."],"manual_html":"\u003cdiv\u003e\u003cdl class=\"variablelist\"\u003e\u003cdt id=\"LIBPQ-CONNECT-OPTIONS\"\u003e\u003cspan class=\"term\"\u003e\u003ccode class=\"literal\"\u003eoptions\u003c/code\u003e\u003c/span\u003e \u003c/dt\u003e\u003cdd\u003e\n\u003cp\u003eSpecifies command-line options to send to the server at connection start. For example, setting this to \u003ccode class=\"literal\"\u003e-c geqo=off\u003c/code\u003e or \u003ccode class=\"literal\"\u003e--geqo=off\u003c/code\u003e sets the session's value of the \u003ccode class=\"varname\"\u003egeqo\u003c/code\u003e parameter to \u003ccode class=\"literal\"\u003eoff\u003c/code\u003e. Spaces within this string are considered to separate command-line arguments, unless escaped with a backslash (\u003ccode class=\"literal\"\u003e\\\u003c/code\u003e); write \u003ccode class=\"literal\"\u003e\\\\\u003c/code\u003e to represent a literal backslash. For a detailed discussion of the available options, consult \u003ca class=\"xref\" href=\"/docs/18/runtime-config.html\" title=\"Chapter 19. Server Configuration\"\u003eChapter 19\u003c/a\u003e.\u003c/p\u003e\n\u003c/dd\u003e\u003c/dl\u003e\u003c/div\u003e","related":[{"label":"Connection service file","url":"/docs/18/libpq-pgservice.html"},{"label":"Password file","url":"/docs/18/libpq-pgpass.html"},{"label":"All libpq environment variables","url":"/docs/18/libpq-envars.html"}],"sections":[{"paragraphs":["The following environment variables can be used to select default connection parameter values, which will be used by PQconnectdb , PQsetdbLogin and PQsetdb if no value is directly specified by the calling code. These are useful to avoid hard-coding database connection information into simple client applications, for example.","Service names can be defined in either a per-user service file or a system-wide file. If the same service name exists in both the user and the system file, the user file takes precedence. By default, the per-user service file is named ~/.pg_service.conf . On Microsoft Windows, it is named %APPDATA%\\postgresql\\.pg_service.conf (where %APPDATA% refers to the Application Data subdirectory in the user's profile). A different file name can be specified by setting the environment variable PGSERVICEFILE . The system-wide file is named pg_service.conf . By default it is sought in the etc directory of the PostgreSQL installation (use pg_config --sysconfdir to identify this directory precisely). Another directory, but not a different file name, can be specified by setting the environment variable PGSYSCONFDIR .","Connection parameters obtained from a service file are combined with parameters obtained from other sources. A service file setting overrides the corresponding environment variable, and in turn can be overridden by a value given directly in the connection string. For example, using the above service file, a connection string service=mydb port=5434 will use host somehost , port 5434 , user admin , and other parameters as set by environment variables or built-in defaults."],"title":"Default resolution and service-file precedence"},{"paragraphs":["PGOPTIONS behaves the same as the options connection parameter."],"title":"Environment variable evidence"},{"paragraphs":["ssl options are allowed even without client SSL support because the client can still handle SSL modes \"disable\" and \"allow\". Other parameters have no effect on non-SSL connections, so there is no reason to exclude them since none of them are mandatory.","As with SSL, all GSS options are exposed even in builds that don't have support."],"title":"Source declaration notes"}],"tables":[{"columns":[{"key":"name","label":"Variable"},{"key":"description","label":"Documented behavior"}],"key":"environment","rows":[{"description":"PGOPTIONS behaves the same as the options connection parameter.","name":{"text":"PGOPTIONS","url":"/docs/18/libpq-envars.html"}}],"title":"Environment fallback"}]}},"RequestedLocale":"zh-Hans","Fallback":true,"Versions":["10","11","12","13","14","15","16","17","18","19","20"],"Locales":["en"],"Signatures":null,"Spellings":null,"SQLState":null,"Evidence":null}