Skip to content

Commit f0b68a6

Browse files
committed
Update some documentation
1 parent a26529c commit f0b68a6

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

src/pgsql.hpp

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,10 @@ class pg_conn_t
219219
pg_result_t query(ExecStatusType expect, char const *sql) const;
220220
pg_result_t query(ExecStatusType expect, std::string const &sql) const;
221221

222+
/**
223+
* Update a PostgreSQL setting (like with the SET command). Will silently
224+
* ignore settings that are not available or any other errors.
225+
*/
222226
void set_config(char const *setting, char const *value) const;
223227

224228
/**
@@ -235,6 +239,7 @@ class pg_conn_t
235239

236240
void end_copy(std::string const &context) const;
237241

242+
/// Return the latest generated error message on this connection.
238243
char const *error_msg() const noexcept;
239244

240245
/// Close database connection.
@@ -265,15 +270,15 @@ std::string tablespace_clause(std::string const &name);
265270
std::string qualified_name(std::string const &schema, std::string const &name);
266271

267272
/**
268-
* Check that the string confirms to the identifier syntax we accept.
269-
* Throws a runtime exception if an invalid character is found.
273+
* Check that the string conforms to the identifier syntax we accept.
270274
*
271275
* Note that PostgreSQL accepts any character in a quoted identifier.
272-
* This function checks for some characters that are problematic in the
273-
* internal functions that create SQL statements.
276+
* This function checks for some characters that are potentially problematic
277+
* in our internal functions that create SQL statements.
274278
*
275-
* \param name Identifier to check.
276-
* \param in Name of the identifier. Only used to create a human-readable error.
279+
* \param name Identifier to check.
280+
* \param in Name of the identifier. Only used to create a human-readable error.
281+
* \throws runtime_exception If an invalid character is found in the name.
277282
*/
278283
void check_identifier(std::string const &name, char const *in);
279284

0 commit comments

Comments
 (0)