sqlite3_sql(3) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
SQLITE3_SQL(3)          NetBSD Library Functions Manual         SQLITE3_SQL(3)


NAME

     sqlite3_sql, sqlite3_expanded_sql, sqlite3_normalized_sql -- retrieving
     statement SQL


SYNOPSIS

     #include <sqlite3.h>

     const char *
     sqlite3_sql(sqlite3_stmt *pStmt);

     char *
     sqlite3_expanded_sql(sqlite3_stmt *pStmt);

     const char *
     sqlite3_normalized_sql(sqlite3_stmt *pStmt);


DESCRIPTION

     The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8 SQL
     text used to create prepared statement P if P was created by
     sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(), or
     sqlite3_prepare16_v3().  The sqlite3_expanded_sql(P) interface returns a
     pointer to a UTF-8 string containing the SQL text of prepared statement P
     with bound parameters expanded.  The sqlite3_normalized_sql(P) interface
     returns a pointer to a UTF-8 string containing the normalized SQL text of
     prepared statement P.  The semantics used to normalize a SQL statement
     are unspecified and subject to change.  At a minimum, literal values will
     be replaced with suitable placeholders.

     For example, if a prepared statement is created using the SQL text
     "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345 and
     parameter :xyz is unbound, then sqlite3_sql() will return the original
     string, "SELECT $abc,:xyz" but sqlite3_expanded_sql() will return "SELECT
     2345,NULL".

     The sqlite3_expanded_sql() interface returns NULL if insufficient memory
     is available to hold the result, or if the result would exceed the the
     maximum string length determined by the SQLITE_LIMIT_LENGTH.

     The SQLITE_TRACE_SIZE_LIMIT compile-time option limits the size of bound
     parameter expansions.  The SQLITE_OMIT_TRACE compile-time option causes
     sqlite3_expanded_sql() to always return NULL.

     The strings returned by sqlite3_sql(P) and sqlite3_normalized_sql(P) are
     managed by SQLite and are automatically freed when the prepared statement
     is finalized.  The string returned by sqlite3_expanded_sql(P), on the
     other hand, is obtained from sqlite3_malloc() and must be freed by the
     application by passing it to sqlite3_free().  The sqlite3_normal-
     ized_sql() interface is only available if the SQLITE_ENABLE_NORMALIZE
     compile-time option is defined.


IMPLEMENTATION NOTES

     These declarations were extracted from the interface documentation at
     line 4321.

     SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
     SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
     #ifdef SQLITE_ENABLE_NORMALIZE
     SQLITE_API const char *sqlite3_normalized_sql(sqlite3_stmt *pStmt);
     #endif


SEE ALSO

     sqlite3_malloc(3), sqlite3_prepare(3), sqlite3_stmt(3),
     SQLITE_LIMIT_LENGTH(3)

NetBSD 10.99                   January 24, 2024                   NetBSD 10.99