1. Epic GamesDeveloper
  3. FSQLitePreparedStatement

FSQLitePreparedStatement

Wrapper around an SQLite prepared statement.

API > API/Plugins > API/Plugins/SQLiteCore

Inheritance Hierarchy

References

   
Module SQLiteCore
Header /Engine/Plugins/Runtime/Database/SQLiteCore/Source/SQLiteCore/Public/SQLitePreparedStatement.h
Include #include "SQLitePreparedStatement.h"

Syntax

class FSQLitePreparedStatement

Remarks

Wrapper around an SQLite prepared statement.

Constructors

  Type Name Description
Public function   Construction/Destruction
Public function   Non-copyable
Public function   Movable
Public function  

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

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Clear any bindings that have been applied to this prepared statement.
Public function bool

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

 Create a new SQLite prepared statement.
Public function bool

Destroy ()

 Destroy the existing SQLite prepared statement.
Public function int64 Execute a statement and enumerate the result state.
Public function bool

Execute ()

 Execute a statement that requires no result state.
Public function Const int32

GetBindingIndexByName ( const TCHAR* InBindingName
)

 Get the index of a given binding from its name.
Public function Const int32

GetColumnIndexByName ( const TCHAR* InColumnName
)

 Get the index of a column from its name.
Public function Const const TArray< FString > & Get the column names affected by this statement.
Public function Const bool

GetColumnTypeByIndex ( const int32 InColumnIndex,
ESQLiteColumnType& OutColumnType
)

  
Public function Const bool

GetColumnTypeByName ( const TCHAR* InColumnName,
ESQLiteColumnType& OutColumnType
)

 Get the type of a column from its name or index.
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
EnumType& InValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
float& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
double& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
FDateTime& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
FName& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
uint64& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
FText& OutValue
)

  
Public function Const bool

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

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
FGuid& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
FString& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
int64& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
int8& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
int32& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
uint16& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
int16& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
uint8& OutValue
)

  
Public function Const bool

GetColumnValueByIndex ( const int32 InColumnIndex,
uint32& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
uint64& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
FString& OutValue
)

 Get the string value of a column from its name or index.
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
FName& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
FText& OutValue
)

  
Public function Const bool

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

 Get the blob value of a column from its name or index.
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
FGuid& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
double& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
EnumType& InValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
FDateTime& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
int64& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
float& OutValue
)

 Get the float value of a column from its name or index.
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
int32& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
uint16& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
int16& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
uint8& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
uint32& OutValue
)

  
Public function Const bool

GetColumnValueByName ( const TCHAR* InColumnName,
int8& OutValue
)

 Get the integer value of a column from its name or index.
Public function Const bool Is this SQLite prepared statement active? ("busy" in SQLite parlance).
Public function Const bool Is this SQLite prepared statement read-only? (ie, will it only read from the database contents?).
Public function Const bool

IsValid ()

 Is this a valid SQLite prepared statement? (ie, has been successfully compiled).
Public function void

Reset ()

 Reset the SQLite prepared statement so that it can be used again.
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const EnumType InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const FGuid& InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const FText& InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const FName InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const FString& InValue
)

  
Public function bool

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

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const double InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const float InValue
)

  
Public function bool

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

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const FDateTime InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const TCHAR* InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const int64 InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const uint32 InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const int32 InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const uint16 InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const int16 InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const uint8 InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const int8 InValue
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex
)

  
Public function bool

SetBindingValueByIndex ( const int32 InBindingIndex,
const uint64 InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const float InValue
)

 Set the given float binding from its name or index.
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const double InValue
)

  
Public function bool

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

 Set the given string binding from its name or index.
Public function bool

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

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const FName InValue
)

  
Public function bool

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

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const EnumType InValue
)

  
Public function bool

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

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const FDateTime InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const uint16 InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const int64 InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const uint32 InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const int32 InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const int16 InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const uint8 InValue
)

  
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const int8 InValue
)

 Set the given integer binding from its name or index.
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName
)

 Set the given null binding from its name or index.
Public function bool

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

 Set the given blob binding from its name or index.
Public function bool

SetBindingValueByName ( const TCHAR* InBindingName,
const uint64 InValue
)

  
Public function bool

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

  
Public function ESQLitePreparedStatementStepResult

Step ()

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

Operators

  Type Name Description
Public function FSQLitePreparedStatement &  
Public function FSQLitePreparedStatement &  

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