src/fe_utils/string_utils.c:69-77
Sets the character encoding that fmtId() and fmtQualifiedId() functions will use for proper identifier escaping and quoting operations.
void setFmtEncoding(int encoding)This function configures the global encoding setting used by PostgreSQL's identifier formatting functions. It sets the static variable fmtIdEncoding which is later used by fmtId() and fmtQualifiedId() to ensure proper character escaping when quoting database identifiers.
The function addresses the need for encoding-aware identifier processing in PostgreSQL frontend utilities. Different character encodings may require different escaping rules, and this function allows the formatting system to adapt to the connection's encoding.
However, the implementation has a known limitation: it is not safe for applications that maintain multiple database connections with different encodings simultaneously, as the encoding setting is global rather than per-connection. The comments indicate this is a recognized design issue that may be addressed in future versions.
encoding: Integer value representing the character encoding (typically constants from PostgreSQL's encoding system like PG_UTF8, PG_LATIN1, etc.)
- Functions called/Symbols referenced:
- fmtIdEncoding (static variable assignment)
- Called from (representative examples):
- processEncodingEntry (pg_backup_archiver.c:2840)
- setup_connection (pg_dump.c:1236)
- main (pg_dumpall.c:546)
- exec_command_encoding (psql command.c:1360)
- SyncVariables (psql command.c:4050)
- main (createdb.c:201)
- main (createuser.c:295)
- Sets the global fmtIdEncoding static variable which defaults to -1 (uninitialized)
- Used by pg_dump, pg_dumpall, psql, and other PostgreSQL frontend utilities
- Not thread-safe and not safe for multiple connections with different encodings
- The design may be deprecated in future versions as indicated by comments suggesting eventual removal of fmtId()
- Critical for proper handling of non-ASCII characters in database identifiers
- Should be called once per database connection to set the appropriate encoding for that session
void setFmtEncoding(int encoding) {
// Set global encoding for identifier formatting functions
fmtIdEncoding = encoding;
}