FConcertSyncSessionDatabase

Database of activities that have happened in a Concert Sync Session.

Windows
MacOS
Linux

References

Module

ConcertSyncCore

Header

/Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/ConcertSyncSessionDatabase.h

Include

#include "ConcertSyncSessionDatabase.h"

Syntax

class FConcertSyncSessionDatabase

Remarks

Database of activities that have happened in a Concert Sync Session. Stores the activity index and their associated data.

Constructors

Name Description

Public function

FConcertSyncSessionDatabase()

Defined here where TUniquePtr can see the definition of FConcertFileCache and FConcertSyncSessionDatabaseStatements as the TUniquePtr constructor/destructor cannot work with a forward declared type

Public function

FConcertSyncSessionDatabase

(
    const FConcertSyncSessionDatabase&
)

Public function

FConcertSyncSessionDatabase

Destructors

Functions

Name Description

Public function

bool

 

AddConnectionActivity

(
    const FConcertSyncConnectionActivit...,
    int64& OutActivityId,
    int64& OutConnectionEventId
)

Add a new connection activity to this database, assigning it both an activity and connection event ID.

Public function

bool

 

AddDummyPackageEvent

(
    const FName InPackageName,
    int64& OutPackageEventId
)

Add a new dummy package event to this database, assigning it a package event ID.

Public function

bool

 

AddLockActivity

(
    const FConcertSyncLockActivity& In...,
    int64& OutActivityId,
    int64& OutLockEventId
)

Add a new lock activity to this database, assigning it both an activity and lock event ID.

Public function

bool

 

AddPackageActivity

(
    const FConcertSyncActivity& InPack...,
    const FConcertPackageInfo& InPacka...,
    FConcertPackageDataStream& InPacka...,
    int64& OutActivityId,
    int64& OutPackageEventId
)

Add a new package activity to this database, assigning it both an activity and package event ID.

Public function

bool

 

AddPersistEventForHeadRevision

(
    FName InPackageName,
    int64& OutPersistEventId
)

Add a package event ID for the head revision to the persist events in this database, if not already existing.

Public function

bool

 

AddTransactionActivity

(
    const FConcertSyncTransactionActivi...,
    int64& OutActivityId,
    int64& OutTransactionEventId
)

Add a new transaction activity to this database, assigning it both an activity and transaction event ID.

Public function

bool

 

Close

(
    const bool InDeleteDatabase
)

Close an open database file.

Public function Const

bool

 

EnumerateActivities

(
    TFunctionRef< bool...
)

Enumerate the generic part of the activities in this database.

Public function Const

bool

 

EnumerateActivitiesForEventType

(
    const EConcertSyncActivityEventType...,
    TFunctionRef< bool...
)

Enumerate all the activities in this database of the given type.

Public function Const

bool

 

EnumerateActivitiesInRange

(
    const int64 InFirstActivityId,
    const int64 InMaxNumActivities,
    TFunctionRef< bool...
)

Enumerate all the activities in this database in the given range.

Public function Const

bool

 

EnumerateActivityIdsAndEventTypes

(
    TFunctionRef< bool, EConcertS...
)

Enumerate the IDs and event types of all the activities in this database.

Public function Const

bool

 

EnumerateActivityIdsAndEventTypesInRange

(
    const int64 InFirstActivityId,
    const int64 InMaxNumActivities,
    TFunctionRef< bool, EConcertS...
)

Enumerate the IDs and event types of the activities in this database in the given range.

Public function Const

bool

 

EnumerateConnectionActivities

(
    TFunctionRef< bool...
)

Enumerate all the connection activities in this database.

Public function Const

bool

 

EnumerateEndpointIds

(
    TFunctionRef< bool)> InCallba...
)

Enumerate all the endpoint IDs in this database.

Public function Const

bool

 

EnumerateEndpoints

(
    TFunctionRef< bool...
)

Enumerate all the endpoints in this database.

Public function Const

bool

 

EnumerateHeadRevisionPackageData

(
    TFunctionRef< bool...
)

Enumerate the head revision package data for all packages in this database.

Public function Const

bool

 

EnumerateLiveTransactionEventIdsForPackage

(
    const FName InPackageName,
    TFunctionRef< bool)> InCallba...
)

Enumerate the IDs of any live transaction events for the given package name.

Public function Const

bool

 

EnumerateLockActivities

(
    TFunctionRef< bool...
)

Enumerate all the lock activities in this database.

Public function Const

bool

 

EnumeratePackageActivities

(
    const TFunctionRef< bool...
)

Enumerate all the package activities in this database.

Public function Const

bool

 

EnumeratePackageNamesWithHeadRevision

(
    TFunctionRef< bool)> InCallba...,
    bool IgnorePersisted
)

Enumerate package names for packages with a head revision (at least one package event)

Public function Const

bool

 

EnumeratePackageNamesWithLiveTransactions

(
    TFunctionRef< bool)> InCallba...
)

Enumerate the names of of any packages that have live transaction events.

Public function Const

bool

 

EnumerateTransactionActivities

(
    TFunctionRef< bool...
)

Enumerate all the transaction activities in this database.

Public function Const

bool

 

GetActivity

(
    const int64 InActivityId,
    FConcertSyncActivity& OutActivity
)

Get the generic part of an activity from this database.

Public function Const

bool

 

GetActivityEventType

(
    const int64 InActivityId,
    EConcertSyncActivityEventType& Out...
)

Get the type of an activity in this database.

Public function Const

bool

 

GetActivityForEvent

(
    const int64 InEventId,
    const EConcertSyncActivityEventType...,
    FConcertSyncActivity& OutActivity
)

Get the generic part of an activity for an event in this database.

Public function Const

bool

 

GetActivityMaxId

(
    int64& OutActivityId
)

Get the maximum ID of the activities in this database.

Public function Const

bool

 

GetConnectionActivity

(
    const int64 InActivityId,
    FConcertSyncConnectionActivity& Ou...
)

Get a connection activity from this database.

Public function Const

bool

 

GetConnectionActivityForEvent

(
    const int64 InConnectionEventId,
    FConcertSyncConnectionActivity& Ou...
)

Get a connection activity for an event in this database.

Public function Const

bool

 

GetConnectionEvent

(
    const int64 InConnectionEventId,
    FConcertSyncConnectionEvent& OutCo...
)

Get a connection event from this database.

Public function Const

bool

 

GetEndpoint

(
    const FGuid& InEndpointId,
    FConcertSyncEndpointData& OutEndpo...
)

Get an endpoint from this database.

Public function Const

FString

 

GetFilename()

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

Public function Const

FString

 

GetLastError()

Get the last error reported by this database.

Public function Const

bool

 

GetLiveTransactionEventIds

(
    TArray< int64 >& OutTransactionEve...
)

Get the IDs of any live transaction events.

Public function Const

bool

 

GetLiveTransactionEventIdsForPackage

(
    const FName InPackageName,
    TArray< int64 >& OutTransactionEve...
)

Get the IDs of any live transaction events for the given package name.

Public function Const

bool

 

GetLockActivity

(
    const int64 InActivityId,
    FConcertSyncLockActivity& OutLockA...
)

Get a lock activity from this database.

Public function Const

bool

 

GetLockActivityForEvent

(
    const int64 InLockEventId,
    FConcertSyncLockActivity& OutLockA...
)

Get a lock activity for an event in this database.

Public function Const

bool

 

GetLockEvent

(
    const int64 InLockEventId,
    FConcertSyncLockEvent& OutLockEven...
)

Get a lock event from this database.

Public function Const

bool

 

GetPackageActivity

(
    const int64 InActivityId,
    const TFunctionRef< void...
)

Get a package activity from this database.

Public function Const

bool

 

GetPackageActivityForEvent

(
    const int64 InPackageEventId,
    const TFunctionRef< void...
)

Get a package activity for an event in this database.

Public function Const

bool

 

GetPackageDataForRevision

(
    const FName InPackageName,
    const TFunctionRef< void...,
    const int64* InPackageRevision
)

Get the data from this database for the given package name for the given revision.

Public function Const

bool

 

GetPackageEvent

(
    const int64 InPackageEventId,
    const TFunctionRef< void...
)

Get a package event from this database.

Public function Const

bool

 

GetPackageEventMetaData

(
    const int64 InPackageEventId,
    int64& OuptPackageRevision,
    FConcertPackageInfo& OutPackageInf...
)

Get a package event meta data (omitting the package data itself) from this database.

Public function Const

bool

 

GetPackageHeadRevision

(
    const FName InPackageName,
    int64& OutRevision
)

Get the head revision in this database for the given package name.

Public function Const

bool

 

GetPackageInfoForRevision

(
    const FName InPackageName,
    FConcertPackageInfo& OutPackageInf...,
    const int64* InPackageRevision
)

Get the data from this database for the given package name for the given revision.

Public function Const

bool

 

GetPackageNamesWithHeadRevision

(
    TArray< FName >& OutPackageNames,
    bool IgnorePersisted
)

Get package names for packages with a head revision (at least one package event)

Public function Const

bool

 

GetPackageNamesWithLiveTransactions

(
    TArray< FName >& OutPackageNames
)

Get the names of of any packages that have live transaction events.

Public function Const

bool

 

GetTransactionActivity

(
    const int64 InActivityId,
    FConcertSyncTransactionActivity& O...
)

Get a transaction activity from this database.

Public function Const

bool

 

GetTransactionActivityForEvent

(
    const int64 InTransactionEventId,
    FConcertSyncTransactionActivity& O...
)

Get a transaction activity for an event in this database.

Public function Const

bool

 

GetTransactionEvent

(
    const int64 InTransactionEventId,
    FConcertSyncTransactionEvent& OutT...,
    const bool InMetaDataOnly
)

Get a transaction event from this database.

Public function Const

bool

 

GetTransactionMaxEventId

(
    int64& OutTransactionEventId
)

Get the maximum ID of the transaction events in this database.

Public function Const

bool

 

IsHeadRevisionPackageEvent

(
    const int64 InPackageEventId,
    bool& OutIsHeadRevision
)

Check whether the given package event ID is currently for the head revision of the package in the event.

Public function Const

bool

 

IsLiveTransactionEvent

(
    const int64 InTransactionEventId,
    bool& OutIsLive
)

Check whether the given transaction event ID is currently for a live transaction event.

Public function Const

bool

 

IsValid()

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

Public function

bool

 

Open

(
    const FString& InSessionPath,
    const ESQLiteDatabaseOpenMode InOpe...
)

Open (or create) a database file.

Public function

bool

 

Open

(
    const FString& InSessionPath
)

Open (or create) a database file.

Public function Const

bool

 

PackageHasLiveTransactions

(
    const FName InPackageName,
    bool& OutHasLiveTransaction
)

Get if a Package has any live transactions

Public function

bool

 

SetConnectionActivity

(
    const FConcertSyncConnectionActivit...
)

Set a connection activity in this database, creating or replacing it.

Public function

bool

 

SetEndpoint

(
    const FGuid& InEndpointId,
    const FConcertSyncEndpointData& In...
)

Set an endpoint in this database, creating or replacing it.

Public function

bool

 

SetLockActivity

(
    const FConcertSyncLockActivity& In...
)

Set a lock activity in this database, creating or replacing it.

Public function

bool

 

SetPackageActivity

(
    const FConcertSyncActivity& InPack...,
    FConcertSyncPackageEventData& InPa...,
    const bool bMetaDataOnly
)

Set a package activity in this database, creating or replacing it.

Public function

bool

 

SetTransactionActivity

(
    const FConcertSyncTransactionActivi...,
    const bool bMetaDataOnly
)

Set a transaction activity in this database, creating or replacing it.

Public function

void

 

UpdateAsynchronousTasks()

Check Asynchronous Tasks Status

Public function

bool

 

UpdatePackageEvent

(
    const int64 InPackageEventId,
    FConcertSyncPackageEventData& Pack...
)

Update the specified package event.

Public function

bool

 

UpdateTransactionEvent

(
    const int64 InTransactionEventId,
    const FConcertSyncTransactionEvent ...
)

Update the specified transaction event.

Operators

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss