1. Epic GamesDeveloper
  3. FSQLiteDatabase

FSQLiteDatabase

Wrapper around an SQLite database.

API > API/Plugins > API/Plugins/SQLiteCore

Wrapper around an SQLite database.

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

Syntax

class FSQLiteDatabase

Constructors

Name Remarks Include Path Unreal Specifiers
Construction/Destruction SQLiteDatabase.h  
Non-copyable SQLiteDatabase.h  
Movable SQLiteDatabase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSQLiteDatabase()

   SQLiteDatabase.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Database sqlite3 * Internal SQLite database handle SQLiteDatabase.h  
OriginalPath FString Full original path for logging/profiling SQLiteDatabase.h  
ShortName FString Short name for logging/profiling SQLiteDatabase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Close()

 Close an open SQLite database file. SQLiteDatabase.h  

int64 Execute ( const TCHAR* InStatement,
TFunctionRef< ESQLitePreparedStatementExecuteRowResult(const FSQLitePreparedStatement&)> InCallback
)

 Execute a statement and enumerate the result state. SQLiteDatabase.h  

bool Execute ( const TCHAR* InStatement
)

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

bool GetApplicationId ( int32& OutApplicationId
) const

 Get the application ID set in the database header. SQLiteDatabase.h  

FString GetFilename ()

 Get the filename of the currently open database, or an empty string. SQLiteDatabase.h  

FString GetLastError()

 Get the last error reported by this database. SQLiteDatabase.h  
Get the rowid of the last successful INSERT statement on any table in this database. SQLiteDatabase.h  

bool GetUserVersion ( int32& OutUserVersion
) const

 Get the user version set in the database header. SQLiteDatabase.h  

bool IsValid()

 Is this a valid SQLite database? (ie, has been successfully opened). SQLiteDatabase.h  

bool Open ( const TCHAR* InFilename,
const ESQLiteDatabaseOpenMode InOpenMode
)

 Open (or create) an SQLite database file. SQLiteDatabase.h  

bool PerformQuickIntegrityCheck()

 Performs a quick check on the integrity of the database, returns true if everything is ok. SQLiteDatabase.h  

FSQLitePreparedStatement PrepareStatement ( const TCHAR* InStatement,
const ESQLitePreparedStatementFlags InFlags
)

 Prepare a statement for manual processing. SQLiteDatabase.h  
Prepare a statement defined by SQLITE_PREPARED_STATEMENT for manual processing. SQLiteDatabase.h  

bool SetApplicationId ( const int32 InApplicationId
)

 Set the application ID in the database header. SQLiteDatabase.h  

bool SetUserVersion ( const int32 InUserVersion
)

 Set the user version in the database header. SQLiteDatabase.h  

Operators

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

See Also

  • sqlite3.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page