1. Epic GamesDeveloper
  3. FSQLitePreparedStatement

FSQLitePreparedStatement

Wrapper around an SQLite prepared statement.

API > API/Plugins > API/Plugins/SQLiteCore

Wrapper around an SQLite prepared statement.

   
Name FSQLitePreparedStatement
Type class
Header File /Engine/Plugins/Runtime/Database/SQLiteCore/Source/SQLiteCore/Public/SQLitePreparedStatement.h
Include Path #include "SQLitePreparedStatement.h"

Syntax

class FSQLitePreparedStatement

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
Non-copyable SQLitePreparedStatement.h  

FSQLitePreparedStatement ( FSQLiteDatabase& InDatabase,
const TCHAR* InStatement,
const ESQLitePreparedStatementFlags InFlags
)

   SQLitePreparedStatement.h  
Movable SQLitePreparedStatement.h  
Construction/Destruction SQLitePreparedStatement.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSQLitePreparedStatement()

   SQLitePreparedStatement.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedColumnNames TArray< FString > Cached array of column names (generated on-demand when needed by the API) SQLitePreparedStatement.h  
Statement sqlite3_stmt * Internal SQLite prepared statement handle SQLitePreparedStatement.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearBindings()

 Clear any bindings that have been applied to this prepared statement. SQLitePreparedStatement.h  

bool Create ( FSQLiteDatabase& InDatabase,
const TCHAR* InStatement,
const ESQLitePreparedStatementFlags InFlags
)

 Create a new SQLite prepared statement. SQLitePreparedStatement.h  

bool Destroy()

 Destroy the existing SQLite prepared statement. SQLitePreparedStatement.h  
Execute a statement and enumerate the result state. SQLitePreparedStatement.h  

bool Execute ()

 Execute a statement that requires no result state. SQLitePreparedStatement.h  

int32 GetBindingIndexByName ( const TCHAR* InBindingName
) const

 Get the index of a given binding from its name. SQLitePreparedStatement.h  

int32 GetColumnIndexByName ( const TCHAR* InColumnName
) const

 Get the index of a column from its name. SQLitePreparedStatement.h  

const TArray< FString > & GetColumnNames()

 Get the column names affected by this statement. SQLitePreparedStatement.h  

bool GetColumnTypeByIndex ( const int32 InColumnIndex,
ESQLiteColumnType& OutColumnType
) const

   SQLitePreparedStatement.h  

bool GetColumnTypeByName ( const TCHAR* InColumnName,
ESQLiteColumnType& OutColumnType
) const

 Get the type of a column from its name or index. SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
uint8& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
int16& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
uint32& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
int8& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
int64& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
uint16& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
FDateTime& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
uint64& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
float& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
double& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
FString& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
FName& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
FText& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
TArray< uint8 >& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
FGuid& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
EnumType& InValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByIndex ( const int32 InColumnIndex,
int32& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
FText& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
FGuid& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
uint16& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
int32& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
int64& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
uint64& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
FDateTime& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
EnumType& InValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
float& OutValue
) const

 Get the float value of a column from its name or index. SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
double& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
FString& OutValue
) const

 Get the string value of a column from its name or index. SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
FName& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
TArray< uint8 >& OutValue
) const

 Get the blob value of a column from its name or index. SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
int16& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
uint32& OutValue
) const

   SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
int8& OutValue
) const

 Get the integer value of a column from its name or index. SQLitePreparedStatement.h  

bool GetColumnValueByName ( const TCHAR* InColumnName,
uint8& OutValue
) const

   SQLitePreparedStatement.h  

bool IsActive()

 Is this SQLite prepared statement active? ("busy" in SQLite parlance). SQLitePreparedStatement.h  

bool IsReadOnly()

 Is this SQLite prepared statement read-only? (ie, will it only read from the database contents?). SQLitePreparedStatement.h  

bool IsValid()

 Is this a valid SQLite prepared statement? (ie, has been successfully compiled). SQLitePreparedStatement.h  

void Reset ()

 Reset the SQLite prepared statement so that it can be used again. SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const FName InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const FDateTime InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const EnumType InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const void* InBlobData,
const int32 InBlobDataSizeBytes,
const bool bCopy
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const double InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
TArrayView< const uint8 > InBlobData,
const bool bCopy
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const FText& InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const FGuid& InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const uint64 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const FString& InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const TCHAR* InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const int64 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const float InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const int32 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const uint16 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const int16 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const uint8 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const int8 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex
)

   SQLitePreparedStatement.h  

bool SetBindingValueByIndex ( const int32 InBindingIndex,
const uint32 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const EnumType InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const float InValue
)

 Set the given float binding from its name or index. SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const double InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const FText& InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const FString& InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const FName InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const FDateTime InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const FGuid& InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const TCHAR* InValue
)

 Set the given string binding from its name or index. SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const uint64 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const int16 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const uint32 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const int32 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const uint16 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const uint8 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const int8 InValue
)

 Set the given integer binding from its name or index. SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName
)

 Set the given null binding from its name or index. SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
TArrayView< const uint8 > InBlobData,
const bool bCopy
)

 Set the given blob binding from its name or index. SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const int64 InValue
)

   SQLitePreparedStatement.h  

bool SetBindingValueByName ( const TCHAR* InBindingName,
const void* InBlobData,
const int32 InBlobDataSizeBytes,
const bool bCopy
)

   SQLitePreparedStatement.h  
Step the SQLite prepared statement to try and move on to the next result from the statement. SQLitePreparedStatement.h  

Operators

Name Remarks Include Path Unreal Specifiers
  SQLitePreparedStatement.h  
  SQLitePreparedStatement.h  

See Also

  • sqlite3_stmt.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page